org.apache.commons.lang.mutable
Class MutableLong

java.lang.Object
  java.lang.Number
      org.apache.commons.lang.mutable.MutableLong

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable, Mutable

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

A mutable long wrapper.

Since:

2.1

Version:

$Id: MutableLong.java 618693 2008-02-05 16:33:29Z sebb $

See Also:

Long, Serialized Form

Constructor Summary

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

MutableLong(long value)
Constructs a new MutableLong with the specified value.

MutableLong(java.lang.Number value)
Constructs a new MutableLong with the specified value.

Method Summary

void	add(long 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 MutableLong as a double.
boolean	equals(java.lang.Object obj) Compares this object against the specified object.
float	floatValue() Returns the value of this MutableLong as a float.
java.lang.Object	getValue() Gets the value as a Long instance.
int	hashCode() Returns a suitable hashcode for this mutable.
void	increment() Increments the value.
int	intValue() Returns the value of this MutableLong as a int.
long	longValue() Returns the value of this MutableLong as a long.
void	setValue(long value) Sets the value.
void	setValue(java.lang.Object value) Sets the value from any Number instance.
void	subtract(long operand) Subtracts a value.
void	subtract(java.lang.Number operand) Subtracts a value.
java.lang.Long	toLong() Gets this mutable as an instance of Long.
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

MutableLong

public MutableLong()

Constructs a new MutableLong with the default value of zero.

MutableLong

public MutableLong(long value)

Constructs a new MutableLong with the specified value.

Parameters:

value - a value.

MutableLong

public MutableLong(java.lang.Number value)

Constructs a new MutableLong 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 Long instance.

Specified by:

getValue in interface Mutable

Returns:

the value as a Long

setValue

public void setValue(long 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(long 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(long 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 MutableLong as a int.

Specified by:

intValue in class java.lang.Number

Returns:

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

longValue

public long longValue()

Returns the value of this MutableLong as a long.

Specified by:

longValue in class java.lang.Number

Returns:

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

floatValue

public float floatValue()

Returns the value of this MutableLong as a float.

Specified by:

floatValue in class java.lang.Number

Returns:

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

doubleValue

public double doubleValue()

Returns the value of this MutableLong as a double.

Specified by:

doubleValue in class java.lang.Number

Returns:

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

toLong

public java.lang.Long toLong()

Gets this mutable as an instance of Long.

Returns:

a Long instance containing the value from this mutable

equals

public boolean equals(java.lang.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 MutableLong object that contains the same long value as this object.

Overrides:

equals in class java.lang.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.

Overrides:

hashCode in class java.lang.Object

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 MutableLong

toString

public java.lang.String toString()

Returns the String value of this mutable.

Overrides:

toString in class java.lang.Object

Returns:

the mutable value as a string