javax.cim
Class UnsignedInteger64

java.lang.Object
  extended by java.lang.Number
      extended by javax.cim.UnsignedInteger64
All Implemented Interfaces:
Serializable, Comparable<UnsignedInteger64>

public class UnsignedInteger64
extends Number
implements Comparable<UnsignedInteger64>

The UnsignedInteger64 class wraps the value of an uint64. This class was created to represent an uint64 data type as defined by the CIM Infrastructure Specification. The specification is available from the DMTF (Distributed Management Task Force) at http://dmtf.org/

See Also:
Serialized Form

Field Summary
static BigInteger MAX_VALUE
          MAX_VALUE
static BigInteger MIN_VALUE
          MIN_VALUE
 
Constructor Summary
UnsignedInteger64(BigInteger pValue)
          Constructs an unsigned 64-bit integer object for the specified BigInteger.
UnsignedInteger64(byte[] pValue)
          Constructs an unsigned 64-bit integer object for the specified array of bytes.
UnsignedInteger64(String pValue)
          Constructs an unsigned 64-bit integer object from the specified string.
 
Method Summary
 BigInteger bigIntegerValue()
          Get the value as a BigInteger.
 byte byteValue()
          Returns the value of this unsigned integer object as a byte.
 int compareTo(UnsignedInteger64 pOther)
          Compares this UnsignedInt64 with the specified UnsignedInt64.
 double doubleValue()
          Returns the value of this unsigned integer object as a doubles.
 boolean equals(Object pOther)
          Compares this object against the specified object.
 float floatValue()
          Returns the value of this unsigned integer object as a float .
 int hashCode()
          Computes the hash code for this unsigned integer object.
 int intValue()
          Returns the value of this unsigned integer object as an int.
 long longValue()
          Returns the value of this unsigned integer object as a long.
 short shortValue()
          Returns the value of this unsigned integer object as a short .
 String toString()
          Returns the text representation of this unsigned integer object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

MAX_VALUE

public static final BigInteger MAX_VALUE
MAX_VALUE


MIN_VALUE

public static final BigInteger MIN_VALUE
MIN_VALUE

Constructor Detail

UnsignedInteger64

public UnsignedInteger64(BigInteger pValue)
                  throws NumberFormatException
Constructs an unsigned 64-bit integer object for the specified BigInteger. Only the lower 64 bits are considered.

Parameters:
pValue - - the BigInteger to be represented as an unsigned 64-bit integer.
Throws:
NumberFormatException - - If the number is out of range.

UnsignedInteger64

public UnsignedInteger64(byte[] pValue)
                  throws NumberFormatException
Constructs an unsigned 64-bit integer object for the specified array of bytes. Only the lower 64 bits are considered.

Parameters:
pValue - - the byte array to be represented as an unsigned 64-bit integer.
Throws:
NumberFormatException - - if the number is out of range.

UnsignedInteger64

public UnsignedInteger64(String pValue)
                  throws NumberFormatException
Constructs an unsigned 64-bit integer object from the specified string. Only the lower 64 bits are considered.

Parameters:
pValue - - the String to be represented as an unsigned 64-bit integer.
Throws:
NumberFormatException - - if the number is out of range.
Method Detail

bigIntegerValue

public BigInteger bigIntegerValue()
Get the value as a BigInteger.

Returns:
BigInteger representation of this object.

compareTo

public int compareTo(UnsignedInteger64 pOther)
Compares this UnsignedInt64 with the specified UnsignedInt64. This method is provided in preference to individual methods for each of the six boolean comparison operators (<, ==, >, >=, !=, <=). The suggested idiom for performing these comparisons is: (x.compareTo(y) <op> 0), where <op> is one of the six comparison operators.

Specified by:
compareTo in interface Comparable<UnsignedInteger64>
Parameters:
pOther - - Object to which this UnsignedInt64 is to be compared. Throws a ClassCastException if the input object is not an UnsignedInt64.
Returns:
-1, 0 or 1 as this UnsignedInt64 is numerically less than, equal to, or greater than val.
See Also:
Comparable.compareTo(Object o)

equals

public boolean equals(Object pOther)
Compares this object against the specified object. The result is true if and only if the argument is not null and is an UnsignedInteger64 object that represents the same value as this object.

Overrides:
equals in class Object
Parameters:
pOther - - the object to compare.
Returns:
true if the objects are the same; false otherwise.

byteValue

public byte byteValue()
Returns the value of this unsigned integer object as a byte.

Overrides:
byteValue in class Number
Returns:
The byte value of this unsigned integer object.

doubleValue

public double doubleValue()
Returns the value of this unsigned integer object as a doubles.

Specified by:
doubleValue in class Number
Returns:
Value of this unsigned integer object as a double.

floatValue

public float floatValue()
Returns the value of this unsigned integer object as a float .

Specified by:
floatValue in class Number
Returns:
float

hashCode

public int hashCode()
Computes the hash code for this unsigned integer object.

Overrides:
hashCode in class Object
Returns:
The integer representing the hash code for this unsigned integer object

intValue

public int intValue()
Returns the value of this unsigned integer object as an int.

Specified by:
intValue in class Number
Returns:
Value of this unsigned integer object as an int.

longValue

public long longValue()
Returns the value of this unsigned integer object as a long.

Specified by:
longValue in class Number
Returns:
Value of this unsigned integer object as a long.

shortValue

public short shortValue()
Returns the value of this unsigned integer object as a short .

Overrides:
shortValue in class Number
Returns:
Value of this unsigned integer object as a short.

toString

public String toString()
Returns the text representation of this unsigned integer object.

Overrides:
toString in class Object
Returns:
Text representation of this unsigned integer.


Copyright © 2005, 2009 IBM Corporation. All Rights Reserved.