org.apache.commons.lang3.mutable
Class MutableByte

java.lang.Object
  java.lang.Number
      org.apache.commons.lang3.mutable.MutableByte

All Implemented Interfaces:

Serializable, Comparable<MutableByte>, Mutable<Number>

public class MutableByte
extends Number
implements Comparable<MutableByte>, Mutable<Number>

A mutable byte wrapper.

Note that as MutableByte does not extend Byte, it is not treated by String.format as a Byte parameter.

Since:

2.1

Version:

$Id: MutableByte.java 1160571 2011-08-23 07:36:08Z bayard $

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.

MutableByte(String value)
Constructs a new MutableByte parsing the given string.

Method Summary

void	add(byte operand) Adds a value to the value of this instance.
void	add(Number operand) Adds a value to the value of this instance.
byte	byteValue() Returns the value of this MutableByte as a byte.
int	compareTo(MutableByte other) Compares this mutable to another in ascending order.
void	decrement() Decrements the value.
double	doubleValue() Returns the value of this MutableByte as a double.
boolean	equals(Object obj) Compares this object to the specified object.
float	floatValue() Returns the value of this MutableByte as a float.
Byte	getValue() Gets the value as a Byte instance.
int	hashCode() Returns a suitable hash code for this mutable.
void	increment() Increments the value.
int	intValue() Returns the value of this MutableByte as an int.
long	longValue() Returns the value of this MutableByte as a long.
void	setValue(byte value) Sets the value.
void	setValue(Number value) Sets the value from any Number instance.
void	subtract(byte operand) Subtracts a value from the value of this instance.
void	subtract(Number operand) Subtracts a value from the value of this instance.
Byte	toByte() Gets this mutable as an instance of Byte.
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 - the initial value to store

MutableByte

public MutableByte(Number value)

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

public MutableByte(String value)
            throws NumberFormatException

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 Detail

getValue

public Byte getValue()

Gets the value as a Byte instance.

Specified by:

getValue in interface Mutable<Number>

Returns:

the value as a Byte, never null

setValue

public void setValue(byte value)

Sets the value.

Parameters:

value - the value to set

setValue

public void setValue(Number value)

Sets the value from any Number instance.

Specified by:

setValue in interface Mutable<Number>

Parameters:

value - the value to set, not null

Throws:

NullPointerException - if the object is null

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

public void add(Number operand)

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

public void subtract(Number operand)

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.

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 an int.

Specified by:

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.

Specified by:

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.

Specified by:

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.

Specified by:

doubleValue in class Number

Returns:

the numeric value represented by this object after conversion to type double.

toByte

public Byte toByte()

Gets this mutable as an instance of Byte.

Returns:

a Byte instance containing the value from this mutable

equals

public boolean equals(Object obj)

Compares this object to 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, null returns false

Returns:

true if the objects are the same; false otherwise.

hashCode

public int hashCode()

Returns a suitable hash code for this mutable.

Overrides:

hashCode in class Object

Returns:

a suitable hash code

compareTo

public int compareTo(MutableByte other)

Compares this mutable to another in ascending order.

Specified by:

compareTo in interface Comparable<MutableByte>

Parameters:

other - the other mutable to compare to, not null

Returns:

negative if this is less, zero if equal, positive if greater

toString

public String toString()

Returns the String value of this mutable.

Overrides:

toString in class Object

Returns:

the mutable value as a string