edu.neu.ccs
Class XFloat

java.lang.Object
  extended byedu.neu.ccs.XObject
      extended byedu.neu.ccs.XNumber
          extended byedu.neu.ccs.XFloat
All Implemented Interfaces:
Cloneable, Serializable, Stringable
Direct Known Subclasses:
HexXFloat

public class XFloat
extends XNumber

Object wrapper for the primitive float type that also provides Stringable capabilities. The default value for this class is the float representation of zero.

Since:
1.0
Version:
2.2
See Also:
Serialized Form

Field Summary
private  float value
          The wrapped value of this object.
 
Fields inherited from class edu.neu.ccs.XObject
changeAdapter, VALUE
 
Constructor Summary
XFloat()
          Constructs a wrapper for the default float value.
XFloat(float v)
          Constructs a wrapper for the given float value.
XFloat(String s)
          Constructs a wrapper for the float value whose state information is encapsulated in the given String data.
 
Method Summary
 byte byteValue()
          Returns the value of this number as a byte value.
 double doubleValue()
          Returns the value of this number as a double value.
 boolean equals(Object other)
          Returns true if the wrapped object is equal to the given object, and false if it is not.
 float floatValue()
          Returns the value of this number as a float value.
 void fromStringData(String data)
          Sets the state of this object using information contained in the given String.
 float getValue()
          Returns the value wrapped by this object.
 int hashCode()
          Returns an int hash code appropriate for the wrapped object.
 int intValue()
          Returns the value of this number as a int value.
 long longValue()
          Returns the value of this number as a long value.
static float parseFloat(String s)
          Parses a float value from a String using the current shared parser.
 void setValue(float f)
          Sets the value wrapped by this object to the provided value.
 short shortValue()
          Returns the value of this number as a short value.
static float[] toPrimitiveArray(XFloat[] x)
          Returns an array of primitive float values copied from the given array of XFloat objects.
 String toString()
          Returns a String representation of the wrapped value.
 String toStringData()
          Returns a String encapsulation of this object that contains information needed to set the state of this object at a later time.
static XFloat[] toXArray(float[] a)
          Returns an array of XFloat objects initialized from the given array of float values.
 
Methods inherited from class edu.neu.ccs.XObject
addPropertyChangeListener, addPropertyChangeListener, formatErrorMessage, removePropertyChangeListener, removePropertyChangeListener, toStringArray
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

value

private float value
The wrapped value of this object.

Constructor Detail

XFloat

public XFloat()
Constructs a wrapper for the default float value.

See Also:
XFloat(float), XFloat(String)

XFloat

public XFloat(float v)
Constructs a wrapper for the given float value.

Parameters:
v - the value to be wrapped
See Also:
XFloat(), XFloat(String)

XFloat

public XFloat(String s)
       throws ParseException
Constructs a wrapper for the float value whose state information is encapsulated in the given String data.

Parameters:
s - a String representation of the desired value
Throws:
ParseException - if the data is malformed
See Also:
XFloat(), XFloat(float)
Method Detail

fromStringData

public void fromStringData(String data)
                    throws ParseException
Description copied from interface: Stringable
Sets the state of this object using information contained in the given String.

Specified by:
fromStringData in interface Stringable
Specified by:
fromStringData in class XObject
Throws:
ParseException

toStringData

public String toStringData()
Description copied from interface: Stringable
Returns a String encapsulation of this object that contains information needed to set the state of this object at a later time.

Specified by:
toStringData in interface Stringable
Specified by:
toStringData in class XObject

byteValue

public byte byteValue()
Description copied from class: XNumber
Returns the value of this number as a byte value.

Specified by:
byteValue in class XNumber

shortValue

public short shortValue()
Description copied from class: XNumber
Returns the value of this number as a short value.

Specified by:
shortValue in class XNumber

intValue

public int intValue()
Description copied from class: XNumber
Returns the value of this number as a int value.

Specified by:
intValue in class XNumber

longValue

public long longValue()
Description copied from class: XNumber
Returns the value of this number as a long value.

Specified by:
longValue in class XNumber

floatValue

public float floatValue()
Description copied from class: XNumber
Returns the value of this number as a float value.

Specified by:
floatValue in class XNumber

doubleValue

public double doubleValue()
Description copied from class: XNumber
Returns the value of this number as a double value.

Specified by:
doubleValue in class XNumber

equals

public boolean equals(Object other)
Returns true if the wrapped object is equal to the given object, and false if it is not.

Parameters:
other - the object to be compared with the wrapped object

hashCode

public int hashCode()
Returns an int hash code appropriate for the wrapped object.


toString

public String toString()
Returns a String representation of the wrapped value.


setValue

public void setValue(float f)
Sets the value wrapped by this object to the provided value.

Parameters:
f - the value to be wrapped
See Also:
getValue()

getValue

public float getValue()
Returns the value wrapped by this object.

See Also:
setValue(float)

parseFloat

public static float parseFloat(String s)
                        throws NumberFormatException
Parses a float value from a String using the current shared parser.

Parameters:
s - the String data to parse
Returns:
the extracted float value
Throws:
NumberFormatException - if the data is malformed

toPrimitiveArray

public static float[] toPrimitiveArray(XFloat[] x)
Returns an array of primitive float values copied from the given array of XFloat objects.

Parameters:
x - an array of XFloats
Returns:
the resulting array of float values
See Also:
toXArray(float[])

toXArray

public static XFloat[] toXArray(float[] a)
Returns an array of XFloat objects initialized from the given array of float values.

Parameters:
a - an array of floats
Returns:
the resulting array of XFloat objects
See Also:
toPrimitiveArray(XFloat[])