Mutable

public abstract interface org.apache.commons.lang3.mutable.Mutable<T> extends Supplier<T>

Provides mutable access to a value.

Mutable is used as a generic interface to the implementations in this package.

A typical use case would be to enable a primitive or string to be passed to a method and allow that method to effectively change the value of the primitive/object. Another use case is to store a frequently changing primitive in a collection (for example a total in a map) without needing to create new Integer/Long wrapper objects.

Parameters:

<T> – The type to wrap.

Since:

2.1

Methods

get()	Gets the value of this mutable.
getValue()	Deprecated. Gets the value of this mutable.
setValue(Object)	Sets the value of this mutable.

@Override public default T get()

Gets the value of this mutable.

Returns:

The stored value.

Since:

3.18.0

@Deprecated public abstract T getValue()

Deprecated: Use #get().

Gets the value of this mutable.

Returns:

The stored value.

public abstract void setValue(T value)

Sets the value of this mutable.

Parameters:

value – The value to store.

Throws:

• java.lang.NullPointerException – Thrown if the object is null and null is invalid.

• java.lang.ClassCastException – Thrown if the type is invalid.