UnsignedInteger (Guava: Google Core Libraries for Java 23.6-jre API)

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

All Implemented Interfaces:

Serializable, Comparable<UnsignedInteger>
```
@GwtCompatible(emulated=true)
public final class UnsignedInteger
extends Number
implements Comparable<UnsignedInteger>
```
A wrapper class for unsigned int values, supporting arithmetic operations.
In some cases, when speed is more important than code readability, it may be faster simply to treat primitive int values as unsigned, using the methods from UnsignedInts.
See the Guava User Guide article on unsigned primitive utilities.

Since:

11.0

Author:

Louis Wasserman

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static UnsignedInteger MAX_VALUE

static UnsignedInteger ONE

static UnsignedInteger ZERO

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BigInteger`	`bigIntegerValue()` Returns the value of this `UnsignedInteger` as a `BigInteger`.
`int`	`compareTo(UnsignedInteger other)` Compares this unsigned integer to another unsigned integer.
`UnsignedInteger`	`dividedBy(UnsignedInteger val)` Returns the result of dividing this by `val`.
`double`	`doubleValue()` Returns the value of this `UnsignedInteger` as a `float`, analogous to a widening primitive conversion from `int` 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 `UnsignedInteger` as a `float`, analogous to a widening primitive conversion from `int` to `float`, and correctly rounded.
`static UnsignedInteger`	`fromIntBits(int bits)` Returns an `UnsignedInteger` corresponding to a given bit representation.
`int`	`hashCode()` Returns a hash code value for the object.
`int`	`intValue()` Returns the value of this `UnsignedInteger` as an `int`.
`long`	`longValue()` Returns the value of this `UnsignedInteger` as a `long`.
`UnsignedInteger`	`minus(UnsignedInteger val)` Returns the result of subtracting this and `val`.
`UnsignedInteger`	`mod(UnsignedInteger val)` Returns this mod `val`.
`UnsignedInteger`	`plus(UnsignedInteger val)` Returns the result of adding this and `val`.
`UnsignedInteger`	`times(UnsignedInteger val)` Returns the result of multiplying this and `val`.
`String`	`toString()` Returns a string representation of the `UnsignedInteger` value, in base 10.
`String`	`toString(int radix)` Returns a string representation of the `UnsignedInteger` value, in base `radix`.
`static UnsignedInteger`	`valueOf(BigInteger value)` Returns a `UnsignedInteger` representing the same value as the specified `BigInteger`.
`static UnsignedInteger`	`valueOf(long value)` Returns an `UnsignedInteger` that is equal to `value`, if possible.
`static UnsignedInteger`	`valueOf(String string)` Returns an `UnsignedInteger` holding the value of the specified `String`, parsed as an unsigned `int` value.
`static UnsignedInteger`	`valueOf(String string, int radix)` Returns an `UnsignedInteger` holding the value of the specified `String`, parsed as an unsigned `int` 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 UnsignedInteger ZERO
```
  - ONE
```
public static final UnsignedInteger ONE
```
  - MAX_VALUE
```
public static final UnsignedInteger MAX_VALUE
```
- Method Detail
  - fromIntBits
```
public static UnsignedInteger fromIntBits(int bits)
```
    Returns an UnsignedInteger corresponding to a given bit representation. The argument is interpreted as an unsigned 32-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^32 + bits.
    To represent unsigned decimal constants, consider valueOf(long) instead.
    
    Since:
    
    14.0
  - valueOf
```
public static UnsignedInteger valueOf(long value)
```
    Returns an UnsignedInteger that is equal to value, if possible. The inverse operation of longValue().
  - valueOf
```
public static UnsignedInteger valueOf(BigInteger value)
```
    Returns a UnsignedInteger representing the same value as the specified BigInteger. This is the inverse operation of bigIntegerValue().
    
    Throws:
    
    IllegalArgumentException - if value is negative or value >= 2^32
  - valueOf
```
public static UnsignedInteger valueOf(String string)
```
    Returns an UnsignedInteger holding the value of the specified String, parsed as an unsigned int value.
    
    Throws:
    
    NumberFormatException - if the string does not contain a parsable unsigned int value
  - valueOf
```
public static UnsignedInteger valueOf(String string,
                                      int radix)
```
    Returns an UnsignedInteger holding the value of the specified String, parsed as an unsigned int value in the specified radix.
    
    Throws:
    
    NumberFormatException - if the string does not contain a parsable unsigned int value
  - plus
```
public UnsignedInteger plus(UnsignedInteger val)
```
    Returns the result of adding this and val. If the result would have more than 32 bits, returns the low 32 bits of the result.
    
    Since:
    
    14.0
  - minus
```
public UnsignedInteger minus(UnsignedInteger val)
```
    Returns the result of subtracting this and val. If the result would be negative, returns the low 32 bits of the result.
    
    Since:
    
    14.0
  - times
```
@GwtIncompatible
public UnsignedInteger times(UnsignedInteger val)
```
    Returns the result of multiplying this and val. If the result would have more than 32 bits, returns the low 32 bits of the result.
    
    Since:
    
    14.0
  - dividedBy
```
public UnsignedInteger dividedBy(UnsignedInteger val)
```
    Returns the result of dividing this by val.
    
    Throws:
    
    ArithmeticException - if val is zero
    
    Since:
    
    14.0
  - mod
```
public UnsignedInteger mod(UnsignedInteger val)
```
    Returns this mod val.
    
    Throws:
    
    ArithmeticException - if val is zero
    
    Since:
    
    14.0
  - intValue
```
public int intValue()
```
    Returns the value of this UnsignedInteger as an int. This is an inverse operation to fromIntBits(int).
    Note that if this UnsignedInteger holds a value >= 2^31, the returned value will be equal to this - 2^32.
    
    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 UnsignedInteger as a long.
    
    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 UnsignedInteger as a float, analogous to a widening primitive conversion from int 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 UnsignedInteger as a float, analogous to a widening primitive conversion from int 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 UnsignedInteger as a BigInteger.
  - compareTo
```
public int compareTo(UnsignedInteger other)
```
    Compares this unsigned integer to another unsigned integer. Returns 0 if they are equal, a negative number if this < other, and a positive number if this > other.
    
    Specified by:
    
    compareTo in interface Comparable<UnsignedInteger>
    
    Parameters:
    
    other - 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™ 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(@NullableDecl
                      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 UnsignedInteger 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 UnsignedInteger value, in base radix. If radix < Character.MIN_RADIX or radix > Character.MAX_RADIX, the radix 10 is used.

Class UnsignedInteger

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

fromIntBits

valueOf

valueOf

valueOf

valueOf

plus

minus

times

dividedBy

mod

intValue

longValue

floatValue

doubleValue

bigIntegerValue

compareTo

hashCode

equals

toString

toString