org.apache.commons.lang.mutable

Class MutableInt

public class MutableInt extends Number implements Comparable, Mutable

A mutable int wrapper.

Since: 2.1

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

See Also: Integer

Constructor Summary
MutableInt()
Constructs a new MutableInt with the default value of zero.
MutableInt(int value)
Constructs a new MutableInt with the specified value.
MutableInt(Number value)
Constructs a new MutableInt with the specified value.
Method Summary
voidadd(int 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 MutableInt as a double.
booleanequals(Object obj)
Compares this object to the specified object.
floatfloatValue()
Returns the value of this MutableInt as a float.
ObjectgetValue()
Gets the value as a Integer instance.
inthashCode()
Returns a suitable hashcode for this mutable.
voidincrement()
Increments the value.
intintValue()
Returns the value of this MutableInt as a int.
longlongValue()
Returns the value of this MutableInt as a long.
voidsetValue(int value)
Sets the value.
voidsetValue(Object value)
Sets the value from any Number instance.
voidsubtract(int operand)
Subtracts a value.
voidsubtract(Number operand)
Subtracts a value.
IntegertoInteger()
Gets this mutable as an instance of Integer.
StringtoString()
Returns the String value of this mutable.

Constructor Detail

MutableInt

public MutableInt()
Constructs a new MutableInt with the default value of zero.

MutableInt

public MutableInt(int value)
Constructs a new MutableInt with the specified value.

Parameters: value a value.

MutableInt

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

Parameters: value a value.

Throws: NullPointerException if the object is null

Method Detail

add

public void add(int 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 MutableInt

decrement

public void decrement()
Decrements the value.

Since: Commons Lang 2.2

doubleValue

public double doubleValue()
Returns the value of this MutableInt 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 to the specified object. The result is true if and only if the argument is not null and is an MutableInt object that contains the same int 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 MutableInt 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 Integer instance.

Returns: the value as a Integer

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 MutableInt 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 MutableInt as a long.

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

setValue

public void setValue(int 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

subtract

public void subtract(int 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

toInteger

public Integer toInteger()
Gets this mutable as an instance of Integer.

Returns: a Integer 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-2010 - Apache Software Foundation