org.apache.commons.lang.mutable
Class MutableByte

java.lang.Object
  |
  +--java.lang.Number
        |
        +--org.apache.commons.lang.mutable.MutableByte

public class MutableByte
extends Number
implements Comparable, Mutable

A mutable byte wrapper.

Since:
2.1
Version:
$Id: MutableByte.java 161243 2005-04-14 04:30:28Z ggregory $
See Also:
Byte, Serialized Form

Constructor Summary
MutableByte()
          Constructs a new MutableByte with the default value of zero.
MutableByte(byte value)
          Constructs a new MutableByte with the specified value.
MutableByte(Number value)
          Constructs a new MutableByte with the specified value.
 
Method Summary
 byte byteValue()
          Returns the value of this MutableByte as a byte.
 int compareTo(Object obj)
          Compares this mutable to another in ascending order.
 double doubleValue()
          Returns the value of this MutableByte as a double.
 boolean equals(Object obj)
          Compares this object against the specified object.
 float floatValue()
          Returns the value of this MutableByte as a float.
 Object getValue()
          Gets the value as a Byte instance.
 int hashCode()
          Returns a suitable hashcode for this mutable.
 int intValue()
          Returns the value of this MutableByte as a int.
 long longValue()
          Returns the value of this MutableByte as a long.
 void setValue(byte value)
          Sets the value.
 void setValue(Object value)
          Sets the value from any Number instance.
 String toString()
          Returns the String value of this mutable.
 
Methods inherited from class java.lang.Number
shortValue
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MutableByte

public MutableByte()
Constructs a new MutableByte with the default value of zero.

MutableByte

public MutableByte(byte value)
Constructs a new MutableByte with the specified value.
Parameters:
value - a value.

MutableByte

public MutableByte(Number value)
Constructs a new MutableByte with the specified value.
Parameters:
value - a value.
Throws:
NullPointerException - if the object is null
Method Detail

getValue

public Object getValue()
Gets the value as a Byte instance.
Specified by:
getValue in interface Mutable
Returns:
the value as a Byte

setValue

public void setValue(byte value)
Sets the value.
Parameters:
value - the value to set

setValue

public void setValue(Object value)
Sets the value from any Number instance.
Specified by:
setValue in interface Mutable
Parameters:
value - the value to set
Throws:
NullPointerException - if the object is null
ClassCastException - if the type is not a Number

byteValue

public byte byteValue()
Returns the value of this MutableByte as a byte.
Overrides:
byteValue in class Number
Returns:
the numeric value represented by this object after conversion to type byte.

intValue

public int intValue()
Returns the value of this MutableByte as a int.
Overrides:
intValue in class Number
Returns:
the numeric value represented by this object after conversion to type int.

longValue

public long longValue()
Returns the value of this MutableByte as a long.
Overrides:
longValue in class Number
Returns:
the numeric value represented by this object after conversion to type long.

floatValue

public float floatValue()
Returns the value of this MutableByte as a float.
Overrides:
floatValue in class Number
Returns:
the numeric value represented by this object after conversion to type float.

doubleValue

public double doubleValue()
Returns the value of this MutableByte as a double.
Overrides:
doubleValue in class Number
Returns:
the numeric value represented by this object after conversion to type double.

equals

public boolean equals(Object obj)
Compares this object against the specified object. The result is true if and only if the argument is not null and is a MutableByte object that contains the same byte value as this object.
Overrides:
equals in class Object
Parameters:
obj - the object to compare with.
Returns:
true if the objects are the same; false otherwise.

hashCode

public int hashCode()
Returns a suitable hashcode for this mutable.
Overrides:
hashCode in class Object
Returns:
a suitable hashcode

compareTo

public int compareTo(Object obj)
Compares this mutable to another in ascending order.
Specified by:
compareTo in interface Comparable
Parameters:
obj - the mutable to compare to
Returns:
negative if this is less, zero if equal, positive if greater
Throws:
ClassCastException - if the argument is not a MutableByte

toString

public String toString()
Returns the String value of this mutable.
Overrides:
toString in class Object
Returns:
the mutable value as a string


Copyright © 2001-2005 - Apache Software Foundation