kiwi.util
Class BooleanHolder

java.lang.Object
  extended bykiwi.util.HolderObject
      extended bykiwi.util.BooleanHolder

public class BooleanHolder
extends HolderObject

A mutable holder for a boolean value.

Author:
Mark Lindner, PING Software Group

Field Summary
protected  boolean value
          The current value.
 
Fields inherited from class kiwi.util.HolderObject
subtype
 
Constructor Summary
BooleanHolder()
          Construct a new BooleanHolder with an initial value of false and default subtype of 0.
BooleanHolder(boolean value)
          Construct a new BooleanHolder with a specified initial value and default subtype of 0.
BooleanHolder(boolean value, int subtype)
          Construct a new BooleanHolder with a specified initial value and subtype.
 
Method Summary
 int compareTo(HolderObject other)
          Compare this holder object to another.
 boolean getValue()
          Get the BooleanHolder's value.
 void setValue(boolean value)
          Set the BooleanHolder's value.
 java.lang.String toString()
          Get a string representation for this object.
 
Methods inherited from class kiwi.util.HolderObject
getSubtype, setSubtype
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

value

protected boolean value
The current value.

Constructor Detail

BooleanHolder

public BooleanHolder()
Construct a new BooleanHolder with an initial value of false and default subtype of 0.


BooleanHolder

public BooleanHolder(boolean value)
Construct a new BooleanHolder with a specified initial value and default subtype of 0.

Parameters:
value - The initial value.

BooleanHolder

public BooleanHolder(boolean value,
                     int subtype)
Construct a new BooleanHolder with a specified initial value and subtype.

Parameters:
value - The initial value.
subtype - The subtype for this value.
Method Detail

setValue

public final void setValue(boolean value)
Set the BooleanHolder's value.

Parameters:
value - The new value.

getValue

public final boolean getValue()
Get the BooleanHolder's value.

Returns:
The current value.

toString

public java.lang.String toString()
Get a string representation for this object.


compareTo

public int compareTo(HolderObject other)
Compare this holder object to another.

Specified by:
compareTo in class HolderObject
Parameters:
other - The HolderObject to compare against.
Returns:
-1 if this object is "less than" the other object; 1 if this object is "greater than" the other object, and 0 if the objects are "equal."