org.apache.commons.lang.mutable

Class MutableFloat

Implemented Interfaces:
Comparable, Mutable

public class MutableFloat
extends Number
implements Comparable, Mutable

A mutable float wrapper.
Version:
$Id: MutableFloat.java 161243 2005-04-14 04:30:28Z ggregory $
Since:
2.1
See Also:
Float

Constructor Summary

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

Method Summary

int
compareTo(Object obj)
Compares this mutable to another in ascending order.
double
doubleValue()
Returns the value of this MutableFloat as a double.
boolean
equals(Object obj)
Compares this object against some other object.
float
floatValue()
Returns the value of this MutableFloat as a float.
Object
getValue()
Gets the value as a Float instance.
int
hashCode()
Returns a suitable hashcode for this mutable.
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(Object value)
Sets the value from any Number instance.
void
setValue(float value)
Sets the value.
String
toString()
Returns the String value of this mutable.

Constructor Details

MutableFloat

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

MutableFloat

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

MutableFloat

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

Method Details

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

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:

  • 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 be compared
Returns:
true if the objects are the same; false otherwise.

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.
Specified by:
getValue in interface Mutable
Returns:
the value as a Float

hashCode

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

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(Object value)
Sets the value from any Number instance.
Specified by:
setValue in interface Mutable
Parameters:
value - the value to set

setValue

public void setValue(float value)
Sets the value.
Parameters:
value - the value to set

toString

public String toString()
Returns the String value of this mutable.
Returns:
the mutable value as a string

Copyright © 2001-2005 - Apache Software Foundation