Copy as Markdown

On this page

MutableDouble

public class org.apache.commons.lang3.mutable.MutableDouble extends Number implements Comparable<MutableDouble>, Mutable<Number>

A mutable double wrapper.

This class was created before the introduction of the java.util.concurrent.atomic package and the DoubleAccumulator class.

Note that as MutableDouble does not extend Double, it is not treated by String.format as a Double parameter.

See also:

• Double

• DoubleAccumulator

• DoubleAdder

Since:

2.1

Constructors

MutableDouble()	Constructs a new MutableDouble with the default value of zero.
MutableDouble(double)	Constructs a new MutableDouble with the specified value.
MutableDouble(Number)	Constructs a new MutableDouble with the specified value.
MutableDouble(String)	Constructs a new MutableDouble parsing the given string.

public MutableDouble()

Constructs a new MutableDouble with the default value of zero.

public MutableDouble(double value)

Constructs a new MutableDouble with the specified value.

Parameters:

value – The initial value to store.

public MutableDouble(Number value)

Constructs a new MutableDouble with the specified value.

Parameters:

value – The initial value to store, not null.

Throws:

java.lang.NullPointerException – Thrown if the object is null.

public MutableDouble(String value)

Constructs a new MutableDouble parsing the given string.

Parameters:

value – The string to parse, not null.

Throws:

java.lang.NumberFormatException – Thrown if the string cannot be parsed into a double, see Double#parseDouble(String).

Since:

2.5

Methods

add(double)	Adds a value to the value of this instance.
add(Number)	Adds a value to the value of this instance.
addAndGet(double)	Increments this instance’s value by operand; this method returns the value associated with the instance immediately after the addition operation.
addAndGet(Number)	Increments this instance’s value by operand; this method returns the value associated with the instance immediately after the addition operation.
compareTo(MutableDouble)	Compares this mutable to another in ascending order.
decrement()	Decrements the value.
decrementAndGet()	Decrements this instance’s value by 1; this method returns the value associated with the instance immediately after the decrement operation.
doubleValue()	Returns the value of this MutableDouble as a double.
equals(Object)	Compares this object against the specified object.
floatValue()	Returns the value of this MutableDouble as a float.
getAndAdd(double)	Gets this instance’s current value, then adds operand.
getAndAdd(Number)	Gets this instance’s current value, then adds operand.
getAndDecrement()	Gets this instance’s current value, then decrements it by 1.
getAndIncrement()	Gets this instance’s current value, then increments it by 1.
getValue()	Deprecated. Gets the value as a Double instance.
hashCode()	Returns a suitable hash code for this mutable.
increment()	Increments the value.
incrementAndGet()	Increments this instance’s value by 1; this method returns the value associated with the instance immediately after the increment operation.
intValue()	Returns the value of this MutableDouble as an int.
isInfinite()	Tests whether the double value is infinite.
isNaN()	Tests whether the double value is the special NaN value.
longValue()	Returns the value of this MutableDouble as a long.
setValue(double)	Sets the value.
setValue(Number)	Sets the value from any Number instance.
subtract(double)	Subtracts a value from the value of this instance.
subtract(Number)	Subtracts a value from the value of this instance.
toDouble()	Gets this mutable as an instance of Double.
toString()	Returns the String value of this mutable.

public void add(double operand)

Adds a value to the value of this instance.

Parameters:

operand – The value to add.

Since:

2.2

public void add(Number operand)

Adds a value to the value of this instance.

Parameters:

operand – The value to add, not null.

Throws:

java.lang.NullPointerException – Thrown if the object is null.

Since:

2.2

public double addAndGet(double operand)

Increments this instance’s value by operand; 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

public double addAndGet(Number operand)

Increments this instance’s value by operand; 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.

Throws:

java.lang.NullPointerException – Thrown if operand is null.

Returns:

The value associated with this instance after adding the operand.

Since:

3.5

@Override public int compareTo(MutableDouble other)

Compares this mutable to another in ascending order.

Parameters:

other – The other mutable to compare to, not null.

Returns:

negative if this is less, zero if equal, positive if greater.

public void decrement()

Decrements the value.

Since:

2.2

public double 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

@Override 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.

@Override 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:

• If d1 and d2 both represent Double.NaN, then the equals method returns true, even though Double.NaN == Double.NaN has the value false.

• If d1 represents +0.0 while d2 represents -0.0, or vice versa, the equal test has the value false, even though +0.0 == -0.0 has the value true. This allows hashtables to operate properly.

Parameters:

obj – The object to compare with, null returns false.

Returns:

true if the objects are the same; false otherwise.

@Override 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.

public double getAndAdd(double operand)

Gets this instance’s current value, then adds operand. 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

public double getAndAdd(Number operand)

Gets this instance’s current value, then adds operand. This method is not thread-safe.

Parameters:

operand – The quantity to add, not null.

Throws:

java.lang.NullPointerException – Thrown if operand is null.

Returns:

The value associated with this instance immediately before the operand was added.

Since:

3.5

public double getAndDecrement()

Gets this instance’s current value, then decrements it by 1. This method is not thread-safe.

Returns:

The value associated with the instance before it was decremented.

Since:

3.5

public double getAndIncrement()

Gets this instance’s current value, then increments it by 1. This method is not thread-safe.

Returns:

The value associated with the instance before it was incremented.

Since:

3.5

@Deprecated @Override public Double getValue()

Deprecated: Use #get().

Gets the value as a Double instance.

Returns:

The value as a Double, never null.

@Override public int hashCode()

Returns a suitable hash code for this mutable.

Returns:

A suitable hash code.

public void increment()

Increments the value.

Since:

2.2

public double 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

@Override public int intValue()

Returns the value of this MutableDouble as an int.

Returns:

The numeric value represented by this object after conversion to type int.

public boolean isInfinite()

Tests whether the double value is infinite.

Returns:

true if infinite.

public boolean isNaN()

Tests whether the double value is the special NaN value.

Returns:

true if NaN.

@Override 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.

public void setValue(double value)

Sets the value.

Parameters:

value – The value to set.

@Override public void setValue(Number value)

Sets the value from any Number instance.

Parameters:

value – The value to set, not null.

Throws:

java.lang.NullPointerException – Thrown if the object is null.

public void subtract(double operand)

Subtracts a value from the value of this instance.

Parameters:

operand – The value to subtract, not null.

Since:

2.2

public void subtract(Number operand)

Subtracts a value from the value of this instance.

Parameters:

operand – The value to subtract, not null.

Throws:

java.lang.NullPointerException – Thrown if the object is null.

Since:

2.2

public Double toDouble()

Gets this mutable as an instance of Double.

Returns:

A Double instance containing the value from this mutable, never null.

@Override public String toString()

Returns the String value of this mutable.

Returns:

The mutable value as a string.