org.apache.commons.lang.mutable

Class MutableShort

public class MutableShort extends Number implements Comparable, Mutable

A mutable short wrapper.

Since: 2.1

Version: $Id: MutableShort.java 437554 2006-08-28 06:21:41Z bayard $

See Also: Short

Constructor Summary
MutableShort()
Constructs 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.
Method Summary
voidadd(short operand)
Adds a value.
voidadd(Number operand)
Adds a value.
intcompareTo(Object obj)
Compares this mutable to another in ascending order.
voiddecrement()
Decrements the value.
doubledoubleValue()
Returns the value of this MutableShort as a double.
booleanequals(Object obj)
Compares this object against the specified object.
floatfloatValue()
Returns the value of this MutableShort as a float.
ObjectgetValue()
Gets the value as a Short instance.
inthashCode()
Returns a suitable hashcode for this mutable.
voidincrement()
Increments the value.
intintValue()
Returns the value of this MutableShort as a int.
longlongValue()
Returns the value of this MutableShort as a long.
voidsetValue(short value)
Sets the value.
voidsetValue(Object value)
Sets the value from any Number instance.
shortshortValue()
Returns the value of this MutableShort as a short.
voidsubtract(short operand)
Subtracts a value.
voidsubtract(Number operand)
Subtracts a value.
ShorttoShort()
Gets this mutable as an instance of Short.
StringtoString()
Returns the String value of this mutable.

Constructor Detail

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 a value.

MutableShort

public MutableShort(Number value)
Constructs a new MutableShort with the specified value.

Parameters: value a value.

Throws: NullPointerException if the object is null

Method Detail

add

public void add(short operand)
Adds a value.

Parameters: operand the value to add

Since: Commons Lang 2.2

add

public void add(Number operand)
Adds a value.

Parameters: operand the value to add

Throws: NullPointerException if the object is null

Since: Commons Lang 2.2

compareTo

public int compareTo(Object obj)
Compares this mutable to another in ascending order.

Parameters: obj the mutable to compare to

Returns: negative if this is less, zero if equal, positive if greater

Throws: ClassCastException if the argument is not a MutableShort

decrement

public void decrement()
Decrements the value.

Since: Commons Lang 2.2

doubleValue

public double doubleValue()
Returns the value of this MutableShort as a double.

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

equals

public boolean equals(Object obj)
Compares this object against 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 the object to compare with.

Returns: true if the objects are the same; false otherwise.

floatValue

public float floatValue()
Returns the value of this MutableShort as a float.

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

getValue

public Object getValue()
Gets the value as a Short instance.

Returns: the value as a Short

hashCode

public int hashCode()
Returns a suitable hashcode for this mutable.

Returns: a suitable hashcode

increment

public void increment()
Increments the value.

Since: Commons Lang 2.2

intValue

public int intValue()
Returns the value of this MutableShort as a int.

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

longValue

public long longValue()
Returns the value of this MutableShort as a long.

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

setValue

public void setValue(short value)
Sets the value.

Parameters: value the value to set

setValue

public void setValue(Object value)
Sets the value from any Number instance.

Parameters: value the value to set

Throws: NullPointerException if the object is null ClassCastException if the type is not a Number

shortValue

public short shortValue()
Returns the value of this MutableShort as a short.

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

subtract

public void subtract(short operand)
Subtracts a value.

Parameters: operand the value to add

Since: Commons Lang 2.2

subtract

public void subtract(Number operand)
Subtracts a value.

Parameters: operand the value to add

Throws: NullPointerException if the object is null

Since: Commons Lang 2.2

toShort

public Short toShort()
Gets this mutable as an instance of Short.

Returns: a Short instance containing the value from this mutable

toString

public String toString()
Returns the String value of this mutable.

Returns: the mutable value as a string

Copyright © 2001-2005 - Apache Software Foundation