Package org.apache.commons.lang.mutable
Class MutableByte
java.lang.Object
java.lang.Number
org.apache.commons.lang.mutable.MutableByte
- All Implemented Interfaces:
Serializable
,Comparable
,Mutable
A mutable
byte
wrapper.- Since:
- 2.1
- Version:
- $Id: MutableByte.java 905707 2010-02-02 16:59:59Z niallp $
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs 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.MutableByte
(String value) Constructs a new MutableByte parsing the given string. -
Method Summary
Modifier and TypeMethodDescriptionvoid
add
(byte operand) Adds a value to the value of this instance.void
Adds a value to the value of this instance.byte
Returns the value of this MutableByte as a byte.int
Compares this mutable to another in ascending order.void
Decrements the value.double
Returns the value of this MutableByte as a double.boolean
Compares this object to the specified object.float
Returns the value of this MutableByte as a float.getValue()
Gets the value as a Byte instance.int
hashCode()
Returns a suitable hash code for this mutable.void
Increments the value.int
intValue()
Returns the value of this MutableByte as an int.long
Returns the value of this MutableByte as a long.void
setValue
(byte value) Sets the value.void
Sets the value from any Number instance.void
subtract
(byte operand) Subtracts a value from the value of this instance.void
Subtracts a value from the value of this instance.toByte()
Gets this mutable as an instance of Byte.toString()
Returns the String value of this mutable.Methods inherited from class java.lang.Number
shortValue
-
Constructor Details
-
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
- the initial value to store
-
MutableByte
Constructs a new MutableByte with the specified value.- Parameters:
value
- the initial value to store, not null- Throws:
NullPointerException
- if the object is null
-
MutableByte
Constructs a new MutableByte parsing the given string.- Parameters:
value
- the string to parse, not null- Throws:
NumberFormatException
- if the string cannot be parsed into a byte- Since:
- 2.5
-
-
Method Details
-
getValue
Gets the value as a Byte instance. -
setValue
public void setValue(byte value) Sets the value.- Parameters:
value
- the value to set
-
setValue
Sets the value from any Number instance.- Specified by:
setValue
in interfaceMutable
- Parameters:
value
- the value to set, not null- Throws:
NullPointerException
- if the object is nullClassCastException
- if the type is not aNumber
-
increment
public void increment()Increments the value.- Since:
- Commons Lang 2.2
-
decrement
public void decrement()Decrements the value.- Since:
- Commons Lang 2.2
-
add
public void add(byte operand) Adds a value to the value of this instance.- Parameters:
operand
- the value to add, not null- Since:
- Commons Lang 2.2
-
add
Adds a value to the value of this instance.- Parameters:
operand
- the value to add, not null- Throws:
NullPointerException
- if the object is null- Since:
- Commons Lang 2.2
-
subtract
public void subtract(byte operand) Subtracts a value from the value of this instance.- Parameters:
operand
- the value to subtract, not null- Since:
- Commons Lang 2.2
-
subtract
Subtracts a value from the value of this instance.- Parameters:
operand
- the value to subtract, not null- 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. -
intValue
public int intValue()Returns the value of this MutableByte as an int. -
longValue
public long longValue()Returns the value of this MutableByte as a long. -
floatValue
public float floatValue()Returns the value of this MutableByte as a float.- Specified by:
floatValue
in classNumber
- 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.- Specified by:
doubleValue
in classNumber
- Returns:
- the numeric value represented by this object after conversion to type double.
-
toByte
Gets this mutable as an instance of Byte.- Returns:
- a Byte instance containing the value from this mutable
-
equals
Compares this object to the specified object. The result istrue
if and only if the argument is notnull
and is aMutableByte
object that contains the samebyte
value as this object. -
hashCode
public int hashCode()Returns a suitable hash code for this mutable. -
compareTo
Compares this mutable to another in ascending order.- Specified by:
compareTo
in interfaceComparable
- Parameters:
obj
- the other mutable to compare to, not null- Returns:
- negative if this is less, zero if equal, positive if greater
- Throws:
ClassCastException
- if the argument is not a MutableByte
-
toString
Returns the String value of this mutable.
-