kiwi.util
Class FloatHolder
java.lang.Object
|
+--kiwi.util.HolderObject
|
+--kiwi.util.FloatHolder
- public class FloatHolder
- extends HolderObject
A mutable holder for a float
value.
- Author:
- Mark Lindner, PING Software Group
Field Summary |
protected float |
value
The current value. |
Constructor Summary |
FloatHolder()
Construct a new FloatHolder with an initial value of 0.0f
and default subtype of 0. |
FloatHolder(float value)
Construct a new FloatHolder with a specified initial
value and default subtype of 0. |
FloatHolder(float value,
int subtype)
Construct a new FloatHolder with a specified initial
value and subtype. |
Method Summary |
int |
compareTo(HolderObject other)
Compare this holder object to another. |
float |
getValue()
Get the FloatHolder 's value. |
void |
setValue(float value)
Set the FloatHolder 's value. |
java.lang.String |
toString()
Get a string representation for this object. |
Methods inherited from class java.lang.Object |
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait |
value
protected float value
- The current value.
FloatHolder
public FloatHolder()
- Construct a new
FloatHolder
with an initial value of 0.0f
and default subtype of 0.
FloatHolder
public FloatHolder(float value)
- Construct a new
FloatHolder
with a specified initial
value and default subtype of 0.
- Parameters:
value
- The initial value.
FloatHolder
public FloatHolder(float value,
int subtype)
- Construct a new
FloatHolder
with a specified initial
value and subtype.
- Parameters:
value
- The initial value.subtype
- The subtype for this value.
setValue
public final void setValue(float value)
- Set the
FloatHolder
's value.
- Parameters:
value
- The new value.
getValue
public final float getValue()
- Get the
FloatHolder
's value.
- Returns:
- The current value.
toString
public java.lang.String toString()
- Get a string representation for this object.
- Overrides:
toString
in class java.lang.Object
compareTo
public int compareTo(HolderObject other)
- Compare this holder object to another.
- Overrides:
compareTo
in class HolderObject
- Following copied from class:
kiwi.util.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."