Package 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>, Supplier<Number>, Mutable<Number>
public class MutableByte extends Number implements Comparable<MutableByte>, Mutable<Number>
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:

  • Constructor Summary

    Constructors
    Constructor
    Description
    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

    Modifier and Type
    Method
    Description
    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
    addAndGet(byte operand)
    Increments this instance's value by operand; this method returns the value associated with the instance immediately after the addition operation.
    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.
    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.
    byte
    decrementAndGet()
    Decrements this instance's value by 1; this method returns the value associated with the instance immediately after the decrement operation.
    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
    getAndAdd(byte operand)
    Increments this instance's value by operand; this method returns the value associated with the instance immediately prior to the addition operation.
    byte
    getAndAdd(Number operand)
    Increments this instance's value by operand; this method returns the value associated with the instance immediately prior to the addition operation.
    byte
    getAndDecrement()
    Decrements this instance's value by 1; this method returns the value associated with the instance immediately prior to the decrement operation.
    byte
    getAndIncrement()
    Increments this instance's value by 1; this method returns the value associated with the instance immediately prior to the increment operation.
    Byte
    getValue()
    Deprecated.
    Use Mutable.get().
    int
    hashCode()
    Returns a suitable hash code for this mutable.
    void
    increment()
    Increments the value.
    byte
    incrementAndGet()
    Increments this instance's value by 1; this method returns the value associated with the instance immediately after the increment operation.
    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

    Methods inherited from interface org.apache.commons.lang3.mutable.Mutable

    get

  • 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

      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)
      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, see Byte.parseByte(String).
      Since:
      2.5

  • Method Details

    • add

      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

    • 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:
      2.2

    • addAndGet

      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

    • addAndGet

      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.
      Returns:
      the value associated with this instance after adding the operand.
      Throws:
      NullPointerException - if operand is null.
      Since:
      3.5

    • 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.

    • 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.

    • decrement

      public void decrement()
      Decrements the value.
      Since:
      2.2

    • decrementAndGet

      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

    • 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.

    • 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.

    • 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.

    • getAndAdd

      public byte getAndAdd(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 - the quantity to add, not null.
      Returns:
      the value associated with this instance immediately before the operand was added.
      Since:
      3.5

    • getAndAdd

      public byte getAndAdd(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 - the quantity to add, not null.
      Returns:
      the value associated with this instance immediately before the operand was added.
      Throws:
      NullPointerException - if operand is null.
      Since:
      3.5

    • getAndDecrement

      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:
      the value associated with the instance before it was decremented.
      Since:
      3.5

    • getAndIncrement

      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:
      the value associated with the instance before it was incremented.
      Since:
      3.5

    • getValue

      @Deprecated public Byte getValue()
      Deprecated.
      Use Mutable.get().
      Gets the value as a Byte instance.
      Specified by:
      getValue in interface Mutable<Number>
      Returns:
      the value as a Byte, never null.

    • hashCode

      public int hashCode()
      Returns a suitable hash code for this mutable.
      Overrides:
      hashCode in class Object
      Returns:
      a suitable hash code.

    • increment

      public void increment()
      Increments the value.
      Since:
      2.2

    • incrementAndGet

      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

    • 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.

    • 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.

    • subtract

      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

    • 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:
      2.2

    • toByte

      public Byte toByte()
      Gets this mutable as an instance of Byte.
      Returns:
      a Byte instance containing the value from this mutable.

    • toString

      public String toString()
      Returns the String value of this mutable.
      Overrides:
      toString in class Object
      Returns:
      the mutable value as a string.