panda.lang.mutable.Mutable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of panda-core Show documentation

Panda Core is the core module of Panda Framework, it contains commonly used utility classes similar to apache-commons.

There is a newer version: 1.8.0

package panda.lang.mutable;

/**
 * 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/string. 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.
 * 
 * @param  the mutable type
 */
public interface Mutable {

	/**
	 * Gets the value of this mutable.
	 * 
	 * @return the stored value
	 */
	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);

}