Class UnsignedInteger

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:

  • Field Details

  • Method Details

    • 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

    • longValue

      public long longValue()
      Returns the value of this UnsignedInteger as a long.
      Specified by:
      longValue in class Number

    • 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

    • doubleValue

      public double doubleValue()
      Returns the value of this UnsignedInteger as a double, analogous to a widening primitive conversion from int to double, and correctly rounded.
      Specified by:
      doubleValue in class Number

    • 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>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(@Nullable Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Returns a string representation of the UnsignedInteger value, in base 10.
      Overrides:
      toString in class 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.