UnsignedLong (Guava: Google Core Libraries for Java 15.0 API)

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 unsigned long 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 from UnsignedLongs.
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 and Description

static UnsignedLong MAX_VALUE

static UnsignedLong ONE

static UnsignedLong ZERO

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

Method Summary

Methods
Modifier and Type	Method and Description
`BigInteger`	`bigIntegerValue()` Returns the value of this `UnsignedLong` as a `BigInteger`.
`int`	`compareTo(UnsignedLong o)` Compares this object with the specified object for order.
`UnsignedLong`	`dividedBy(UnsignedLong val)` Returns the result of dividing this by `val`.
`double`	`doubleValue()` Returns the value of this `UnsignedLong` as a `double`, analogous to a widening primitive conversion from `long` to `double`, and correctly rounded.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`float`	`floatValue()` Returns the value of this `UnsignedLong` as a `float`, analogous to a widening primitive conversion from `long` to `float`, and correctly rounded.
`static UnsignedLong`	`fromLongBits(long bits)` Returns an `UnsignedLong` corresponding to a given bit representation.
`int`	`hashCode()` Returns a hash code value for the object.
`int`	`intValue()` Returns the value of this `UnsignedLong` as an `int`.
`long`	`longValue()` Returns the value of this `UnsignedLong` as a `long`.
`UnsignedLong`	`minus(UnsignedLong val)` Returns the result of subtracting this and `val`.
`UnsignedLong`	`mod(UnsignedLong val)` Returns this modulo `val`.
`UnsignedLong`	`plus(UnsignedLong val)` Returns the result of adding this and `val`.
`UnsignedLong`	`times(UnsignedLong val)` Returns the result of multiplying this and `val`.
`String`	`toString()` Returns a string representation of the `UnsignedLong` value, in base 10.
`String`	`toString(int radix)` Returns a string representation of the `UnsignedLong` value, in base `radix`.
`static UnsignedLong`	`valueOf(BigInteger value)` Returns a `UnsignedLong` representing the same value as the specified `BigInteger`.
`static UnsignedLong`	`valueOf(long value)` Returns an `UnsignedLong` representing the same value as the specified `long`.
`static UnsignedLong`	`valueOf(String string)` Returns an `UnsignedLong` holding the value of the specified `String`, parsed as an unsigned `long` value.
`static UnsignedLong`	`valueOf(String string, int radix)` Returns an `UnsignedLong` holding the value of the specified `String`, parsed as an unsigned `long` value in the specified radix.

Methods inherited from class java.lang.Number
byteValue, shortValue

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 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 an UnsignedLong corresponding to a given bit representation. The argument is interpreted as an unsigned 64-bit value. Specifically, the sign bit of bits 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 to 2^64 + bits.
    To represent decimal constants less than 2^63, consider valueOf(long) instead.
    
    Since:
    
    14.0
  - valueOf
```
public static UnsignedLong valueOf(long value)
```
    Returns an UnsignedLong representing the same value as the specified long.
    
    Throws:
    
    IllegalArgumentException - if value is negative
    Since:
    
    14.0
  - valueOf
```
public static UnsignedLong valueOf(BigInteger value)
```
    Returns a UnsignedLong representing the same value as the specified BigInteger. This is the inverse operation of bigIntegerValue().
    
    Throws:
    
    IllegalArgumentException - if value is negative or value >= 2^64
  - valueOf
```
public static UnsignedLong valueOf(String string)
```
    Returns an UnsignedLong holding the value of the specified String, parsed as an unsigned long value.
    
    Throws:
    
    NumberFormatException - if the string does not contain a parsable unsigned long value
  - valueOf
```
public static UnsignedLong valueOf(String string,
                   int radix)
```
    Returns an UnsignedLong holding the value of the specified String, parsed as an unsigned long value in the specified radix.
    
    Throws:
    
    NumberFormatException - if the string does not contain a parsable unsigned long value, or radix is not between Character.MIN_RADIX and Character.MAX_RADIX
  - plus
```
public UnsignedLong plus(UnsignedLong val)
```
    Returns the result of adding this and val. 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 and val. If the result would have more than 64 bits, returns the low 64 bits of the result.
    
    Since:
    
    14.0
  - times
```
@CheckReturnValue
public UnsignedLong times(UnsignedLong val)
```
    Returns the result of multiplying this and val. If the result would have more than 64 bits, returns the low 64 bits of the result.
    
    Since:
    
    14.0
  - dividedBy
```
@CheckReturnValue
public UnsignedLong dividedBy(UnsignedLong val)
```
    Returns the result of dividing this by val.
    
    Since:
    
    14.0
  - mod
```
@CheckReturnValue
public UnsignedLong mod(UnsignedLong val)
```
    Returns this modulo val.
    
    Since:
    
    14.0
  - intValue
```
public int intValue()
```
    Returns the value of this UnsignedLong as an int.
    
    Specified by:
    
    intValue in class Number
    
    Returns:
    the numeric value represented by this object after conversion to type int.
  - longValue
```
public long longValue()
```
    Returns the value of this UnsignedLong as a long. This is an inverse operation to fromLongBits(long).
    Note that if this UnsignedLong holds a value >= 2^63, the returned value will be equal to this - 2^64.
    
    Specified by:
    
    longValue in class Number
    
    Returns:
    the numeric value represented by this object after conversion to type long.
  - floatValue
```
public float floatValue()
```
    Returns the value of this UnsignedLong as a float, analogous to a widening primitive conversion from long to float, and correctly rounded.
    
    Specified by:
    
    floatValue in class Number
    
    Returns:
    the numeric value represented by this object after conversion to type float.
  - doubleValue
```
public double doubleValue()
```
    Returns the value of this UnsignedLong as a double, analogous to a widening primitive conversion from long to double, and correctly rounded.
    
    Specified by:
    
    doubleValue in class Number
    
    Returns:
    the numeric value represented by this object after conversion to type double.
  - bigIntegerValue
```
public BigInteger bigIntegerValue()
```
    Returns the value of this UnsignedLong as a BigInteger.
  - 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 all x and y. (This implies that x.compareTo(y) must throw an exception iff y.compareTo(x) throws an exception.)
    The implementor must also ensure that the relation is transitive: (x.compareTo(y)>0 && y.compareTo(z)>0) implies x.compareTo(z)>0.
    Finally, the implementor must ensure that x.compareTo(y)==0 implies that sgn(x.compareTo(z)) == sgn(y.compareTo(z)), for all z.
    It is strongly recommended, but not strictly required that (x.compareTo(y)==0) == (x.equals(y)). Generally speaking, any class that implements the Comparable 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 of -1, 0, or 1 according to whether the value of expression is negative, zero or positive.
    
    Specified by:
    
    compareTo in interface Comparable<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 by HashMap.
    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 in equals 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 the hashCode 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 the hashCode 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. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)
    Overrides:
    
    hashCode in class Object
    
    Returns:
    a hash code value for this object.
    See Also:
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - equals
```
public boolean equals(@Nullable
             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 non-null object references:
    - It is reflexive: for any non-null reference value x, x.equals(x) should return true.
    - It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
    - It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
    - It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
    - For any non-null reference value x, x.equals(null) should return false.
    The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).
    Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.
    Overrides:
    
    equals in class Object
    
    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
  - toString
```
public String toString()
```
    Returns a string representation of the UnsignedLong value, in base 10.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    a string representation of the object.
  - toString
```
public String toString(int radix)
```
    Returns a string representation of the UnsignedLong value, in base radix. If radix < Character.MIN_RADIX or radix > Character.MAX_RADIX, the radix 10 is used.

Class UnsignedLong

Field Summary

Method Summary

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Field Detail

ZERO

ONE

MAX_VALUE

Method Detail

fromLongBits

valueOf

valueOf

valueOf

valueOf

plus

minus

times

dividedBy

mod

intValue

longValue

floatValue

doubleValue

bigIntegerValue

compareTo

hashCode

equals

toString

toString