MutableByte

public class org.apache.commons.lang3.mutable.MutableByte extends Number implements Comparable<MutableByte>, Mutable<Number>

A mutable byte wrapper.

This class was created before the introduction of 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.

See also:

• Byte

• AtomicInteger

Since:

2.1

Constructors

MutableByte()	Constructs a new MutableByte with the default value of zero.
MutableByte(byte)	Constructs a new MutableByte with the specified value.
MutableByte(Number)	Constructs a new MutableByte with the specified value.
MutableByte(String)	Constructs a new MutableByte parsing the given string.

public MutableByte()

Constructs a new MutableByte with the default value of zero.

public MutableByte(byte value)

Constructs a new MutableByte with the specified value.

Parameters:

value – The initial value to store

public MutableByte(Number value)

Constructs a new MutableByte with the specified value.

Parameters:

value – The initial value to store, not null.

Throws:

java.lang.NullPointerException – Thrown if the object is null.

public MutableByte(String value)

Constructs a new MutableByte parsing the given string.

Parameters:

value – The string to parse, not null.

Throws:

java.lang.NumberFormatException – Thrown if the string cannot be parsed into a byte, see Byte#parseByte(String).

Since:

2.5

Methods

add(byte)	Adds a value to the value of this instance.
add(Number)	Adds a value to the value of this instance.
addAndGet(byte)	Increments this instance’s value by operand; this method returns the value associated with the instance immediately after the addition operation.
addAndGet(Number)	Increments this instance’s value by operand; this method returns the value associated with the instance immediately after the addition operation.
byteValue()	Returns the value of this MutableByte as a byte.
compareTo(MutableByte)	Compares this mutable to another in ascending order.
decrement()	Decrements the value.
decrementAndGet()	Decrements this instance’s value by 1; this method returns the value associated with the instance immediately after the decrement operation.
doubleValue()	Returns the value of this MutableByte as a double.
equals(Object)	Compares this object to the specified object.
floatValue()	Returns the value of this MutableByte as a float.
getAndAdd(byte)	Gets this instance’s current value, then adds operand.
getAndAdd(Number)	Gets this instance’s current value, then adds operand.
getAndDecrement()	Gets this instance’s current value, then decrements it by 1.
getAndIncrement()	Gets this instance’s current value, then increments it by 1.
getValue()	Deprecated. Gets the value as a Byte instance.
hashCode()	Returns a suitable hash code for this mutable.
increment()	Increments the value.
incrementAndGet()	Increments this instance’s value by 1; this method returns the value associated with the instance immediately after the increment operation.
intValue()	Returns the value of this MutableByte as an int.
longValue()	Returns the value of this MutableByte as a long.
setValue(byte)	Sets the value.
setValue(Number)	Sets the value from any Number instance.
subtract(byte)	Subtracts a value from the value of this instance.
subtract(Number)	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.

public void add(byte operand)

Adds a value to the value of this instance.

Parameters:

operand – The value to add, not null.

Since:

2.2

public void add(Number operand)

Adds a value to the value of this instance.

Parameters:

operand – The value to add, not null.

Throws:

java.lang.NullPointerException – Thrown if the object is null.

Since:

2.2

public byte addAndGet(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 – The quantity to add, not null.

Returns:

The value associated with this instance after adding the operand.

Since:

3.5

public byte addAndGet(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 – The quantity to add, not null.

Throws:

java.lang.NullPointerException – Thrown if operand is null.

Returns:

The value associated with this instance after adding the operand.

Since:

3.5

@Override 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.

@Override public int compareTo(MutableByte other)

Compares this mutable to another in ascending order.

Parameters:

other – The other mutable to compare to, not null.

Returns:

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

public void decrement()

Decrements the value.

Since:

2.2

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:

The value associated with the instance after it is decremented.

Since:

3.5

@Override 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.

@Override 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.

Parameters:

obj – The object to compare with, null returns false.

Returns:

true if the objects are the same; false otherwise.

@Override 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.

public byte getAndAdd(byte operand)

Gets this instance’s current value, then adds operand. This method is not thread-safe.

Parameters:

operand – The quantity to add, not null.

Returns:

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

Since:

3.5

public byte getAndAdd(Number operand)

Gets this instance’s current value, then adds operand. This method is not thread-safe.

Parameters:

operand – The quantity to add, not null.

Throws:

java.lang.NullPointerException – Thrown if operand is null.

Returns:

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

Since:

3.5

public byte getAndDecrement()

Gets this instance’s current value, then decrements it by 1. This method is not thread-safe.

Returns:

The value associated with the instance before it was decremented.

Since:

3.5

public byte getAndIncrement()

Gets this instance’s current value, then increments it by 1. This method is not thread-safe.

Returns:

The value associated with the instance before it was incremented.

Since:

3.5

@Deprecated @Override public Byte getValue()

Deprecated: Use #get().

Gets the value as a Byte instance.

Returns:

The value as a Byte, never null.

@Override public int hashCode()

Returns a suitable hash code for this mutable.

Returns:

A suitable hash code.

public void increment()

Increments the value.

Since:

2.2

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:

The value associated with the instance after it is incremented.

Since:

3.5

@Override public int intValue()

Returns the value of this MutableByte as an int.

Returns:

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

@Override 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.

public void setValue(byte value)

Sets the value.

Parameters:

value – The value to set.

@Override public void setValue(Number value)

Sets the value from any Number instance.

Parameters:

value – The value to set, not null.

Throws:

java.lang.NullPointerException – Thrown if the object is null.

public void subtract(byte operand)

Subtracts a value from the value of this instance.

Parameters:

operand – The value to subtract, not null.

Since:

2.2

public void subtract(Number operand)

Subtracts a value from the value of this instance.

Parameters:

operand – The value to subtract, not null.

Throws:

java.lang.NullPointerException – Thrown if the object is null.

Since:

2.2

public Byte toByte()

Gets this mutable as an instance of Byte.

Returns:

A Byte instance containing the value from this mutable.

@Override public String toString()

Returns the String value of this mutable.

Returns:

The mutable value as a string.