Guava: Google Core Libraries for Java 33.1.0-jre · com.google.common.primitives.UnsignedInteger

Modifier and Type	Field and Description
public static final UnsignedInteger	MAX_VALUE
public static final UnsignedInteger	ONE
private final int	value
public static final UnsignedInteger	ZERO

Access	Constructor and Description
private	UnsignedInteger(int value)

Method Summary

Modifier and Type	Method and Description
public BigInteger	bigIntegerValue() Returns the value of this `UnsignedInteger` as a `BigInteger`.
public int	compareTo(UnsignedInteger the object to be compared. other) Implements java.lang.Comparable.compareTo. Compares this unsigned integer to another unsigned integer.
public UnsignedInteger	dividedBy(UnsignedInteger val) Returns the result of dividing this by `val`.
public double	doubleValue() Implements abstract java.lang.Number.doubleValue. Returns the value of this `UnsignedInteger` as a `float`, analogous to a widening primitive conversion from `int` to `double`, and correctly rounded.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public float	floatValue() Implements abstract java.lang.Number.floatValue. Returns the value of this `UnsignedInteger` as a `float`, analogous to a widening primitive conversion from `int` to `float`, and correctly rounded.
public static UnsignedInteger	fromIntBits(int bits) Returns an `UnsignedInteger` corresponding to a given bit representation.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public int	intValue() Implements abstract java.lang.Number.intValue. Returns the value of this `UnsignedInteger` as an `int`.
public long	longValue() Implements abstract java.lang.Number.longValue. Returns the value of this `UnsignedInteger` as a `long`.
public UnsignedInteger	minus(UnsignedInteger val) Returns the result of subtracting this and `val`.
public UnsignedInteger	mod(UnsignedInteger val) Returns this mod `val`.
public UnsignedInteger	plus(UnsignedInteger val) Returns the result of adding this and `val`.
public UnsignedInteger	times(UnsignedInteger val) Returns the result of multiplying this and `val`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the `UnsignedInteger` value, in base 10.
public String	toString(int radix) Returns a string representation of the `UnsignedInteger` value, in base `radix`.
public static UnsignedInteger	valueOf(long value) Returns an `UnsignedInteger` that is equal to `value`, if possible.
public static UnsignedInteger	valueOf(BigInteger value) Returns a `UnsignedInteger` representing the same value as the specified `BigInteger`.
public static UnsignedInteger	valueOf(String string) Returns an `UnsignedInteger` holding the value of the specified `String`, parsed as an unsigned `int` value.
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.

Inherited from java.lang.Number:: byteValue shortValue

MAX_VALUE	back to summary
public static final UnsignedInteger MAX_VALUE

ONE	back to summary
public static final UnsignedInteger ONE

value	back to summary
private final int value

ZERO	back to summary
public static final UnsignedInteger ZERO

UnsignedInteger	back to summary
private UnsignedInteger(int value)

Method Detail

bigIntegerValue	back to summary
public BigInteger bigIntegerValue() Returns the value of this `UnsignedInteger` as a `BigInteger`.

compareTo back to summary

compareTo	back to summary
public int compareTo(UnsignedInteger other) Implements java.lang.Comparable.compareTo. 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`. Parameters other:UnsignedInteger Doc from java.lang.Comparable.compareTo. the object to be compared. Returns:int Doc from java.lang.Comparable.compareTo. a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(UnsignedInteger other)

Implements java.lang.Comparable.compareTo.

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.

Parameters

other:UnsignedInteger

Doc from java.lang.Comparable.compareTo.

the object to be compared.

Returns:int

Doc from java.lang.Comparable.compareTo.

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

dividedBy back to summary

dividedBy	back to summary
public UnsignedInteger dividedBy(UnsignedInteger val) Returns the result of dividing this by `val`. Exceptions ArithmeticException: if `val` is zero Since 14.0

public UnsignedInteger dividedBy(UnsignedInteger val)

Returns the result of dividing this by val.

Exceptions

ArithmeticException:: if val is zero

Since

14.0

doubleValue back to summary

doubleValue	back to summary
public double doubleValue() Implements abstract java.lang.Number.doubleValue. Returns the value of this `UnsignedInteger` as a `float`, analogous to a widening primitive conversion from `int` to `double`, and correctly rounded. Returns:double Doc from java.lang.Number.doubleValue. the numeric value represented by this object after conversion to type `double`. Annotations @Override

public double doubleValue()

Implements abstract java.lang.Number.doubleValue.

Returns the value of this UnsignedInteger as a float, analogous to a widening primitive conversion from int to double, and correctly rounded.

Returns:double

Doc from java.lang.Number.doubleValue.

the numeric value represented by this object after conversion to type double.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. 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`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

