org.apache.commons.lang.mutable

Class MutableByte

public class MutableByte extends Number implements Comparable, Mutable

A mutable byte wrapper.

Since: 2.1

Version: $Id: MutableByte.java 618693 2008-02-05 16:33:29Z sebb $

See Also: Byte

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
voidadd(byte operand)
Adds a value.
voidadd(Number operand)
Adds a value.
bytebyteValue()
Returns the value of this MutableByte as a byte.
intcompareTo(Object obj)
Compares this mutable to another in ascending order.
voiddecrement()
Decrements the value.
doubledoubleValue()
Returns the value of this MutableByte as a double.
booleanequals(Object obj)
Compares this object against the specified object.
floatfloatValue()
Returns the value of this MutableByte as a float.
ObjectgetValue()
Gets the value as a Byte instance.
inthashCode()
Returns a suitable hashcode for this mutable.
voidincrement()
Increments the value.
intintValue()
Returns the value of this MutableByte as a int.
longlongValue()
Returns the value of this MutableByte as a long.
voidsetValue(byte value)
Sets the value.
voidsetValue(Object value)
Sets the value from any Number instance.
voidsubtract(byte operand)
Subtracts a value.
voidsubtract(Number operand)
Subtracts a value.
BytetoByte()
Gets this mutable as an instance of Byte.
StringtoString()
Returns the String value of this mutable.

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

add

public void add(byte operand)
Adds a value.

Parameters: operand the value to add

Since: Commons Lang 2.2

add

public void add(Number operand)
Adds a value.

Parameters: operand the value to add

Throws: NullPointerException if the object is null

Since: Commons Lang 2.2

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

Throws: ClassCastException if the argument is not a MutableByte

decrement

public void decrement()
Decrements the value.

Since: Commons Lang 2.2

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.

Returns: the value as a Byte

hashCode

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

Returns: a suitable hashcode

increment

public void increment()
Increments the value.

Since: Commons Lang 2.2

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(byte value)
Sets the value.

Parameters: value the value to set

setValue

public void setValue(Object value)
Sets the value from any Number instance.

Parameters: value the value to set

Throws: NullPointerException if the object is null ClassCastException if the type is not a Number

subtract

public void subtract(byte operand)
Subtracts a value.

Parameters: operand the value to add

Since: Commons Lang 2.2

subtract

public void subtract(Number operand)
Subtracts a value.

Parameters: operand the value to add

Throws: NullPointerException if the object is null

Since: Commons Lang 2.2

toByte

public Byte toByte()
Gets this mutable as an instance of Byte.

Returns: a Byte instance containing the value from this mutable

toString

public String toString()
Returns the String value of this mutable.

Returns: the mutable value as a string

Copyright © 2001-2011 - Apache Software Foundation