org.apache.commons.lang.mutable

Class MutableObject

java.lang.Object

org.apache.commons.lang.mutable.MutableObject

All Implemented Interfaces:

java.io.Serializable, Mutable

public class MutableObject
extends java.lang.Object
implements Mutable, java.io.Serializable

A mutable Object wrapper.

Since:

2.1

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MutableObject() Constructs a new MutableObject with the default value of null.
MutableObject(java.lang.Object value) Constructs a new MutableObject with the specified value.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Compares this object against the specified object.
java.lang.Object	getValue() Gets the value.
int	hashCode() Returns the value's hash code or 0 if the value is null.
void	setValue(java.lang.Object value) Sets the value.
java.lang.String	toString() Returns the String value of this mutable.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MutableObject

public MutableObject()

Constructs a new MutableObject with the default value of null.

MutableObject

public MutableObject(java.lang.Object value)

Constructs a new MutableObject with the specified value.

Parameters:

value - the initial value to store

Method Detail

getValue

public java.lang.Object getValue()

Gets the value.

Specified by:

getValue in interface Mutable

Returns:

the value, may be null

setValue

public void setValue(java.lang.Object value)

Sets the value.

Specified by:

setValue in interface Mutable

Parameters:

value - the value to set

equals

public boolean equals(java.lang.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 MutableObject object that contains the same Object value as this object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare with, null returns false

Returns:

true if the objects are the same; false otherwise.

hashCode

public int hashCode()

Returns the value's hash code or 0 if the value is null.

Overrides:

hashCode in class java.lang.Object

Returns:

the value's hash code or 0 if the value is null.

toString

public java.lang.String toString()

Returns the String value of this mutable.

Overrides:

toString in class java.lang.Object

Returns:

the mutable value as a string