floatValue back to summary

floatValue	back to summary
public float floatValue() Implements abstract java.lang.Number.floatValue. Returns the value of this `UnsignedInteger` as a `float`, analogous to a widening primitive conversion from `int` to `float`, and correctly rounded. Returns:float Doc from java.lang.Number.floatValue. the numeric value represented by this object after conversion to type `float`. Annotations @Override

public float floatValue()

Implements abstract java.lang.Number.floatValue.

Returns the value of this UnsignedInteger as a float, analogous to a widening primitive conversion from int to float, and correctly rounded.

Returns:float

Doc from java.lang.Number.floatValue.

the numeric value represented by this object after conversion to type float.

Annotations

@Override

fromIntBits back to summary

fromIntBits	back to summary
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

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

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.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` 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 `equals` 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. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.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 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 equals 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.

Returns:int

a hash code value for this object

Annotations

@Override

intValue back to summary

intValue	back to summary
public int intValue() Implements abstract java.lang.Number.intValue. Returns the value of this `UnsignedInteger` as an `int`. This is an inverse operation to `fromIntBits`. Note that if this `UnsignedInteger` holds a value `>= 2^31`, the returned value will be equal to `this - 2^32`. Returns:int Doc from java.lang.Number.intValue. the numeric value represented by this object after conversion to type `int`. Annotations @Override

public int intValue()

Implements abstract java.lang.Number.intValue.

Returns the value of this UnsignedInteger as an int. This is an inverse operation to fromIntBits.

Note that if this UnsignedInteger holds a value >= 2^31, the returned value will be equal to this - 2^32.

Returns:int

Doc from java.lang.Number.intValue.

the numeric value represented by this object after conversion to type int.

Annotations

@Override

longValue back to summary

longValue	back to summary
public long longValue() Implements abstract java.lang.Number.longValue. Returns the value of this `UnsignedInteger` as a `long`. Returns:long Doc from java.lang.Number.longValue. the numeric value represented by this object after conversion to type `long`. Annotations @Override

public long longValue()

Implements abstract java.lang.Number.longValue.

Returns the value of this UnsignedInteger as a long.

Returns:long

Doc from java.lang.Number.longValue.

the numeric value represented by this object after conversion to type long.

Annotations

@Override

minus back to summary

minus	back to summary
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

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

mod back to summary

mod	back to summary
public UnsignedInteger mod(UnsignedInteger val) Returns this mod `val`. Exceptions ArithmeticException: if `val` is zero Since 14.0

public UnsignedInteger mod(UnsignedInteger val)

Returns this mod val.

Exceptions

ArithmeticException:: if val is zero

Since

14.0

plus back to summary

plus	back to summary
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

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

times back to summary

times	back to summary
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. Annotations @J2ktIncompatible @GwtIncompatible Since 14.0

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.

Annotations

@J2ktIncompatible
@GwtIncompatible

Since

14.0

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a string representation of the `UnsignedInteger` value, in base 10. Returns:String Doc from java.lang.Object.toString. a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Returns a string representation of the UnsignedInteger value, in base 10.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations

@Override

toString	back to summary
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.

valueOf	back to summary
public static UnsignedInteger valueOf(long value) Returns an `UnsignedInteger` that is equal to `value`, if possible. The inverse operation of `longValue()`.

valueOf back to summary

valueOf	back to summary
public static UnsignedInteger valueOf(BigInteger value) Returns a `UnsignedInteger` representing the same value as the specified `BigInteger`. This is the inverse operation of `bigIntegerValue()`. Exceptions IllegalArgumentException: if `value` is negative or `value >= 2^32`

public static UnsignedInteger valueOf(BigInteger value)

Returns a UnsignedInteger representing the same value as the specified BigInteger. This is the inverse operation of bigIntegerValue().

Exceptions

IllegalArgumentException:: if value is negative or value >= 2^32

valueOf back to summary

valueOf	back to summary
public static UnsignedInteger valueOf(String string) Returns an `UnsignedInteger` holding the value of the specified `String`, parsed as an unsigned `int` value. Exceptions NumberFormatException: if the string does not contain a parsable unsigned `int` value

public static UnsignedInteger valueOf(String string)

Returns an UnsignedInteger holding the value of the specified String, parsed as an unsigned int value.

Exceptions

NumberFormatException:: if the string does not contain a parsable unsigned int value

valueOf back to summary

valueOf	back to summary
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. Exceptions NumberFormatException: if the string does not contain a parsable unsigned `int` value

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.

Exceptions

NumberFormatException:: if the string does not contain a parsable unsigned int value

public final Class UnsignedInteger

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail