Class MutableByte
java.lang.Object
java.lang.Number
edu.internet2.middleware.grouperClientExt.org.apache.commons.lang3.mutable.MutableByte
- All Implemented Interfaces:
Mutable<Number>
,Serializable
,Comparable<MutableByte>
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
- See Also:
-
Constructor Summary
ConstructorDescriptionConstructs 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 TypeMethodDescriptionvoid
add
(byte operand) Adds a value to the value of this instance.void
Adds a value to the value of this instance.byte
addAndGet
(byte operand) Increments this instance's value byoperand
; this method returns the value associated with the instance immediately after the addition operation.byte
Increments this instance's value byoperand
; this method returns the value associated with the instance immediately after the addition operation.byte
Returns the value of this MutableByte as a byte.int
compareTo
(MutableByte other) Compares this mutable to another in ascending order.void
Decrements the value.byte
Decrements this instance's value by 1; this method returns the value associated with the instance immediately after the decrement operation.double
Returns the value of this MutableByte as a double.boolean
Compares this object to the specified object.float
Returns the value of this MutableByte as a float.byte
getAndAdd
(byte operand) Increments this instance's value byoperand
; this method returns the value associated with the instance immediately prior to the addition operation.byte
Increments this instance's value byoperand
; this method returns the value associated with the instance immediately prior to the addition operation.byte
Decrements this instance's value by 1; this method returns the value associated with the instance immediately prior to the decrement operation.byte
Increments this instance's value by 1; this method returns the value associated with the instance immediately prior to the increment operation.getValue()
Gets the value as a Byte instance.int
hashCode()
Returns a suitable hash code for this mutable.void
Increments the value.byte
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
Returns the value of this MutableByte as a long.void
setValue
(byte value) Sets the value.void
Sets the value from any Number instance.void
subtract
(byte operand) Subtracts a value from the value of this instance.void
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.Methods inherited from class java.lang.Number
shortValue
-
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
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
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 Details
-
getValue
Gets the value as a Byte instance. -
setValue
public void setValue(byte value) Sets the value.- Parameters:
value
- the value to set
-
setValue
Sets the value from any Number instance.- Specified by:
setValue
in interfaceMutable<Number>
- Parameters:
value
- the value to set, not null- Throws:
NullPointerException
- if the object is null
-
increment
public void increment()Increments the value.- Since:
- 2.2
-
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
-
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
-
decrement
public void decrement()Decrements the value.- Since:
- 2.2
-
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
-
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
-
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
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
-
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
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
-
addAndGet
public byte addAndGet(byte operand) Increments this instance's value byoperand
; 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
Increments this instance's value byoperand
; 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
- ifoperand
is null- Since:
- 3.5
-
getAndAdd
public byte getAndAdd(byte operand) Increments this instance's value byoperand
; 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
Increments this instance's value byoperand
; 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
- ifoperand
is null- Since:
- 3.5
-
byteValue
public byte byteValue()Returns the value of this MutableByte as a byte. -
intValue
public int intValue()Returns the value of this MutableByte as an int. -
longValue
public long longValue()Returns the value of this MutableByte as a long. -
floatValue
public float floatValue()Returns the value of this MutableByte as a float.- Specified by:
floatValue
in classNumber
- 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 classNumber
- Returns:
- the numeric value represented by this object after conversion to type double.
-
toByte
Gets this mutable as an instance of Byte.- Returns:
- a Byte instance containing the value from this mutable
-
equals
Compares this object to the specified object. The result istrue
if and only if the argument is notnull
and is aMutableByte
object that contains the samebyte
value as this object. -
hashCode
public int hashCode()Returns a suitable hash code for this mutable. -
compareTo
Compares this mutable to another in ascending order.- Specified by:
compareTo
in interfaceComparable<MutableByte>
- Parameters:
other
- the other mutable to compare to, not null- Returns:
- negative if this is less, zero if equal, positive if greater
-
toString
Returns the String value of this mutable.
-