MutableFloat

public class org.apache.commons.lang3.mutable.MutableFloat extends Number implements Comparable<MutableFloat>, Mutable<Number>

A mutable float wrapper.

This class was created before the introduction of the java.util.concurrent.atomic package and the DoubleAccumulator class.

Note that as MutableFloat does not extend Float, it is not treated by String.format as a Float parameter.

See also:

• Float

• DoubleAccumulator

• DoubleAdder

Since:

2.1

Constructors

MutableFloat()	Constructs a new MutableFloat with the default value of zero.
MutableFloat(float)	Constructs a new MutableFloat with the specified value.
MutableFloat(Number)	Constructs a new MutableFloat with the specified value.
MutableFloat(String)	Constructs a new MutableFloat parsing the given string.

public MutableFloat()

Constructs a new MutableFloat with the default value of zero.

public MutableFloat(float value)

Constructs a new MutableFloat with the specified value.

Parameters:

value – The initial value to store.

public MutableFloat(Number value)

Constructs a new MutableFloat with the specified value.

Parameters:

value – The initial value to store, not null.

Throws:

java.lang.NullPointerException – Thrown if the object is null.

public MutableFloat(String value)

Constructs a new MutableFloat parsing the given string.

Parameters:

value – The string to parse, not null.

Throws:

java.lang.NumberFormatException – Thrown if the string cannot be parsed into a float, see Float#parseFloat(String).

Since:

2.5

Methods

add(float)	Adds a value to the value of this instance.
add(Number)	Adds a value to the value of this instance.
addAndGet(float)	Increments this instance’s value by operand; this method returns the value associated with the instance immediately after the addition operation.
addAndGet(Number)	Increments this instance’s value by operand; this method returns the value associated with the instance immediately after the addition operation.
compareTo(MutableFloat)	Compares this mutable to another in ascending order.
decrement()	Decrements the value.
decrementAndGet()	Decrements this instance’s value by 1; this method returns the value associated with the instance immediately after the decrement operation.
doubleValue()	Returns the value of this MutableFloat as a double.
equals(Object)	Compares this object against some other object.
floatValue()	Returns the value of this MutableFloat as a float.
getAndAdd(float)	Gets this instance’s current value, then adds operand.
getAndAdd(Number)	Gets this instance’s current value, then adds operand.
getAndDecrement()	Gets this instance’s current value, then decrements it by 1.
getAndIncrement()	Gets this instance’s current value, then increments it by 1.
getValue()	Deprecated. Gets the value as a Float instance.
hashCode()	Returns a suitable hash code for this mutable.
increment()	Increments the value.
incrementAndGet()	Increments this instance’s value by 1; this method returns the value associated with the instance immediately after the increment operation.
intValue()	Returns the value of this MutableFloat as an int.
isInfinite()	Tests whether the float value is infinite.
isNaN()	Tests whether the float value is the special NaN value.
longValue()	Returns the value of this MutableFloat as a long.
setValue(float)	Sets the value.
setValue(Number)	Sets the value from any Number instance.
subtract(float)	Subtracts a value from the value of this instance.
subtract(Number)	Subtracts a value from the value of this instance.
toFloat()	Gets this mutable as an instance of Float.
toString()	Returns the String value of this mutable.

public void add(float operand)

Adds a value to the value of this instance.

Parameters:

operand – The value to add, not null.

Since:

2.2

public void add(Number operand)

Adds a value to the value of this instance.

Parameters:

operand – The value to add, not null.

Throws:

java.lang.NullPointerException – Thrown if the object is null.

Since:

2.2

public float addAndGet(float operand)

Increments this instance’s value by operand; this method returns the value associated with the instance immediately after the addition operation. This method is not thread safe.

Parameters:

operand – The quantity to add, not null.

Returns:

The value associated with this instance after adding the operand.

Since:

3.5

public float addAndGet(Number operand)

Increments this instance’s value by operand; this method returns the value associated with the instance immediately after the addition operation. This method is not thread safe.

Parameters:

operand – The quantity to add, not null.

Throws:

java.lang.NullPointerException – Thrown if operand is null.

Returns:

The value associated with this instance after adding the operand.

Since:

3.5

@Override public int compareTo(MutableFloat other)

Compares this mutable to another in ascending order.

Parameters:

other – The other mutable to compare to, not null.

