MutableLong

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

A mutable long wrapper.

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

Note that as MutableLong does not extend Long, it is not treated by String#format(String, Object...) as a Long parameter.

See also:

• Long

• AtomicLong

Since:

2.1

Constructors

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

public MutableLong()

Constructs a new MutableLong with the default value of zero.

public MutableLong(Number value)

Constructs a new MutableLong with the specified value.

Parameters:

value – The initial value to store, not null.

Throws:

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

public MutableLong(String value)

Constructs a new MutableLong 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 long, see Long#parseLong(String).

Since:

2.5

public MutableLong(long value)

Constructs a new MutableLong with the specified value.

Parameters:

value – The initial value to store.

Methods

add(Number)	Adds a value to the value of this instance.
add(long)	Adds a value to the value of this instance.
addAndGet(Number)	Increments this instance’s value by operand; this method returns the value associated with the instance immediately after the addition operation.
addAndGet(long)	Increments this instance’s value by operand; this method returns the value associated with the instance immediately after the addition operation.
compareTo(MutableLong)	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 MutableLong as a double.
equals(Object)	Compares this object to the specified object.
floatValue()	Returns the value of this MutableLong as a float.
getAndAdd(Number)	Gets this instance’s current value, then adds operand.
getAndAdd(long)	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 Long 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 MutableLong as an int.
longValue()	Returns the value of this MutableLong as a long.
setValue(Number)	Sets the value from any Number instance.
setValue(long)	Sets the value.
subtract(Number)	Subtracts a value from the value of this instance.
subtract(long)	Subtracts a value from the value of this instance.
toLong()	Gets this mutable as an instance of Long.
toString()	Returns the String value of this mutable.

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 void add(long operand)

Adds a value to the value of this instance.

Parameters:

operand – The value to add, not null.

Since:

2.2

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

public long addAndGet(long 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

@Override public int compareTo(MutableLong 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 long 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 MutableLong 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 to the specified object. The result is true if and only if the argument is not null and is a MutableLong object that contains the same long value as this object.

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 MutableLong as a float.

Returns:

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

public long 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 long getAndAdd(long 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 long 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 long 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 Long getValue()

Deprecated: Use #get().

Gets the value as a Long instance.

Returns:

The value as a Long, 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 long 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 MutableLong as an int.

Returns:

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

@Override public long longValue()

Returns the value of this MutableLong as a long.

Returns:

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

@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 setValue(long value)

Sets the value.

Parameters:

value – The value to set.

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 void subtract(long operand)

Subtracts a value from the value of this instance.

Parameters:

operand – The value to subtract, not null.

Since:

2.2

public Long toLong()

Gets this mutable as an instance of Long.

Returns:

A Long 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.