org.apache.commons.lang.mutable

Class MutableByte

Implemented Interfaces:
Comparable, Mutable

public class MutableByte
extends Number
implements Comparable, Mutable

A mutable byte wrapper.
Version:
$Id: MutableByte.java 161243 2005-04-14 04:30:28Z ggregory $
Since:
2.1
See Also:
Byte

Constructor Summary

MutableByte()
Constructs a new MutableByte with the default value of zero.
MutableByte(Number value)
Constructs a new MutableByte with the specified value.
MutableByte(byte 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(Object value)
Sets the value from any Number instance.
void
setValue(byte value)
Sets the value.
String
toString()
Returns the String value of this mutable.

Constructor Details

MutableByte

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

MutableByte

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

MutableByte

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

Method Details

byteValue

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

compareTo

public int compareTo(Object obj)
Compares this mutable to another in ascending order.
Parameters:
obj - the mutable to compare to
Returns:
negative if this is less, zero if equal, positive if greater

doubleValue

public double doubleValue()
Returns the value of this MutableByte as a double.
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.
Parameters:
obj - the object to compare with.
Returns:
true if the objects are the same; false otherwise.

floatValue

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

getValue

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

hashCode

public int hashCode()
Returns a suitable hashcode for this mutable.
Returns:
a suitable hashcode

intValue

public int intValue()
Returns the value of this MutableByte as a int.
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.
Returns:
the numeric value represented by this object after conversion to type long.

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

setValue

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

toString

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

Copyright © 2001-2005 - Apache Software Foundation