Top Description Fields Constructors Methods
org.apache.commons.lang3.mutable

public Class MutableByte

extends Number
implements Comparable<MutableByte>, Mutable<Number>
Class Inheritance
All Implemented Interfaces
org.apache.commons.lang3.mutable.Mutable, java.util.function.Supplier, java.lang.Comparable
Imports
java.util.concurrent.atomic.AtomicInteger
A mutable byte wrapper.

This class was created before the introduction of the the java.util.concurrent.atomic package and the AtomicInteger class.

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

Since
2.1
See Also
Byte, AtomicInteger

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides java.lang.Number.serialVersionUID.

Required for serialization support.
private byte
value

The mutable value.

Constructor Summary

AccessConstructor and Description
public
MutableByte()

Constructs a new MutableByte with the default value of zero.

public
MutableByte(final byte
the initial value to store
value)

Constructs a new MutableByte with the specified value.

public
MutableByte(final Number
the initial value to store, not null.
value)

Constructs a new MutableByte with the specified value.

public
MutableByte(final String
the string to parse, not null.
value)

Constructs a new MutableByte parsing the given string.

Method Summary

Modifier and TypeMethod and Description
public void
add(final byte
the value to add, not null.
operand)

Adds a value to the value of this instance.

public void
add(final Number
the value to add, not null.
operand)

Adds a value to the value of this instance.

public byte

Returns:

the value associated with this instance after adding the operand.
addAndGet(final byte
the quantity to add, not null.
operand)

Increments this instance's value by operand; this method returns the value associated with the instance immediately after the addition operation.

public byte

Returns:

the value associated with this instance after adding the operand.
addAndGet(final Number
the quantity to add, not null.
operand)

Increments this instance's value by operand; this method returns the value associated with the instance immediately after the addition operation.

public byte

Returns:

the numeric value represented by this object after conversion to type byte.
byteValue()

Overrides java.lang.Number.byteValue.

Returns the value of this MutableByte as a byte.

public int

Returns:

negative if this is less, zero if equal, positive if greater.
compareTo(final MutableByte
the other mutable to compare to, not null.
other)

Implements java.lang.Comparable.compareTo.

Compares this mutable to another in ascending order.

public void
decrement()

Decrements the value.

public byte

Returns:

the value associated with the instance after it is decremented.
decrementAndGet()

Decrements this instance's value by 1; this method returns the value associated with the instance immediately after the decrement operation.

public double

Returns:

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

Implements abstract java.lang.Number.doubleValue.

Returns the value of this MutableByte as a double.

public boolean

Returns:

true if the objects are the same; false otherwise.
equals(final Object
the object to compare with, null returns false.
obj)

Overrides java.lang.Object.equals.

Compares this object to the specified object.

public float

Returns:

the numeric value represented by this object after conversion to type float.
floatValue()

Implements abstract java.lang.Number.floatValue.

Returns the value of this MutableByte as a float.

public byte

Returns:

the value associated with this instance immediately before the operand was added.
getAndAdd(final byte
the quantity to add, not null.
operand)

Increments this instance's value by operand; this method returns the value associated with the instance immediately prior to the addition operation.

public byte

Returns:

the value associated with this instance immediately before the operand was added.
getAndAdd(final Number
the quantity to add, not null.
operand)

Increments this instance's value by operand; this method returns the value associated with the instance immediately prior to the addition operation.

public byte

Returns:

the value associated with the instance before it was decremented.
getAndDecrement()

Decrements this instance's value by 1; this method returns the value associated with the instance immediately prior to the decrement operation.

public byte

Returns:

the value associated with the instance before it was incremented.
getAndIncrement()

Increments this instance's value by 1; this method returns the value associated with the instance immediately prior to the increment operation.

public Byte

Returns:

the value as a Byte, never null.
getValue()

Implements org.apache.commons.lang3.mutable.Mutable.getValue.

Deprecated Use get().

Gets the value as a Byte instance.

public int

Returns:

a suitable hash code.
hashCode()

