kiwi.util
Class StringHolder

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

public class StringHolder
extends HolderObject

A mutable holder for a String value.

Author:
Mark Lindner, PING Software Group

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

Constructor Detail

StringHolder

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


StringHolder

public StringHolder(java.lang.String value)
Construct a new StringHolder with a specified initial value and default subtype of 0.

Parameters:
value - The initial value.

StringHolder

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

Parameters:
value - The new value.

getValue

public final java.lang.String getValue()
Get the StringHolder'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."