org.apache.commons.lang.mutable

Class MutableFloat

public class MutableFloat extends Number implements Comparable, Mutable

A mutable float wrapper.

Since: 2.1

Version: $Id: MutableFloat.java 618693 2008-02-05 16:33:29Z sebb $

See Also: Float

Constructor Summary
MutableFloat()
Constructs 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.
Method Summary
voidadd(float operand)
Adds a value.
voidadd(Number operand)
Adds a value.
intcompareTo(Object obj)
Compares this mutable to another in ascending order.
voiddecrement()
Decrements the value.
doubledoubleValue()
Returns the value of this MutableFloat as a double.
booleanequals(Object obj)
Compares this object against some other object.
floatfloatValue()
Returns the value of this MutableFloat as a float.
ObjectgetValue()
Gets the value as a Float instance.
inthashCode()
Returns a suitable hashcode for this mutable.
voidincrement()
Increments the value.
intintValue()
Returns the value of this MutableFloat as a int.
booleanisInfinite()
Checks whether the float value is infinite.
booleanisNaN()
Checks whether the float value is the special NaN value.
longlongValue()
Returns the value of this MutableFloat as a long.
voidsetValue(float value)
Sets the value.
voidsetValue(Object value)
Sets the value from any Number instance.
voidsubtract(float operand)
Subtracts a value.
voidsubtract(Number operand)
Subtracts a value.
FloattoFloat()
Gets this mutable as an instance of Float.
StringtoString()
Returns the String value of this mutable.

Constructor Detail

MutableFloat

public MutableFloat()
Constructs a new MutableFloat with the default value of zero.

MutableFloat

public MutableFloat(float value)
Constructs a new MutableFloat with the specified value.

Parameters: value a value.

MutableFloat

public MutableFloat(Number value)
Constructs a new MutableFloat with the specified value.

Parameters: value a value.

Throws: NullPointerException if the object is null

Method Detail

add

public void add(float operand)
Adds a value.

Parameters: operand the value to add

Since: Commons Lang 2.2

add

public void add(Number operand)
Adds a value.

Parameters: operand the value to add

Throws: NullPointerException if the object is null

Since: Commons Lang 2.2

compareTo

public int compareTo(Object obj)
Compares this mutable to another in ascending order.

Parameters: obj the mutable to compare to

Returns: negative if this is less, zero if equal, positive if greater

decrement

public void decrement()
Decrements the value.

Since: Commons Lang 2.2

doubleValue

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.

equals

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:

This definition allows hashtables to operate properly.

Parameters: obj the object to be compared

Returns: true if the objects are the same; false otherwise.

See Also: java.lang.Float#floatToIntBits(float)

floatValue

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.

getValue

public Object getValue()
Gets the value as a Float instance.

Returns: the value as a Float

hashCode

public int hashCode()
Returns a suitable hashcode for this mutable.

Returns: a suitable hashcode

increment

public void increment()
Increments the value.

Since: Commons Lang 2.2

intValue

public int intValue()
Returns the value of this MutableFloat as a int.

Returns: the numeric value represented by this object after conversion to type int.

isInfinite

public boolean isInfinite()
Checks whether the float value is infinite.

Returns: true if infinite

isNaN

public boolean isNaN()
Checks whether the float value is the special NaN value.

Returns: true if NaN

longValue

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.

setValue

public void setValue(float value)
Sets the value.

Parameters: value the value to set

setValue

public void setValue(Object value)
Sets the value from any Number instance.

Parameters: value the value to set

Throws: NullPointerException if the object is null ClassCastException if the type is not a Number

subtract

public void subtract(float operand)
Subtracts a value.

Parameters: operand the value to add

Since: Commons Lang 2.2

subtract

public void subtract(Number operand)
Subtracts a value.

Parameters: operand the value to add

Throws: NullPointerException if the object is null

Since: Commons Lang 2.2

toFloat

public Float toFloat()
Gets this mutable as an instance of Float.

Returns: a Float instance containing the value from this mutable

toString

public String toString()
Returns the String value of this mutable.

Returns: the mutable value as a string

Copyright © 2001-2010 - Apache Software Foundation