Class UnsignedLong
 java.lang.Object

 java.lang.Number

 com.google.common.primitives.UnsignedLong

 All Implemented Interfaces:
Serializable
,Comparable<UnsignedLong>
@GwtCompatible(serializable=true) public final class UnsignedLong extends Number implements Comparable<UnsignedLong>, Serializable
A wrapper class for unsignedlong
values, supporting arithmetic operations.In some cases, when speed is more important than code readability, it may be faster simply to treat primitive
long
values as unsigned, using the methods fromUnsignedLongs
.See the Guava User Guide article on unsigned primitive utilities.
 Since:
 11.0
 Author:
 Louis Wasserman, Colin Evans
 See Also:
 Serialized Form


Field Summary
Fields Modifier and Type Field Description static UnsignedLong
MAX_VALUE
static UnsignedLong
ONE
static UnsignedLong
ZERO

Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BigInteger
bigIntegerValue()
Returns the value of thisUnsignedLong
as aBigInteger
.int
compareTo(UnsignedLong o)
Compares this object with the specified object for order.UnsignedLong
dividedBy(UnsignedLong val)
Returns the result of dividing this byval
.double
doubleValue()
Returns the value of thisUnsignedLong
as adouble
, analogous to a widening primitive conversion fromlong
todouble
, and correctly rounded.boolean
equals(Object obj)
Indicates whether some other object is "equal to" this one.float
floatValue()
Returns the value of thisUnsignedLong
as afloat
, analogous to a widening primitive conversion fromlong
tofloat
, and correctly rounded.static UnsignedLong
fromLongBits(long bits)
Returns anUnsignedLong
corresponding to a given bit representation.int
hashCode()
Returns a hash code value for the object.int
intValue()
Returns the value of thisUnsignedLong
as anint
.long
longValue()
Returns the value of thisUnsignedLong
as along
.UnsignedLong
minus(UnsignedLong val)
Returns the result of subtracting this andval
.UnsignedLong
mod(UnsignedLong val)
Returns this moduloval
.UnsignedLong
plus(UnsignedLong val)
Returns the result of adding this andval
.UnsignedLong
times(UnsignedLong val)
Returns the result of multiplying this andval
.String
toString()
Returns a string representation of theUnsignedLong
value, in base 10.String
toString(int radix)
Returns a string representation of theUnsignedLong
value, in baseradix
.static UnsignedLong
valueOf(long value)
Returns anUnsignedLong
representing the same value as the specifiedlong
.static UnsignedLong
valueOf(String string)
Returns anUnsignedLong
holding the value of the specifiedString
, parsed as an unsignedlong
value.static UnsignedLong
valueOf(String string, int radix)
Returns anUnsignedLong
holding the value of the specifiedString
, parsed as an unsignedlong
value in the specified radix.static UnsignedLong
valueOf(BigInteger value)
Returns aUnsignedLong
representing the same value as the specifiedBigInteger
.
Methods inherited from class java.lang.Number
byteValue, shortValue




Field Detail

ZERO
public static final UnsignedLong ZERO

ONE
public static final UnsignedLong ONE

MAX_VALUE
public static final UnsignedLong MAX_VALUE


Method Detail

fromLongBits
public static UnsignedLong fromLongBits(long bits)
Returns anUnsignedLong
corresponding to a given bit representation. The argument is interpreted as an unsigned 64bit value. Specifically, the sign bit ofbits
is interpreted as a normal bit, and all other bits are treated as usual.If the argument is nonnegative, the returned result will be equal to
bits
, otherwise, the result will be equal to2^64 + bits
.To represent decimal constants less than
2^63
, considervalueOf(long)
instead. Since:
 14.0

valueOf
@CanIgnoreReturnValue public static UnsignedLong valueOf(long value)
Returns anUnsignedLong
representing the same value as the specifiedlong
. Throws:
IllegalArgumentException
 ifvalue
is negative Since:
 14.0

valueOf
@CanIgnoreReturnValue public static UnsignedLong valueOf(BigInteger value)
Returns aUnsignedLong
representing the same value as the specifiedBigInteger
. This is the inverse operation ofbigIntegerValue()
. Throws:
IllegalArgumentException
 ifvalue
is negative orvalue >= 2^64

valueOf
@CanIgnoreReturnValue public static UnsignedLong valueOf(String string)
Returns anUnsignedLong
holding the value of the specifiedString
, parsed as an unsignedlong
value. Throws:
NumberFormatException
 if the string does not contain a parsable unsignedlong
value

valueOf
@CanIgnoreReturnValue public static UnsignedLong valueOf(String string, int radix)
Returns anUnsignedLong
holding the value of the specifiedString
, parsed as an unsignedlong
value in the specified radix. Throws:
NumberFormatException
 if the string does not contain a parsable unsignedlong
value, orradix
is not betweenCharacter.MIN_RADIX
andCharacter.MAX_RADIX