Overrides java.lang.Object.hashCode.

Returns a suitable hash code for this mutable.

public void
increment()

Increments the value.

public byte

Returns:

the value associated with the instance after it is incremented.
incrementAndGet()

Increments this instance's value by 1; this method returns the value associated with the instance immediately after the increment operation.

public int

Returns:

the numeric value represented by this object after conversion to type int.
intValue()

Implements abstract java.lang.Number.intValue.

Returns the value of this MutableByte as an int.

public long

Returns:

the numeric value represented by this object after conversion to type long.
longValue()

Implements abstract java.lang.Number.longValue.

Returns the value of this MutableByte as a long.

public void
setValue(final byte
the value to set.
value)

Implements org.apache.commons.lang3.mutable.Mutable.setValue.

Sets the value.

public void
setValue(final Number
the value to set, not null.
value)

Implements org.apache.commons.lang3.mutable.Mutable.setValue.

Sets the value from any Number instance.

public void
subtract(final byte
the value to subtract, not null.
operand)

Subtracts a value from the value of this instance.

public void
subtract(final Number
the value to subtract, not null.
operand)

Subtracts a value from the value of this instance.

public Byte

Returns:

a Byte instance containing the value from this mutable.
toByte()

Gets this mutable as an instance of Byte.

public String

Returns:

the mutable value as a string.
toString()

Overrides java.lang.Object.toString.

Returns the String value of this mutable.

Inherited from java.lang.Number:
shortValue

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.lang.Number.serialVersionUID.

Required for serialization support.

See Also
java.io.Serializable
valueback to summary
private byte value

The mutable value.

Constructor Detail

MutableByteback to summary
public MutableByte()

Constructs a new MutableByte with the default value of zero.

MutableByteback to summary
public MutableByte(final byte value)

Constructs a new MutableByte with the specified value.

Parameters
value:byte

the initial value to store

MutableByteback to summary
public MutableByte(final Number value)

Constructs a new MutableByte with the specified value.

Parameters
value:Number

the initial value to store, not null.

Exceptions
NullPointerException:
if the object is null.
MutableByteback to summary
public MutableByte(final String value)

Constructs a new MutableByte parsing the given string.

Parameters
value:String

the string to parse, not null.

Exceptions
NumberFormatException:
if the string cannot be parsed into a byte, see Byte#parseByte(String).
Since
2.5

Method Detail

addback to summary
public void add(final byte operand)

Adds a value to the value of this instance.

Parameters
operand:byte

the value to add, not null.

Since
2.2
addback to summary
public void add(final Number operand)

Adds a value to the value of this instance.

Parameters
operand:Number

the value to add, not null.

Exceptions
NullPointerException:
if the object is null.
Since
2.2
addAndGetback to summary
public byte addAndGet(final byte operand)

Increments this instance's value by operand; this method returns the value associated with the instance immediately after the addition operation. This method is not thread safe.

Parameters
operand:byte

the quantity to add, not null.

Returns:byte

the value associated with this instance after adding the operand.

Since
3.5
addAndGetback to summary
public byte addAndGet(final Number operand)

Increments this instance's value by operand; this method returns the value associated with the instance immediately after the addition operation. This method is not thread safe.

Parameters
operand:Number

the quantity to add, not null.

Returns:byte

the value associated with this instance after adding the operand.

Exceptions
NullPointerException:
if operand is null.
Since
3.5
byteValueback to summary
public byte byteValue()

Overrides java.lang.Number.byteValue.

Returns the value of this MutableByte as a byte.

Returns:byte

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

Annotations
@Override
compareToback to summary
public int compareTo(final MutableByte other)

Implements java.lang.Comparable.compareTo.

Compares this mutable to another in ascending order.

Parameters
other:MutableByte

the other mutable to compare to, not null.

Returns:int

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

Annotations
@Override
decrementback to summary
public void decrement()

Decrements the value.

Since
2.2
decrementAndGetback to summary
public byte decrementAndGet()

