org.apache.commons.lang.mutable
Class MutableInt

java.lang.Object
  extended byjava.lang.Number
      extended byorg.apache.commons.lang.mutable.MutableInt
All Implemented Interfaces:
java.lang.Comparable, Mutable, java.io.Serializable

public class MutableInt
extends java.lang.Number
implements java.lang.Comparable, Mutable

A mutable int wrapper.

Since:
2.1
Version:
$Id: MutableInt.java 437554 2006-08-28 06:21:41Z bayard $
See Also:
Integer, Serialized Form

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(java.lang.Number value)
          Constructs a new MutableInt with the specified value.
 
Method Summary
 void add(int operand)
          Adds a value.
 void add(java.lang.Number operand)
          Adds a value.
 int compareTo(java.lang.Object obj)
          Compares this mutable to another in ascending order.
 void decrement()
          Decrements the value.
 double doubleValue()
          Returns the value of this MutableInt as a double.
 boolean equals(java.lang.Object obj)
          Compares this object to the specified object.
 float floatValue()
          Returns the value of this MutableInt as a float.
 java.lang.Object getValue()
          Gets the value as a Integer instance.
 int hashCode()
          Returns a suitable hashcode for this mutable.
 void increment()
          Increments the value.
 int intValue()
          Returns the value of this MutableInt as a int.
 long longValue()
          Returns the value of this MutableInt as a long.
 void setValue(int value)
          Sets the value.
 void setValue(java.lang.Object value)
          Sets the value from any Number instance.
 void subtract(int operand)
          Subtracts a value.
 void subtract(java.lang.Number operand)
          Subtracts a value.
 java.lang.Integer toInteger()
          Gets this mutable as an instance of Integer.
 java.lang.String toString()
          Returns the String value of this mutable.
 
Methods inherited from class java.lang.Number
byteValue, shortValue
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

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(java.lang.Number value)
Constructs a new MutableInt with the specified value.

Parameters:
value - a value.
Throws:
java.lang.NullPointerException - if the object is null
Method Detail

getValue

public java.lang.Object getValue()
Gets the value as a Integer instance.

Specified by:
getValue in interface Mutable
Returns:
the value as a Integer

setValue

public void setValue(int value)
Sets the value.

Parameters:
value - the value to set

setValue

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

Specified by:
setValue in interface Mutable
Parameters:
value - the value to set
Throws:
java.lang.NullPointerException - if the object is null
java.lang.ClassCastException - if the type is not a Number

increment

public void increment()
Increments the value.

Since:
Commons Lang 2.2

decrement

public void decrement()
Decrements the value.

Since:
Commons Lang 2.2

add

public void add(int operand)
Adds a value.

Parameters:
operand - the value to add
Since:
Commons Lang 2.2

add

public void add(java.lang.Number operand)
Adds a value.

Parameters:
operand - the value to add
Throws:
java.lang.NullPointerException - if the object is null
Since:
Commons Lang 2.2

subtract

public void subtract(int operand)
Subtracts a value.

Parameters:
operand - the value to add
Since:
Commons Lang 2.2

subtract

public void subtract(java.lang.Number operand)
Subtracts a value.

Parameters:
operand - the value to add
Throws:
java.lang.NullPointerException - if the object is null
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.

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.

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.

toInteger

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

Returns:
a Integer instance containing the value from this mutable

equals

public boolean equals(java.lang.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.

hashCode

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

Returns:
a suitable hashcode

compareTo

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

Specified by:
compareTo in interface java.lang.Comparable
Parameters:
obj - the mutable to compare to
Returns:
negative if this is less, zero if equal, positive if greater
Throws:
java.lang.ClassCastException - if the argument is not a MutableInt

toString

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

Returns:
the mutable value as a string


Copyright 2001-2008 The Apache Software Foundation. All Rights Reserved.