plus
public UnsignedLong plus(UnsignedLong val)
Returns the result of adding this andval
. If the result would have more than 64 bits, returns the low 64 bits of the result. Since:
 14.0

minus
public UnsignedLong minus(UnsignedLong val)
Returns the result of subtracting this andval
. If the result would have more than 64 bits, returns the low 64 bits of the result. Since:
 14.0

times
public UnsignedLong times(UnsignedLong val)
Returns the result of multiplying this andval
. If the result would have more than 64 bits, returns the low 64 bits of the result. Since:
 14.0

dividedBy
public UnsignedLong dividedBy(UnsignedLong val)
Returns the result of dividing this byval
. Since:
 14.0

mod
public UnsignedLong mod(UnsignedLong val)
Returns this moduloval
. Since:
 14.0

intValue
public int intValue()
Returns the value of thisUnsignedLong
as anint
.

longValue
public long longValue()
Returns the value of thisUnsignedLong
as along
. This is an inverse operation tofromLongBits(long)
.Note that if this
UnsignedLong
holds a value>= 2^63
, the returned value will be equal tothis  2^64
.

floatValue
public float floatValue()
Returns the value of thisUnsignedLong
as afloat
, analogous to a widening primitive conversion fromlong
tofloat
, and correctly rounded. Specified by:
floatValue
in classNumber
 Returns:
 the numeric value represented by this object after conversion
to type
float
.

doubleValue
public double doubleValue()
Returns the value of thisUnsignedLong
as adouble
, analogous to a widening primitive conversion fromlong
todouble
, and correctly rounded. Specified by:
doubleValue
in classNumber
 Returns:
 the numeric value represented by this object after conversion
to type
double
.

bigIntegerValue
public BigInteger bigIntegerValue()
Returns the value of thisUnsignedLong
as aBigInteger
.

compareTo
public int compareTo(UnsignedLong o)
Description copied from interface:java.lang.Comparable
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.The implementor must ensure
sgn(x.compareTo(y)) == sgn(y.compareTo(x))
for allx
andy
. (This implies thatx.compareTo(y)
must throw an exception iffy.compareTo(x)
throws an exception.)The implementor must also ensure that the relation is transitive:
(x.compareTo(y) > 0 && y.compareTo(z) > 0)
impliesx.compareTo(z) > 0
.Finally, the implementor must ensure that
x.compareTo(y)==0
implies thatsgn(x.compareTo(z)) == sgn(y.compareTo(z))
, for allz
.It is strongly recommended, but not strictly required that
(x.compareTo(y)==0) == (x.equals(y))
. Generally speaking, any class that implements theComparable
interface and violates this condition should clearly indicate this fact. The recommended language is "Note: this class has a natural ordering that is inconsistent with equals."In the foregoing description, the notation
sgn(
expression)
designates the mathematical signum function, which is defined to return one of1
,0
, or1
according to whether the value of expression is negative, zero, or positive, respectively. Specified by:
compareTo
in interfaceComparable<UnsignedLong>
 Parameters:
o
 the object to be compared. Returns:
 a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

hashCode
public int hashCode()
Description copied from class:java.lang.Object
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided byHashMap
.The general contract of
hashCode
is: Whenever it is invoked on the same object more than once during
an execution of a Java application, the
hashCode
method must consistently return the same integer, provided no information used inequals
comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.  If two objects are equal according to the
equals(Object)
method, then calling thehashCode
method on each of the two objects must produce the same integer result.  It is not required that if two objects are unequal
according to the
Object.equals(java.lang.Object)
method, then calling thehashCode
method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by class
Object
does return distinct integers for distinct objects. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.) Overrides:
hashCode
in classObject
 Returns:
 a hash code value for this object.
 See Also:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
 Whenever it is invoked on the same object more than once during
an execution of a Java application, the

equals
public boolean equals(@CheckForNull Object obj)
Description copied from class:java.lang.Object
Indicates whether some other object is "equal to" this one.The
equals
method implements an equivalence relation on nonnull object references: It is reflexive: for any nonnull reference value
x
,x.equals(x)
should returntrue
.  It is symmetric: for any nonnull reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
.  It is transitive: for any nonnull reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
.  It is consistent: for any nonnull reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified.  For any nonnull reference value
x
,x.equals(null)
should returnfalse
.
The
equals
method for classObject
implements the most discriminating possible equivalence relation on objects; that is, for any nonnull reference valuesx
andy
, this method returnstrue
if and only ifx
andy
refer to the same object (x == y
has the valuetrue
).Note that it is generally necessary to override the
hashCode
method whenever this method is overridden, so as to maintain the general contract for thehashCode
method, which states that equal objects must have equal hash codes. Overrides:
equals
in classObject
 Parameters:
obj
 the reference object with which to compare. Returns:
true
if this object is the same as the obj argument;false
otherwise. See Also:
Object.hashCode()
,HashMap
 It is reflexive: for any nonnull reference value

toString
public String toString()
Returns a string representation of theUnsignedLong
value, in base 10.

