Class UnsignedInteger

• 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​(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,
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
• 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.
• 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. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)

Overrides:
hashCode in class Object
Returns:
a hash code value for this object.
Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
• equals

public boolean equals​(@CheckForNull
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.