UnsignedLong

java.lang.Object
- java.lang.Number
- - com.google.common.primitives.UnsignedLong

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<UnsignedLong>
```
@Beta
@GwtCompatible(serializable=true)
public class UnsignedLong
extends java.lang.Number
implements java.lang.Comparable<UnsignedLong>, java.io.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.
Please do not extend this class; it will be made final in the near future.

Since:

11.0

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`

Constructor Summary

Constructors
Modifier Constructor and Description

protected UnsignedLong(long value)

Constructors
Modifier	Constructor and Description
`protected`	`UnsignedLong(long value)`

Method Summary

Methods
Modifier and Type	Method and Description
`UnsignedLong`	`add(UnsignedLong val)` Returns the result of adding this and `val`.
`static UnsignedLong`	`asUnsigned(long value)` Returns an `UnsignedLong` that, when treated as signed, is equal to `value`.
`java.math.BigInteger`	`bigIntegerValue()` Returns the value of this `UnsignedLong` as a `BigInteger`.
`int`	`compareTo(UnsignedLong o)`
`UnsignedLong`	`divide(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(java.lang.Object obj)`
`float`	`floatValue()` Returns the value of this `UnsignedLong` as a `float`, analogous to a widening primitive conversion from `long` to `float`, and correctly rounded.
`int`	`hashCode()`
`int`	`intValue()` Returns the value of this `UnsignedLong` as an `int`.
`long`	`longValue()` Returns the value of this `UnsignedLong` as a `long`.
`UnsignedLong`	`multiply(UnsignedLong val)` Returns the result of multiplying this and `val`.
`UnsignedLong`	`remainder(UnsignedLong val)` Returns the remainder of dividing this by `val`.
`UnsignedLong`	`subtract(UnsignedLong val)` Returns the result of subtracting this and `val`.
`java.lang.String`	`toString()` Returns a string representation of the `UnsignedLong` value, in base 10.
`java.lang.String`	`toString(int radix)` Returns a string representation of the `UnsignedLong` value, in base `radix`.
`static UnsignedLong`	`valueOf(java.math.BigInteger value)` Returns a `UnsignedLong` representing the same value as the specified `BigInteger` .
`static UnsignedLong`	`valueOf(java.lang.String string)` Returns an `UnsignedLong` holding the value of the specified `String`, parsed as an unsigned `long` value.
`static UnsignedLong`	`valueOf(java.lang.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
```
- Constructor Detail
  - UnsignedLong
```
protected UnsignedLong(long value)
```
- Method Detail
  - asUnsigned
```
public static UnsignedLong asUnsigned(long value)
```
    Returns an UnsignedLong that, when treated as signed, is equal to value. The inverse operation is longValue().
    Put another way, if value is negative, the returned result will be equal to 2^64 + value; otherwise, the returned result will be equal to value.
  - valueOf
```
public static UnsignedLong valueOf(java.math.BigInteger value)
```
    Returns a UnsignedLong representing the same value as the specified BigInteger . This is the inverse operation of bigIntegerValue().
    
    Throws:
    
    java.lang.IllegalArgumentException - if value is negative or value >= 2^64
  - valueOf
```
public static UnsignedLong valueOf(java.lang.String string)
```
    Returns an UnsignedLong holding the value of the specified String, parsed as an unsigned long value.
    
    Throws:
    
    java.lang.NumberFormatException - if the string does not contain a parsable unsigned long value
  - valueOf
```
public static UnsignedLong valueOf(java.lang.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:
    
    java.lang.NumberFormatException - if the string does not contain a parsable unsigned long value, or radix is not between Character.MIN_RADIX and Character.MAX_RADIX
  - add
```
public UnsignedLong add(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.
  - subtract
```
public UnsignedLong subtract(UnsignedLong val)
```
    Returns the result of subtracting this and val. If the result would be negative, returns the low 64 bits of the result.
  - multiply
```
public UnsignedLong multiply(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.
  - divide
```
public UnsignedLong divide(UnsignedLong val)
```
    Returns the result of dividing this by val.
  - remainder
```
public UnsignedLong remainder(UnsignedLong val)
```
    Returns the remainder of dividing this by val.
  - intValue
```
public int intValue()
```
    Returns the value of this UnsignedLong as an int.
    
    Specified by:
    
    intValue in class java.lang.Number
  - longValue
```
public long longValue()
```
    Returns the value of this UnsignedLong as a long. This is an inverse operation to asUnsigned(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 java.lang.Number
  - 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 java.lang.Number
  - 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 java.lang.Number
  - bigIntegerValue
```
public java.math.BigInteger bigIntegerValue()
```
    Returns the value of this UnsignedLong as a BigInteger.
  - compareTo
```
public int compareTo(UnsignedLong o)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<UnsignedLong>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(@Nullable
             java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of the UnsignedLong value, in base 10.
    
    Overrides:
    
    toString in class java.lang.Object
  - toString
```
public java.lang.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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Field Detail

ZERO

ONE

MAX_VALUE

Constructor Detail

UnsignedLong

Method Detail

asUnsigned

valueOf

valueOf

valueOf

add

subtract

multiply

divide

remainder

intValue

longValue

floatValue

doubleValue

bigIntegerValue

compareTo

hashCode

equals

toString

toString