Package org.apache.commons.lang3.mutable
Class MutableFloat
java.lang.Object
java.lang.Number
org.apache.commons.lang3.mutable.MutableFloat
- All Implemented Interfaces:
Serializable,Comparable<MutableFloat>,Mutable<Number>
A mutable
float wrapper.
Note that as MutableFloat does not extend Float, it is not treated by String.format as a Float parameter.
- Since:
- 2.1
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new MutableFloat with the default value of zero.MutableFloat(float value) Constructs a new MutableFloat with the specified value.MutableFloat(Number value) Constructs a new MutableFloat with the specified value.MutableFloat(String value) Constructs a new MutableFloat parsing the given string. -
Method Summary
Modifier and TypeMethodDescriptionvoidadd(float operand) Adds a value to the value of this instance.voidAdds a value to the value of this instance.floataddAndGet(float operand) Increments this instance's value byoperand; this method returns the value associated with the instance immediately after the addition operation.floatIncrements this instance's value byoperand; this method returns the value associated with the instance immediately after the addition operation.intcompareTo(MutableFloat other) Compares this mutable to another in ascending order.voidDecrements the value.floatDecrements this instance's value by 1; this method returns the value associated with the instance immediately after the decrement operation.doubleReturns the value of this MutableFloat as a double.booleanCompares this object against some other object.floatReturns the value of this MutableFloat as a float.floatgetAndAdd(float operand) Increments this instance's value byoperand; this method returns the value associated with the instance immediately prior to the addition operation.floatIncrements this instance's value byoperand; this method returns the value associated with the instance immediately prior to the addition operation.floatDecrements this instance's value by 1; this method returns the value associated with the instance immediately prior to the decrement operation.floatIncrements this instance's value by 1; this method returns the value associated with the instance immediately prior to the increment operation.getValue()Gets the value as a Float instance.inthashCode()Returns a suitable hash code for this mutable.voidIncrements the value.floatIncrements this instance's value by 1; this method returns the value associated with the instance immediately after the increment operation.intintValue()Returns the value of this MutableFloat as an int.booleanChecks whether the float value is infinite.booleanisNaN()Checks whether the float value is the special NaN value.longReturns the value of this MutableFloat as a long.voidsetValue(float value) Sets the value.voidSets the value from any Number instance.voidsubtract(float operand) Subtracts a value from the value of this instance.voidSubtracts 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.Methods inherited from class java.lang.Number
byteValue, shortValue
-
Constructor Details
-
MutableFloat
public MutableFloat()Constructs a new MutableFloat with the default value of zero. -
MutableFloat
Constructs a new MutableFloat with the specified value.- Parameters:
value- the initial value to store
-
MutableFloat
Constructs a new MutableFloat with the specified value.- Parameters:
value- the initial value to store, not null- Throws:
NullPointerException- if the object is null
-
MutableFloat
Constructs a new MutableFloat parsing the given string.- Parameters:
value- the string to parse, not null- Throws:
NumberFormatException- if the string cannot be parsed into a float- Since:
- 2.5
-
-
Method Details
-
add
Adds a value to the value of this instance.- Parameters:
operand- the value to add, not null- Since:
- 2.2
-
add
Adds a value to the value of this instance.- Parameters:
operand- the value to add, not null- Throws:
NullPointerException- if the object is null- Since:
- 2.2
-
addAndGet
Increments this instance's value byoperand; 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
-
addAndGet
Increments this instance's value byoperand; 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
- Throws:
NullPointerException- ifoperandis null- Since:
- 3.5
-
compareTo
Compares this mutable to another in ascending order.- Specified by:
compareToin interfaceComparable<MutableFloat>- Parameters:
other- the other mutable to compare to, not null- Returns:
- negative if this is less, zero if equal, positive if greater
-
decrement
Decrements the value.- Since:
- 2.2
-
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
-
doubleValue
Returns the value of this MutableFloat as a double.- Specified by:
doubleValuein classNumber- Returns:
- the numeric value represented by this object after conversion to type double.
-
equals
Compares this object against some other object. The result istrueif and only if the argument is notnulland is aFloatobject that represents afloatthat has the identical bit pattern to the bit pattern of thefloatrepresented by this object. For this purpose, two float values are considered to be the same if and only if the methodFloat.floatToIntBits(float)returns the same int value when applied to each.Note that in most cases, for two instances of class
Float,f1andf2, the value off1.equals(f2)istrueif and only iff1.floatValue() == f2.floatValue()
also has the value
true. However, there are two exceptions:- If
f1andf2both representFloat.NaN, then theequalsmethod returnstrue, even thoughFloat.NaN == Float.NaNhas the valuefalse. - If
f1represents+0.0fwhilef2represents-0.0f, or vice versa, theequaltest has the valuefalse, even though0.0f == -0.0fhas the valuetrue.
- If
-
floatValue
Returns the value of this MutableFloat as a float.- Specified by:
floatValuein classNumber- Returns:
- the numeric value represented by this object after conversion to type float.
-
getAndAdd
Increments this instance's value byoperand; this method returns the value associated with the instance immediately prior to the addition operation. 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
-
getAndAdd
Increments this instance's value byoperand; this method returns the value associated with the instance immediately prior to the addition operation. 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
- Throws:
NullPointerException- ifoperandis null- Since:
- 3.5
-
getAndDecrement
Decrements this instance's value by 1; this method returns the value associated with the instance immediately prior to the decrement operation. This method is not thread safe.- Returns:
- the value associated with the instance before it was decremented
- Since:
- 3.5
-
getAndIncrement
Increments this instance's value by 1; this method returns the value associated with the instance immediately prior to the increment operation. This method is not thread safe.- Returns:
- the value associated with the instance before it was incremented
- Since:
- 3.5
-
getValue
Gets the value as a Float instance. -
hashCode
Returns a suitable hash code for this mutable. -
increment
Increments the value.- Since:
- 2.2
-
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
-
intValue
Returns the value of this MutableFloat as an int. -
isInfinite
Checks whether the float value is infinite.- Returns:
- true if infinite
-
isNaN
Checks whether the float value is the special NaN value.- Returns:
- true if NaN
-
longValue
Returns the value of this MutableFloat as a long. -
setValue
Sets the value.- Parameters:
value- the value to set
-
setValue
Sets the value from any Number instance.- Specified by:
setValuein interfaceMutable<Number>- Parameters:
value- the value to set, not null- Throws:
NullPointerException- if the object is null
-
subtract
Subtracts a value from the value of this instance.- Parameters:
operand- the value to subtract- Since:
- 2.2
-
subtract
Subtracts a value from the value of this instance.- Parameters:
operand- the value to subtract, not null- Throws:
NullPointerException- if the object is null- Since:
- 2.2
-
toFloat
Gets this mutable as an instance of Float.- Returns:
- a Float instance containing the value from this mutable, never null
-
toString
Returns the String value of this mutable.
-