Decrements this instance's value by 1; this method returns the value associated with the instance immediately after the decrement operation. This method is not thread safe.

Returns:byte

the value associated with the instance after it is decremented.

Since
3.5
doubleValueback to summary
public double doubleValue()

Implements abstract java.lang.Number.doubleValue.

Returns the value of this MutableByte as a double.

Returns:double

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

Annotations
@Override
equalsback to summary
public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

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.

Parameters
obj:Object

the object to compare with, null returns false.

Returns:boolean

true if the objects are the same; false otherwise.

Annotations
@Override
floatValueback to summary
public float floatValue()

Implements abstract java.lang.Number.floatValue.

Returns the value of this MutableByte as a float.

Returns:float

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

Annotations
@Override
getAndAddback to summary
public byte getAndAdd(final byte operand)

Increments this instance's value by operand; this method returns the value associated with the instance immediately prior to the addition operation. This method is not thread safe.

Parameters
operand:byte

the quantity to add, not null.

Returns:byte

the value associated with this instance immediately before the operand was added.

Since
3.5
getAndAddback to summary
public byte getAndAdd(final Number operand)

Increments this instance's value by operand; this method returns the value associated with the instance immediately prior to the addition operation. This method is not thread safe.

Parameters
operand:Number

the quantity to add, not null.

Returns:byte

the value associated with this instance immediately before the operand was added.

Exceptions
NullPointerException:
if operand is null.
Since
3.5
getAndDecrementback to summary
public byte getAndDecrement()

Decrements this instance's value by 1; this method returns the value associated with the instance immediately prior to the decrement operation. This method is not thread safe.

Returns:byte

the value associated with the instance before it was decremented.

Since
3.5
getAndIncrementback to summary
public byte getAndIncrement()

Increments this instance's value by 1; this method returns the value associated with the instance immediately prior to the increment operation. This method is not thread safe.

Returns:byte

the value associated with the instance before it was incremented.

Since
3.5
getValueback to summary
public Byte getValue()

Implements org.apache.commons.lang3.mutable.Mutable.getValue.

Deprecated

Use get().

Gets the value as a Byte instance.

Returns:Byte

the value as a Byte, never null.

Annotations
@Deprecated
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Returns a suitable hash code for this mutable.

Returns:int

a suitable hash code.

Annotations
@Override
incrementback to summary
public void increment()

Increments the value.

Since
2.2
incrementAndGetback to summary
public byte incrementAndGet()

Increments this instance's value by 1; this method returns the value associated with the instance immediately after the increment operation. This method is not thread safe.

Returns:byte

the value associated with the instance after it is incremented.

Since
3.5
intValueback to summary
public int intValue()

Implements abstract java.lang.Number.intValue.

Returns the value of this MutableByte as an int.

Returns:int

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

Annotations
@Override
longValueback to summary
public long longValue()

Implements abstract java.lang.Number.longValue.

Returns the value of this MutableByte as a long.

Returns:long

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

Annotations
@Override
setValueback to summary
public void setValue(final byte value)

Implements org.apache.commons.lang3.mutable.Mutable.setValue.

Sets the value.

Parameters
value:byte

the value to set.

setValueback to summary
public void setValue(final Number value)

Implements org.apache.commons.lang3.mutable.Mutable.setValue.

Sets the value from any Number instance.

Parameters
value:Number

the value to set, not null.

Annotations
@Override
Exceptions
NullPointerException:
if the object is null.
subtractback to summary
public void subtract(final byte operand)

Subtracts a value from the value of this instance.

Parameters
operand:byte

the value to subtract, not null.

Since
2.2
subtractback to summary
public void subtract(final Number operand)

Subtracts a value from the value of this instance.

Parameters
operand:Number

the value to subtract, not null.

Exceptions
NullPointerException:
if the object is null.
Since
2.2
toByteback to summary
public Byte toByte()

Gets this mutable as an instance of Byte.

Returns:Byte

a Byte instance containing the value from this mutable.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Returns the String value of this mutable.

Returns:String

the mutable value as a string.

Annotations
@Override