MutableByte (Core Language Utilities (Version 2.4))

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable, Mutable
```
public class MutableByte
extends java.lang.Number
implements java.lang.Comparable, Mutable
```
A mutable byte wrapper.

Since:

2.1

Version:

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

See Also:
Byte, Serialized Form

Constructor Summary

Constructors
Constructor and Description
`MutableByte()` Constructs a new MutableByte with the default value of zero.
`MutableByte(byte value)` Constructs a new MutableByte with the specified value.
`MutableByte(java.lang.Number value)` Constructs a new MutableByte with the specified value.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(byte operand)` Adds a value.
`void`	`add(java.lang.Number operand)` Adds a value.
`byte`	`byteValue()` Returns the value of this MutableByte as a byte.
`int`	`compareTo(java.lang.Object obj)` 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(java.lang.Object obj)` Compares this object against the specified object.
`float`	`floatValue()` Returns the value of this MutableByte as a float.
`java.lang.Object`	`getValue()` Gets the value as a Byte instance.
`int`	`hashCode()` Returns a suitable hashcode for this mutable.
`void`	`increment()` Increments the value.
`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(java.lang.Object value)` Sets the value from any Number instance.
`void`	`subtract(byte operand)` Subtracts a value.
`void`	`subtract(java.lang.Number operand)` Subtracts a value.
`java.lang.Byte`	`toByte()` Gets this mutable as an instance of Byte.
`java.lang.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(java.lang.Number value)
```
    Constructs a new MutableByte with the specified value.
    
    Parameters:
    value - a value.
    
    Throws:
    
    java.lang.NullPointerException - if the object is null
- Method Detail
  - getValue
```
public java.lang.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(java.lang.Object value)
```
    Sets the value from any Number instance.
    
    Specified by:
    
    setValue in interface Mutable
    
    Parameters:
    value - the value to set
    
    Throws:
    
    java.lang.NullPointerException - if the object is null
    
    java.lang.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 java.lang.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.
    
    Specified by:
    
    intValue in class java.lang.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 java.lang.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 java.lang.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 java.lang.Number
    
    Returns:
    the numeric value represented by this object after conversion to type double.
  - toByte
```
public java.lang.Byte toByte()
```
    Gets this mutable as an instance of Byte.
    
    Returns:
    a Byte instance containing the value from this mutable
  - 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.
    
    Parameters:
    operand - the value to add
    Since:
    
    Commons Lang 2.2
  - add
```
public void add(java.lang.Number operand)
```
    Adds a value.
    
    Parameters:
    operand - the value to add
    
    Throws:
    
    java.lang.NullPointerException - if the object is null
    Since:
    
    Commons Lang 2.2
  - subtract
```
public void subtract(byte operand)
```
    Subtracts a value.
    
    Parameters:
    operand - the value to add
    Since:
    
    Commons Lang 2.2
  - subtract
```
public void subtract(java.lang.Number operand)
```
    Subtracts a value.
    
    Parameters:
    operand - the value to add
    
    Throws:
    
    java.lang.NullPointerException - if the object is null
    Since:
    
    Commons Lang 2.2
  - equals
```
public boolean equals(java.lang.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 java.lang.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 java.lang.Object
    
    Returns:
    a suitable hashcode
  - compareTo
```
public int compareTo(java.lang.Object obj)
```
    Compares this mutable to another in ascending order.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable
    
    Parameters:
    obj - the mutable to compare to
    
    Returns:
    negative if this is less, zero if equal, positive if greater
    
    Throws:
    
    java.lang.ClassCastException - if the argument is not a MutableByte
  - toString
```
public java.lang.String toString()
```
    Returns the String value of this mutable.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    the mutable value as a string

Class MutableByte

Constructor Summary

Method Summary

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Constructor Detail

MutableByte

MutableByte

MutableByte

Method Detail

getValue

setValue

setValue

byteValue

intValue

longValue

floatValue

doubleValue

toByte

increment

decrement

add

add

subtract

subtract

equals

hashCode

compareTo

toString