Interface Mutable

src/main/java/org/apache/commons/lang3/mutable/Mutable.java:36–66

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.

 * @since 2.1
 */
public interface Mutable<T> extends Supplier<T> {

    /**
     * Gets the value of this mutable.
     *
     * @return the stored value.
     * @since 3.18.0
     */
    @Override
    default T get() {
        return getValue();
    }

    /**
     * Gets the value of this mutable.
     *
     * @return the stored value.
     * @deprecated Use {@link #get()}.
     */
    @Deprecated
    T getValue();

    /**
     * Sets the value of this mutable.
     *
     * @param value the value to store.
     * @throws NullPointerException if the object is null and null is invalid.
     * @throws ClassCastException   if the type is invalid.
     */
    void setValue(T value);
}