Returns:

negative if this is less, zero if equal, positive if greater.

public void decrement()

Decrements the value.

Since:

2.2

public float decrementAndGet()

Decrements this instance’s value by 1; this method returns the value associated with the instance immediately after the decrement operation. This method is not thread safe.

Returns:

The value associated with the instance after it is decremented.

Since:

3.5

@Override public double doubleValue()

Returns the value of this MutableFloat as a double.

Returns:

The numeric value represented by this object after conversion to type double.

@Override public boolean equals(Object obj)

Compares this object against some other object. The result is true if and only if the argument is not null and is a Float object that represents a float that has the identical bit pattern to the bit pattern of the float represented by this object. For this purpose, two float values are considered to be the same if and only if the method Float#floatToIntBits(float)returns the same int value when applied to each.

Note that in most cases, for two instances of class Float,f1 and f2, the value of f1.equals(f2) is true if and only if:

f1.floatValue() == f2.floatValue()

also has the value true. However, there are two exceptions:

• If f1 and f2 both represent Float.NaN, then the equals method returns true, even though Float.NaN == Float.NaN has the value false.

• If f1 represents +0.0f while f2 represents -0.0f, or vice versa, the equal test has the value false, even though 0.0f == -0.0f has the value true.

This definition allows hashtables to operate properly.

Parameters:

obj – The object to compare with, null returns false.

Returns:

true if the objects are the same; false otherwise.

See also:

Float#floatToIntBits(float)

@Override public float floatValue()

Returns the value of this MutableFloat as a float.

Returns:

The numeric value represented by this object after conversion to type float.

public float getAndAdd(float operand)

Gets this instance’s current value, then adds operand. This method is not thread-safe.

Parameters:

operand – The quantity to add, not null.

Returns:

The value associated with this instance immediately before the operand was added.

Since:

3.5

public float getAndAdd(Number operand)

Gets this instance’s current value, then adds operand. This method is not thread-safe.

Parameters:

operand – The quantity to add, not null.

Throws:

java.lang.NullPointerException – Thrown if operand is null.

Returns:

The value associated with this instance immediately before the operand was added.

Since:

3.5

public float getAndDecrement()

Gets this instance’s current value, then decrements it by 1. This method is not thread-safe.

Returns:

The value associated with the instance before it was decremented.

Since:

3.5

public float getAndIncrement()

Gets this instance’s current value, then increments it by 1. This method is not thread-safe.

Returns:

The value associated with the instance before it was incremented.

Since:

3.5

@Deprecated @Override public Float getValue()

Deprecated: Use #get().

Gets the value as a Float instance.

Returns:

The value as a Float, never null.

@Override public int hashCode()

Returns a suitable hash code for this mutable.

Returns:

A suitable hash code.

public void increment()

Increments the value.

Since:

2.2

public float incrementAndGet()

Increments this instance’s value by 1; this method returns the value associated with the instance immediately after the increment operation. This method is not thread safe.

Returns:

The value associated with the instance after it is incremented.

Since:

3.5

@Override public int intValue()

Returns the value of this MutableFloat as an int.

Returns:

The numeric value represented by this object after conversion to type int.

public boolean isInfinite()

Tests whether the float value is infinite.

Returns:

true if infinite

public boolean isNaN()

Tests whether the float value is the special NaN value.

Returns:

true if NaN.

@Override public long longValue()

Returns the value of this MutableFloat as a long.

Returns:

The numeric value represented by this object after conversion to type long.

public void setValue(float value)

Sets the value.

Parameters:

value – The value to set.

@Override public void setValue(Number value)

Sets the value from any Number instance.

Parameters:

value – The value to set, not null.

Throws:

java.lang.NullPointerException – Thrown if the object is null.

public void subtract(float operand)

Subtracts a value from the value of this instance.

Parameters:

operand – The value to subtract.

Since:

2.2

public void subtract(Number operand)

Subtracts a value from the value of this instance.

Parameters:

operand – The value to subtract, not null.

Throws:

java.lang.NullPointerException – Thrown if the object is null.

Since:

2.2

public Float toFloat()

Gets this mutable as an instance of Float.

Returns:

A Float instance containing the value from this mutable, never null.

@Override public String toString()

Returns the String value of this mutable.

Returns:

The mutable value as a string.