org.jboss.util
Class MuLong

java.lang.Object
  extended byjava.lang.Number
      extended byorg.jboss.util.MuNumber (src) 
          extended byorg.jboss.util.MuLong
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Comparable, Mutable (src) , java.io.Serializable

public class MuLong
extends MuNumber (src)

A mutable long integer class.

See Also:
Serialized Form

Constructor Summary
MuLong()
          Construct a new mutable long integer.
MuLong(long l)
          Construct a new mutable long integer.
MuLong(java.lang.Object obj)
          Construct a new mutable long integer.
 
Method Summary
 long add(long amount)
          Add the specified amount.
 long and(long b)
          ANDs the current value with the specified value.
 byte byteValue()
          Return the byte value of this object.
 java.lang.Object clone()
          Return a cloned copy of this mutable long.
 boolean commit(long assumed, long b)
          Set the value to value only if the current value is equal to the assumed value.
 int compareTo(long other)
          Compares this object with the specified long for order.
 int compareTo(java.lang.Object obj)
          Compares this object with the specified object for order.
 long complement()
          Set the value to its complement.
 long decrement()
          Decrement the value of this mutable long.
 long divide(long factor)
          Divide by the specified factor.
 double doubleValue()
          Return the double value of this object.
 boolean equals(java.lang.Object obj)
          Test the equality of this mutable long integer and another object.
 float floatValue()
          Return the float value of this object.
 java.lang.Object getValue()
          Return the value of this mutable long integer.
 int hashCode()
          Get the hash code of this mutable long integer.
 long increment()
          Increment the value of this mutable long.
 int intValue()
          Return the int value of this object.
 long longValue()
          Return the long value of this object.
 long multiply(long factor)
          Multiply by the specified factor.
 long negate()
          Set the value to the negative of its current value.
 long or(long b)
          ORs the current value with the specified value.
 void set(long value)
          Set the value of this mutable long integer.
 void setValue(java.lang.Object obj)
          Set the value of this mutable long integer.
 long shiftLeft(int bits)
          Shift the current value to the left.
 long shiftRight(int bits)
          Shift the current value to the right.
 long shiftRightZero(int bits)
          Shift the current value to the right with a zero extension.
 short shortValue()
          Return the short value of this object.
 long subtract(long amount)
          Subtract the specified amount.
 long swap(MuLong (src)  b)
          Swap values with another mutable long.
 java.lang.String toString()
          Convert this mutable long integer to a string.
 long xor(long b)
          XORs the current value with the specified value.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MuLong

public MuLong()
Construct a new mutable long integer.


MuLong

public MuLong(long l)
Construct a new mutable long integer.

Parameters:
l - long value.

MuLong

public MuLong(java.lang.Object obj)
Construct a new mutable long integer.

Parameters:
obj - Object to convert to a long value.
Method Detail

commit

public boolean commit(long assumed,
                      long b)
Set the value to value only if the current value is equal to the assumed value.

Parameters:
assumed - The assumed value.
b - The new value.
Returns:
True if value was changed.

swap

public long swap(MuLong (src)  b)
Swap values with another mutable long.

Parameters:
b - Mutable long to swap values with.
Returns:
The new value.

increment

public long increment()
Increment the value of this mutable long.

Returns:
Long value.

decrement

public long decrement()
Decrement the value of this mutable long.

Returns:
Long value.

add

public long add(long amount)
Add the specified amount.

Parameters:
amount - Amount to add.
Returns:
The new value.

subtract

public long subtract(long amount)
Subtract the specified amount.

Parameters:
amount - Amount to subtract.
Returns:
The new value.

multiply

public long multiply(long factor)
Multiply by the specified factor.

Parameters:
factor - Factor to multiply by.
Returns:
The new value.

divide

public long divide(long factor)
Divide by the specified factor.

Parameters:
factor - Factor to divide by.
Returns:
The new value.

negate

public long negate()
Set the value to the negative of its current value.

Returns:
The new value.

complement

public long complement()
Set the value to its complement.

Returns:
The new value.

and

public long and(long b)
ANDs the current value with the specified value.

Parameters:
b - Value to and with.
Returns:
The new value.

or

public long or(long b)
ORs the current value with the specified value.

Parameters:
b - Value to or with.
Returns:
The new value.

xor

public long xor(long b)
XORs the current value with the specified value.

Parameters:
b - Value to xor with.
Returns:
The new value.

shiftRight

public long shiftRight(int bits)
Shift the current value to the right.

Parameters:
bits - The number of bits to shift.
Returns:
The new value.

shiftRightZero

public long shiftRightZero(int bits)
Shift the current value to the right with a zero extension.

Parameters:
bits - The number of bits to shift.
Returns:
The new value.

shiftLeft

public long shiftLeft(int bits)
Shift the current value to the left.

Parameters:
bits - The number of bits to shift.
Returns:
The new value.

compareTo

public int compareTo(long other)
Compares this object with the specified long for order.

Parameters:
other - Value to compare with.
Returns:
A negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

compareTo

public int compareTo(java.lang.Object obj)
Compares this object with the specified object for order.

Returns:
A negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
Throws:
java.lang.ClassCastException - Object is not a MuLong.

toString

public java.lang.String toString()
Convert this mutable long integer to a string.

Returns:
String value.

hashCode

public int hashCode()
Get the hash code of this mutable long integer.

Returns:
Hash code.

equals

public boolean equals(java.lang.Object obj)
Test the equality of this mutable long integer and another object.

Parameters:
obj - Object to test equality with.
Returns:
True if object is equal.

clone

public java.lang.Object clone()
Return a cloned copy of this mutable long.

Returns:
Cloaned mutable long.

byteValue

public byte byteValue()
Return the byte value of this object.

Overrides:
byteValue in class MuNumber (src)
Returns:
byte value.

shortValue

public short shortValue()
Return the short value of this object.

Overrides:
shortValue in class MuNumber (src)
Returns:
short value.

intValue

public int intValue()
Return the int value of this object.

Overrides:
intValue in class MuNumber (src)
Returns:
int value.

longValue

public long longValue()
Return the long value of this object.

Returns:
long value.

floatValue

public float floatValue()
Return the float value of this object.

Overrides:
floatValue in class MuNumber (src)
Returns:
float value.

doubleValue

public double doubleValue()
Return the double value of this object.

Returns:
double value.

set

public void set(long value)
Set the value of this mutable long integer.

Parameters:
value - The new value.

setValue

public void setValue(java.lang.Object obj)
Set the value of this mutable long integer.

Parameters:
obj - Object to convert to a long value.
Throws:
NotCoercibleException (src) - Can not convert to long.

getValue

public java.lang.Object getValue()
Return the value of this mutable long integer.

Returns:
java.lang.Long value.