org.apache.commons.lang.mutable
Class MutableFloat

java.lang.Object
  extended byjava.lang.Number
      extended byorg.apache.commons.lang.mutable.MutableFloat
All Implemented Interfaces:
java.lang.Comparable, Mutable, java.io.Serializable

public class MutableFloat
extends java.lang.Number
implements java.lang.Comparable, Mutable

A mutable float wrapper.

Since:
2.1
Version:
$Id: MutableFloat.java 618693 2008-02-05 16:33:29Z sebb $
See Also:
Float, Serialized Form

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(java.lang.Number value)
          Constructs a new MutableFloat with the specified value.
 
Method Summary
 void add(float operand)
          Adds a value.
 void add(java.lang.Number operand)
          Adds a value.
 int compareTo(java.lang.Object obj)
          Compares this mutable to another in ascending order.
 void decrement()
          Decrements the value.
 double doubleValue()
          Returns the value of this MutableFloat as a double.
 boolean equals(java.lang.Object obj)
          Compares this object against some other object.
 float floatValue()
          Returns the value of this MutableFloat as a float.
 java.lang.Object getValue()
          Gets the value as a Float instance.
 int hashCode()
          Returns a suitable hashcode for this mutable.
 void increment()
          Increments the value.
 int intValue()
          Returns the value of this MutableFloat as a int.
 boolean isInfinite()
          Checks whether the float value is infinite.
 boolean isNaN()
          Checks whether the float value is the special NaN value.
 long longValue()
          Returns the value of this MutableFloat as a long.
 void setValue(float value)
          Sets the value.
 void setValue(java.lang.Object value)
          Sets the value from any Number instance.
 void subtract(float operand)
          Subtracts a value.
 void subtract(java.lang.Number operand)
          Subtracts a value.
 java.lang.Float toFloat()
          Gets this mutable as an instance of Float.
 java.lang.String toString()
          Returns the String value of this mutable.
 
Methods inherited from class java.lang.Number
byteValue, shortValue
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

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(java.lang.Number value)
Constructs a new MutableFloat with the specified value.

Parameters:
value - a value.
Throws:
java.lang.NullPointerException - if the object is null
Method Detail

getValue

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

Specified by:
getValue in interface Mutable
Returns:
the value as a Float

setValue

public void setValue(float value)
Sets the value.

Parameters:
value - the value to set

setValue

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

Specified by:
setValue in interface Mutable
Parameters:
value - the value to set
Throws:
java.lang.NullPointerException - if the object is null
java.lang.ClassCastException - if the type is not a Number

increment

public void increment()
Increments the value.

Since:
Commons Lang 2.2

decrement

public void decrement()
Decrements the value.

Since:
Commons Lang 2.2

add

public void add(float operand)
Adds a value.

Parameters:
operand - the value to add
Since:
Commons Lang 2.2

add

public void add(java.lang.Number operand)
Adds a value.

Parameters:
operand - the value to add
Throws:
java.lang.NullPointerException - if the object is null
Since:
Commons Lang 2.2

subtract

public void subtract(float operand)
Subtracts a value.

Parameters:
operand - the value to add
Since:
Commons Lang 2.2

subtract

public void subtract(java.lang.Number operand)
Subtracts a value.

Parameters:
operand - the value to add
Throws:
java.lang.NullPointerException - if the object is null
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.

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.

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.

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.

isNaN

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

Returns:
true if NaN

isInfinite

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

Returns:
true if infinite

toFloat

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

Returns:
a Float instance containing the value from this mutable

equals

public boolean equals(java.lang.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:
Float.floatToIntBits(float)

hashCode

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

Returns:
a suitable hashcode

compareTo

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

Specified by:
compareTo in interface java.lang.Comparable
Parameters:
obj - the mutable to compare to
Returns:
negative if this is less, zero if equal, positive if greater

toString

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

Returns:
the mutable value as a string


Copyright 2001-2008 The Apache Software Foundation. All Rights Reserved.