Apache Commons Lang 3.20.0 · org.apache.commons.lang3.mutable.MutableShort

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides java.lang.Number.serialVersionUID. Required for serialization support.
private short	value The mutable value.

Access	Constructor and Description
public	MutableShort() Constructs a new MutableShort with the default value of zero.
public	MutableShort(final Number the initial value to store, not null. value) Constructs a new MutableShort with the specified value.
public	MutableShort(final short the initial value to store. value) Constructs a new MutableShort with the specified value.
public	MutableShort(final String the string to parse, not null. value) Constructs a new MutableShort parsing the given string.

Method Summary

Modifier and Type	Method and Description
public void	add(final Number the value to add, not null. operand) Adds a value to the value of this instance.
public void	add(final short the value to add, not null. operand) Adds a value to the value of this instance.
public short	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 short	Returns: the value associated with this instance after adding the operand. addAndGet(final short 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 int	Returns: negative if this is less, zero if equal, positive if greater. compareTo(final MutableShort 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 short	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 MutableShort 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 MutableShort as a float.
public short	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 short	Returns: the value associated with this instance immediately before the operand was added. getAndAdd(final short 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 short	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 short	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 Short	Returns: the value as a Short, never null. getValue() Implements org.apache.commons.lang3.mutable.Mutable.getValue. Deprecated Use `get()`. Gets the value as a Short 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 short	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 MutableShort 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 MutableShort as a long.
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	setValue(final short the value to set value) Implements org.apache.commons.lang3.mutable.Mutable.setValue. Sets the value.
public short	Returns: the numeric value represented by this object after conversion to type short. shortValue() Overrides java.lang.Number.shortValue. Returns the value of this MutableShort as a short.
public void	subtract(final Number the value to subtract, not null. operand) Subtracts a value from the value of this instance.
public void	subtract(final short the value to subtract, not null. operand) Subtracts a value from the value of this instance.
public Short	Returns: a Short instance containing the value from this mutable, never null. toShort() Gets this mutable as an instance of Short.
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:: byteValue

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.lang.Number.serialVersionUID. Required for serialization support. See Also `java.io.Serializable`

value	back to summary
private short value The mutable value.

MutableShort	back to summary
public MutableShort() Constructs a new MutableShort with the default value of zero.

MutableShort	back to summary
public MutableShort(final Number value) Constructs a new MutableShort with the specified value. Parameters value:Number the initial value to store, not null. Exceptions NullPointerException: if the object is null.

MutableShort	back to summary
public MutableShort(final short value) Constructs a new MutableShort with the specified value. Parameters value:short the initial value to store.

MutableShort	back to summary
public MutableShort(final String value) Constructs a new MutableShort parsing the given string. Parameters value:String the string to parse, not null. Exceptions NumberFormatException: if the string cannot be parsed into a short, see `Short#parseShort(String)`. Since 2.5

Method Detail

add	back 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

add

back 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

add	back to summary
public void add(final short operand) Adds a value to the value of this instance. Parameters operand:short the value to add, not null. Since 2.2

add

back to summary

public void add(final short operand)

Adds a value to the value of this instance.

Parameters

operand:short: the value to add, not null.

Since

2.2

addAndGet back to summary

addAndGet	back to summary
public short 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:short the value associated with this instance after adding the operand. Exceptions NullPointerException: if `operand` is null. Since 3.5

public short 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:short

the value associated with this instance after adding the operand.

Exceptions

NullPointerException:: if operand is null.

Since

3.5

addAndGet back to summary

addAndGet	back to summary
public short addAndGet(final short 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:short the quantity to add, not null. Returns:short the value associated with this instance after adding the operand. Since 3.5

public short addAndGet(final short 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:short: the quantity to add, not null.

Returns:short

the value associated with this instance after adding the operand.

Since

3.5

compareTo	back to summary
public int compareTo(final MutableShort other) Implements java.lang.Comparable.compareTo. Compares this mutable to another in ascending order. Parameters other:MutableShort the other mutable to compare to, not null. Returns:int negative if this is less, zero if equal, positive if greater. Annotations @Override

compareTo

back to summary

public int compareTo(final MutableShort other)

Implements java.lang.Comparable.compareTo.

Compares this mutable to another in ascending order.

Parameters

other:MutableShort: the other mutable to compare to, not null.

Returns:int

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

Annotations

@Override

decrement	back to summary
public void decrement() Decrements the value. Since 2.2

decrement

back to summary

public void decrement()

Decrements the value.

Since: 2.2

decrementAndGet	back to summary
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:short the value associated with the instance after it is decremented. Since 3.5

decrementAndGet

back to summary

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:short: the value associated with the instance after it is decremented.
Since: 3.5

doubleValue	back to summary
public double doubleValue() Implements abstract java.lang.Number.doubleValue. Returns the value of this MutableShort as a double. Returns:double the numeric value represented by this object after conversion to type double. Annotations @Override

doubleValue

back to summary

public double doubleValue()

Implements abstract java.lang.Number.doubleValue.

Returns the value of this MutableShort as a double.

Returns:double

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

Annotations

@Override

equals back to summary

equals	back 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 `MutableShort` object that contains the same `short` 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

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 MutableShort object that contains the same short 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

floatValue	back to summary
public float floatValue() Implements abstract java.lang.Number.floatValue. Returns the value of this MutableShort as a float. Returns:float the numeric value represented by this object after conversion to type float. Annotations @Override

floatValue

back to summary

public float floatValue()

Implements abstract java.lang.Number.floatValue.

Returns the value of this MutableShort as a float.

Returns:float

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

Annotations

@Override

getAndAdd back to summary

getAndAdd	back to summary
public short 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:short the value associated with this instance immediately before the operand was added. Exceptions NullPointerException: if `operand` is null. Since 3.5

public short 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:short

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

Exceptions

NullPointerException:: if operand is null.

Since

3.5

getAndAdd back to summary

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

public short getAndAdd(final short 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:short: the quantity to add, not null.

Returns:short

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

Since

3.5

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

getAndDecrement

back to summary

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

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

getAndIncrement

back to summary

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

getValue back to summary

getValue	back to summary
public Short getValue() Implements org.apache.commons.lang3.mutable.Mutable.getValue. Deprecated Use `get()`. Gets the value as a Short instance. Returns:Short the value as a Short, never null. Annotations @Deprecated @Override

public Short getValue()

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

Deprecated

Use get().

Gets the value as a Short instance.

Returns:Short

the value as a Short, never null.

Annotations

@Deprecated
@Override

hashCode	back 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

hashCode

back 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

increment	back to summary
public void increment() Increments the value. Since 2.2

increment

back to summary

public void increment()

Increments the value.

Since: 2.2

incrementAndGet	back to summary
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:short the value associated with the instance after it is incremented. Since 3.5

incrementAndGet

back to summary

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:short: the value associated with the instance after it is incremented.
Since: 3.5

intValue	back to summary
public int intValue() Implements abstract java.lang.Number.intValue. Returns the value of this MutableShort as an int. Returns:int the numeric value represented by this object after conversion to type int. Annotations @Override

intValue

back to summary

public int intValue()

Implements abstract java.lang.Number.intValue.

Returns the value of this MutableShort as an int.

Returns:int

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

Annotations

@Override

longValue	back to summary
public long longValue() Implements abstract java.lang.Number.longValue. Returns the value of this MutableShort as a long. Returns:long the numeric value represented by this object after conversion to type long. Annotations @Override

longValue

back to summary

public long longValue()

Implements abstract java.lang.Number.longValue.

Returns the value of this MutableShort as a long.

Returns:long

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

Annotations

@Override

setValue	back 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.

setValue

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

setValue	back to summary
public void setValue(final short value) Implements org.apache.commons.lang3.mutable.Mutable.setValue. Sets the value. Parameters value:short the value to set

setValue

back to summary

public void setValue(final short value)

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

Sets the value.

Parameters

value:short: the value to set

shortValue	back to summary
public short shortValue() Overrides java.lang.Number.shortValue. Returns the value of this MutableShort as a short. Returns:short the numeric value represented by this object after conversion to type short. Annotations @Override

shortValue

back to summary

public short shortValue()

Overrides java.lang.Number.shortValue.

Returns the value of this MutableShort as a short.

Returns:short

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

Annotations

@Override

subtract	back 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

subtract

back 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

subtract	back to summary
public void subtract(final short operand) Subtracts a value from the value of this instance. Parameters operand:short the value to subtract, not null. Since 2.2

subtract

back to summary

public void subtract(final short operand)

Subtracts a value from the value of this instance.

Parameters

operand:short: the value to subtract, not null.

Since

2.2

toShort	back to summary
public Short toShort() Gets this mutable as an instance of Short. Returns:Short a Short instance containing the value from this mutable, never null.

toShort

back to summary

public Short toShort()

Gets this mutable as an instance of Short.

Returns:Short: a Short instance containing the value from this mutable, never null.

toString	back 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

toString

back 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