org.apache.commons.lang.mutable

Class MutableBoolean

public class MutableBoolean extends Object implements Mutable, Serializable, Comparable

A mutable boolean wrapper.

Since: 2.2

Version: $Id: MutableBoolean.java 491052 2006-12-29 17:16:37Z scolebourne $

Author: Apache Software Foundation

See Also: Boolean

Constructor Summary
MutableBoolean()
Constructs a new MutableBoolean with the default value of false.
MutableBoolean(boolean value)
Constructs a new MutableBoolean with the specified value.
MutableBoolean(Boolean value)
Constructs a new MutableBoolean with the specified value.
Method Summary
booleanbooleanValue()
Returns the value of this MutableBoolean as a boolean.
intcompareTo(Object obj)
Compares this mutable to another in ascending order.
booleanequals(Object obj)
Compares this object to the specified object.
ObjectgetValue()
Gets the value as a Boolean instance.
inthashCode()
Returns a suitable hashcode for this mutable.
voidsetValue(boolean value)
Sets the value.
voidsetValue(Object value)
Sets the value from any Boolean instance.
StringtoString()
Returns the String value of this mutable.

Constructor Detail

MutableBoolean

public MutableBoolean()
Constructs a new MutableBoolean with the default value of false.

MutableBoolean

public MutableBoolean(boolean value)
Constructs a new MutableBoolean with the specified value.

Parameters: value a value.

MutableBoolean

public MutableBoolean(Boolean value)
Constructs a new MutableBoolean with the specified value.

Parameters: value a value.

Throws: NullPointerException if the object is null

Method Detail

booleanValue

public boolean booleanValue()
Returns the value of this MutableBoolean as a boolean.

Returns: the boolean value represented by this object.

compareTo

public int compareTo(Object obj)
Compares this mutable to another in ascending order.

Parameters: obj the mutable to compare to

Returns: zero if this object represents the same boolean value as the argument; a positive value if this object represents true and the argument represents false; and a negative value if this object represents false and the argument represents true

Throws: ClassCastException if the argument is not a MutableInt

equals

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 an MutableBoolean object that contains the same boolean value as this object.

Parameters: obj the object to compare with.

Returns: true if the objects are the same; false otherwise.

getValue

public Object getValue()
Gets the value as a Boolean instance.

Returns: the value as a Boolean

hashCode

public int hashCode()
Returns a suitable hashcode for this mutable.

Returns: the integer 1231 if this object represents true; returns the integer 1237 if this object represents false.

setValue

public void setValue(boolean value)
Sets the value.

Parameters: value the value to set

setValue

public void setValue(Object value)
Sets the value from any Boolean instance.

Parameters: value the value to set

Throws: NullPointerException if the object is null ClassCastException if the type is not a Boolean

toString

public String toString()
Returns the String value of this mutable.

Returns: the mutable value as a string

Copyright © 2001-2010 - Apache Software Foundation