Top Description Fields Constructors Methods
org.jooq.types

public final Class UInteger

extends UNumber
implements Comparable<UInteger>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable
Imports
java.io.ObjectStreamException, java.math.BigInteger

The unsigned int type
Authors
Lukas Eder, Ed Schaller, Jens Nerche

Field Summary

Modifier and TypeField and Description
private static final Class<UInteger>
private static final String
private static final int
DEFAULT_PRECACHE_SIZE

Default size for the value cache.

public static final UInteger
MAX

A constant holding the maximum value an unsigned int can have as UInteger, 232-1.

public static final long
MAX_VALUE

A constant holding the maximum value an unsigned int can have, 232-1.

public static final UInteger
MIN

A constant holding the minimum value an unsigned int can have as UInteger, 0.

public static final long
MIN_VALUE

A constant holding the minimum value an unsigned int can have, 0.

private static final String
PRECACHE_PROPERTY

System property name for the property to set the size of the pre-cache.

private static final long
private final long
value

The value modelling the content of this unsigned int

private static final UInteger[]
VALUES

Cached values

Constructor Summary

AccessConstructor and Description
private
UInteger(long
The value to wrap
value
,
boolean
Unused parameter to distinguish between this and the deprecated public constructor.
unused
)

Unchecked internal constructor.

private
UInteger(long value)

Create an unsigned int

private
UInteger(int value)

Create an unsigned int by masking it with 0xFFFFFFFF i.e. (int) -1 becomes (uint) 4294967295

private
UInteger(String value)

Create an unsigned int

Method Summary

Modifier and TypeMethod and Description
public UInteger
add(final UInteger val)

public UInteger
add(final int val)

public int
compareTo(UInteger
the object to be compared.
o
)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.
public double
doubleValue()

Implements abstract java.lang.Number.doubleValue.

Returns the value of the specified number as a double.
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 the specified number as a float.
private static UInteger

Returns:

Cached value if one exists. Null otherwise.
getCached
(long
Cached value to retrieve
value
)

Retrieve a cached value.

private static final int

Returns:

The parsed value of the system property PRECACHE_PROPERTY or DEFAULT_PRECACHE_SIZE if the property is not set, not a number or retrieving results in a SecurityException. If the parsed value is zero or negative no cache will be created. If the value is larger than Integer#MAX_VALUE then Integer#MAX_VALUE will be used.
getPrecacheSize
()

Figure out the size of the precache.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public int
intValue()

Implements abstract java.lang.Number.intValue.

Returns the value of the specified number as an int.
public long
longValue()

Implements abstract java.lang.Number.longValue.

Returns the value of the specified number as a long.
private static final UInteger[]

Returns:

Array of cached values for UInteger
mkValues
()

Generate a cached value for initial unsigned integer values.

private static long

Returns:

value if it is in range
rangeCheck
(long
Value to check
value
)

Throw exception if value out of range (long version)

private Object

Returns:

cached instance of this object's value if one exists, otherwise this object
readResolve
()

Replace version read through deserialization with cached version.

public UInteger
subtract(final UInteger val)

public UInteger
subtract(final int val)

public BigInteger
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public static UInteger
valueOf(String value)

Create an unsigned int

public static UInteger
valueOf(int value)

Create an unsigned int by masking it with 0xFFFFFFFF i.e. (int) -1 becomes (uint) 4294967295

public static UInteger
valueOf(long value)

Create an unsigned int

private static UInteger
valueOfUnchecked(long value)

Get the value of a long without checking the value.

Field Detail

CLASSback to summary
private static final Class<UInteger> CLASS
CLASS_NAMEback to summary
private static final String CLASS_NAME
DEFAULT_PRECACHE_SIZEback to summary
private static final int DEFAULT_PRECACHE_SIZE

Default size for the value cache.

MAXback to summary
public static final UInteger MAX

A constant holding the maximum value an unsigned int can have as UInteger, 232-1.

MAX_VALUEback to summary
public static final long MAX_VALUE

A constant holding the maximum value an unsigned int can have, 232-1.

MINback to summary
public static final UInteger MIN

A constant holding the minimum value an unsigned int can have as UInteger, 0.

MIN_VALUEback to summary
public static final long MIN_VALUE

A constant holding the minimum value an unsigned int can have, 0.

PRECACHE_PROPERTYback to summary
private static final String PRECACHE_PROPERTY

System property name for the property to set the size of the pre-cache.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.jooq.types.UNumber.serialVersionUID.

