org.apache.commons.lang.mutable

Class MutableDouble

public class MutableDouble extends Number implements Comparable, Mutable

A mutable double wrapper.

Since: 2.1

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

See Also: Double

Constructor Summary
MutableDouble()
Constructs a new MutableDouble with the default value of zero.
MutableDouble(double value)
Constructs a new MutableDouble with the specified value.
MutableDouble(Number value)
Constructs a new MutableDouble with the specified value.
Method Summary
voidadd(double 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 MutableDouble as a double.
booleanequals(Object obj)
Compares this object against the specified object.
floatfloatValue()
Returns the value of this MutableDouble as a float.
ObjectgetValue()
Gets the value as a Double instance.
inthashCode()
Returns a suitable hashcode for this mutable.
voidincrement()
Increments the value.
intintValue()
Returns the value of this MutableDouble as a int.
booleanisInfinite()
Checks whether the double value is infinite.
booleanisNaN()
Checks whether the double value is the special NaN value.
longlongValue()
Returns the value of this MutableDouble as a long.
voidsetValue(double value)
Sets the value.
voidsetValue(Object value)
Sets the value from any Number instance.
voidsubtract(double operand)
Subtracts a value.
voidsubtract(Number operand)
Subtracts a value.
DoubletoDouble()
Gets this mutable as an instance of Double.
StringtoString()
Returns the String value of this mutable.

Constructor Detail

MutableDouble

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

MutableDouble

public MutableDouble(double value)
Constructs a new MutableDouble with the specified value.

Parameters: value a value.

MutableDouble

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

Parameters: value a value.

Throws: NullPointerException if the object is null

Method Detail

add

public void add(double 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

Throws: ClassCastException if the argument is not a MutableDouble

decrement

public void decrement()
Decrements the value.

Since: Commons Lang 2.2

doubleValue

public double doubleValue()
Returns the value of this MutableDouble 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 the specified object. The result is true if and only if the argument is not null and is a Double object that represents a double that has the identical bit pattern to the bit pattern of the double represented by this object. For this purpose, two double values are considered to be the same if and only if the method Double#doubleToLongBits(double)returns the same long value when applied to each.

Note that in most cases, for two instances of class Double,d1 and d2, the value of d1.equals(d2) is true if and only if

   d1.doubleValue() == d2.doubleValue()
 

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

Parameters: obj the object to compare with.

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

floatValue

public float floatValue()
Returns the value of this MutableDouble 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 Double instance.

Returns: the value as a Double

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 MutableDouble as a int.

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

isInfinite

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

Returns: true if infinite

isNaN

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

Returns: true if NaN

longValue

public long longValue()
Returns the value of this MutableDouble as a long.

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

setValue

public void setValue(double 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(double 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

toDouble

public Double toDouble()
Gets this mutable as an instance of Double.

Returns: a Double 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