kiwi.util
Class IntegerHolder

java.lang.Object
  extended bykiwi.util.HolderObject
      extended bykiwi.util.IntegerHolder
Direct Known Subclasses:
Counter

public class IntegerHolder
extends HolderObject

A mutable holder for an int value.

Author:
Mark Lindner, PING Software Group

Field Summary
protected  int value
          The current value.
 
Fields inherited from class kiwi.util.HolderObject
subtype
 
Constructor Summary
IntegerHolder()
          Construct a new IntegerHolder with an initial value of 0 and default subtype of 0.
IntegerHolder(int value)
          Construct a new IntegerHolder with a specified initial value and default subtype of 0.
IntegerHolder(int value, int subtype)
          Construct a new IntegerHolder with a specified initial value and subtype.
 
Method Summary
 int compareTo(HolderObject other)
          Compare this holder object to another.
 int getValue()
          Get the IntegerHolder's value.
 void setValue(int value)
          Set the IntegerHolder'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 int value
The current value.

Constructor Detail

IntegerHolder

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


IntegerHolder

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

Parameters:
value - The initial value.

IntegerHolder

public IntegerHolder(int value,
                     int subtype)
Construct a new IntegerHolder 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(int value)
Set the IntegerHolder's value.

Parameters:
value - The new value.

getValue

public final int getValue()
Get the IntegerHolder'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."