Generated UID

valueback to summary
private final long value

The value modelling the content of this unsigned int

VALUESback to summary
private static final UInteger[] VALUES

Cached values

Constructor Detail

UIntegerback to summary
private UInteger(long value, boolean unused)

Unchecked internal constructor. This serves two purposes: first it allows UInteger(long) to stay deprecated without warnings and second constructor without unnecessary value checks.

Parameters
value:long

The value to wrap

unused:boolean

Unused parameter to distinguish between this and the deprecated public constructor.

UIntegerback to summary
private UInteger(long value) throws NumberFormatException

Create an unsigned int

Exceptions
NumberFormatException:
If value is not in the range of an unsigned int
UIntegerback to summary
private UInteger(int value)

Create an unsigned int by masking it with 0xFFFFFFFF i.e. (int) -1 becomes (uint) 4294967295

UIntegerback to summary
private UInteger(String value) throws NumberFormatException

Create an unsigned int

Exceptions
NumberFormatException:
If value does not contain a parsable unsigned int.

Method Detail

addback to summary
public UInteger add(final UInteger val)
addback to summary
public UInteger add(final int val)
compareToback to summary
public int compareTo(UInteger o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
o:UInteger

the object to be compared.

Returns:int

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

Annotations
@Override
doubleValueback to summary
public double doubleValue()

Implements abstract java.lang.Number.doubleValue.

Doc from java.lang.Number.doubleValue.

Returns the value of the specified number as a double.

Returns:double

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

Annotations
@Override
equalsback 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
floatValueback to summary
public float floatValue()

Implements abstract java.lang.Number.floatValue.

Doc from java.lang.Number.floatValue.

Returns the value of the specified number as a float.

Returns:float

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

Annotations
@Override
getCachedback to summary
private static UInteger getCached(long value)

Retrieve a cached value.

Parameters
value:long

Cached value to retrieve

Returns:UInteger

Cached value if one exists. Null otherwise.

getPrecacheSizeback to summary
private static final int getPrecacheSize()

Figure out the size of the precache.

Returns:int

The parsed value of the system property PRECACHE_PROPERTY or DEFAULT_PRECACHE_SIZE if the property is not set, not a number or retrieving results in a SecurityException. If the parsed value is zero or negative no cache will be created. If the value is larger than Integer#MAX_VALUE then Integer#MAX_VALUE will be used.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the 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
intValueback to summary
public int intValue()

Implements abstract java.lang.Number.intValue.

Doc from java.lang.Number.intValue.

Returns the value of the specified number as an int.

Returns:int

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

Annotations
@Override
longValueback to summary
public long longValue()

Implements abstract java.lang.Number.longValue.

Doc from java.lang.Number.longValue.

Returns the value of the specified number as a long.

Returns:long

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

Annotations
@Override
mkValuesback to summary
private static final UInteger[] mkValues()

Generate a cached value for initial unsigned integer values.

Returns:UInteger[]

Array of cached values for UInteger

rangeCheckback to summary
private static long rangeCheck(long value) throws NumberFormatException

Throw exception if value out of range (long version)

Parameters
value:long

Value to check

Returns:long

value if it is in range

Exceptions
NumberFormatException:
if value is out of range
readResolveback to summary
private Object readResolve() throws ObjectStreamException

Replace version read through deserialization with cached version.

Returns:Object

cached instance of this object's value if one exists, otherwise this object

subtractback to summary
public UInteger subtract(final UInteger val)
subtractback to summary
public UInteger subtract(final int val)
toBigIntegerback to summary
public BigInteger toBigInteger()

Overrides org.jooq.types.UNumber.toBigInteger.

Doc from org.jooq.types.UNumber.toBigInteger.

Get this number as a BigInteger. This is a convenience method for calling new BigInteger(toString())

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
valueOfback to summary
public static UInteger valueOf(String value) throws NumberFormatException

Create an unsigned int

Exceptions
NumberFormatException:
If value does not contain a parsable unsigned int.
valueOfback to summary
public static UInteger valueOf(int value)

Create an unsigned int by masking it with 0xFFFFFFFF i.e. (int) -1 becomes (uint) 4294967295

valueOfback to summary
public static UInteger valueOf(long value) throws NumberFormatException

Create an unsigned int

Exceptions
NumberFormatException:
If value is not in the range of an unsigned byte
valueOfUncheckedback to summary
private static UInteger valueOfUnchecked(long value)

Get the value of a long without checking the value.