Class MutableShort
java.lang.Object
java.lang.Number
edu.internet2.middleware.grouperClientExt.org.apache.commons.lang3.mutable.MutableShort
- All Implemented Interfaces:
Mutable<Number>
,Serializable
,Comparable<MutableShort>
A mutable
short
wrapper.
Note that as MutableShort does not extend Short, it is not treated by String.format as a Short parameter.
- Since:
- 2.1
- See Also:
-
Constructor Summary
ConstructorDescriptionConstructs a new MutableShort with the default value of zero.MutableShort
(short value) Constructs a new MutableShort with the specified value.MutableShort
(Number value) Constructs a new MutableShort with the specified value.MutableShort
(String value) Constructs a new MutableShort parsing the given string. -
Method Summary
Modifier and TypeMethodDescriptionvoid
add
(short operand) Adds a value to the value of this instance.void
Adds a value to the value of this instance.short
addAndGet
(short operand) Increments this instance's value byoperand
; this method returns the value associated with the instance immediately after the addition operation.short
Increments this instance's value byoperand
; this method returns the value associated with the instance immediately after the addition operation.int
compareTo
(MutableShort other) Compares this mutable to another in ascending order.void
Decrements the value.short
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 MutableShort as a double.boolean
Compares this object to the specified object.float
Returns the value of this MutableShort as a float.short
getAndAdd
(short operand) Increments this instance's value byoperand
; this method returns the value associated with the instance immediately prior to the addition operation.short
Increments this instance's value byoperand
; this method returns the value associated with the instance immediately prior to the addition operation.short
Decrements this instance's value by 1; this method returns the value associated with the instance immediately prior to the decrement operation.short
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 Short instance.int
hashCode()
Returns a suitable hash code for this mutable.void
Increments the value.short
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 MutableShort as an int.long
Returns the value of this MutableShort as a long.void
setValue
(short value) Sets the value.void
Sets the value from any Number instance.short
Returns the value of this MutableShort as a short.void
subtract
(short operand) Subtracts a value from the value of this instance.void
Subtracts a value from the value of this instance.toShort()
Gets this mutable as an instance of Short.toString()
Returns the String value of this mutable.
-
Constructor Details
-
MutableShort
public MutableShort()Constructs a new MutableShort with the default value of zero. -
MutableShort
public MutableShort(short value) Constructs a new MutableShort with the specified value.- Parameters:
value
- the initial value to store
-
MutableShort
Constructs a new MutableShort with the specified value.- Parameters:
value
- the initial value to store, not null- Throws:
NullPointerException
- if the object is null
-
MutableShort
Constructs a new MutableShort parsing the given string.- Parameters:
value
- the string to parse, not null- Throws:
NumberFormatException
- if the string cannot be parsed into a short- Since:
- 2.5
-
-
Method Details
-
getValue
Gets the value as a Short instance. -
setValue
public void setValue(short 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 short 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 short 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 short 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 short 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(short 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(short 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 short addAndGet(short 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 short getAndAdd(short 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
-
shortValue
public short shortValue()Returns the value of this MutableShort as a short.- Overrides:
shortValue
in classNumber
- Returns:
- the numeric value represented by this object after conversion to type short.
-
intValue
public int intValue()Returns the value of this MutableShort as an int. -
longValue
public long longValue()Returns the value of this MutableShort as a long. -
floatValue
public float floatValue()Returns the value of this MutableShort 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 MutableShort as a double.- Specified by:
doubleValue
in classNumber
- Returns:
- the numeric value represented by this object after conversion to type double.
-
toShort
Gets this mutable as an instance of Short.- Returns:
- a Short instance containing the value from this mutable, never null
-
equals
Compares this object to the specified object. The result istrue
if and only if the argument is notnull
and is aMutableShort
object that contains the sameshort
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<MutableShort>
- 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.
-