org.apache.commons.lang.mutable
Class MutableLong

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

public class MutableLong
extends Number
implements Comparable, Mutable

A mutable long wrapper.

Since:
2.1
Version:
$Id: MutableLong.java 161243 2005-04-14 04:30:28Z ggregory $
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(Number value)
          Constructs a new MutableLong with the specified value.
 
Method Summary
 int compareTo(Object obj)
          Compares this mutable to another in ascending order.
 double doubleValue()
          Returns the value of this MutableLong as a double.
 boolean equals(Object obj)
          Compares this object against the specified object.
 float floatValue()
          Returns the value of this MutableLong as a float.
 Object getValue()
          Gets the value as a Long instance.
 int hashCode()
          Returns a suitable hashcode for this mutable.
 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(Object value)
          Sets the value from any Number instance.
 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(Number value)
Constructs a new MutableLong with the specified value.

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

getValue

public 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(Object value)
Sets the value from any Number instance.

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

intValue

public int intValue()
Returns the value of this MutableLong 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 MutableLong 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 MutableLong 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 MutableLong 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 MutableLong object that contains the same long 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(Object obj)
Compares this mutable to another in ascending order.

Specified by:
compareTo in interface Comparable
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 MutableLong

toString

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

Returns:
the mutable value as a string


Copyright © 2001-2005 The Apache Software Foundation. All Rights Reserved.