Top Description Fields Constructors Methods
org.jooq.types

public final Class UByte

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

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

Field Summary

Modifier and TypeField and Description
public static final UByte
MAX

A constant holding the maximum value an unsigned byte can have as UByte, 28-1.

public static final short
MAX_VALUE

A constant holding the maximum value an unsigned byte can have, 28-1.

public static final UByte
MIN

A constant holding the minimum value an unsigned byte can have as UByte, 0.

public static final short
MIN_VALUE

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

private static final long
private final short
value

The value modelling the content of this unsigned byte

private static final UByte[]
VALUES

Cached values

Constructor Summary

AccessConstructor and Description
private
UByte(long value)

Create an unsigned byte

private
UByte(int value)

Create an unsigned byte

private
UByte(short value)

Create an unsigned byte

private
UByte(byte value)

Create an unsigned byte by masking it with 0xFF i.e. (byte) -1 becomes (ubyte) 255

private
UByte(String value)

Create an unsigned byte

Method Summary

Modifier and TypeMethod and Description
public UByte
add(UByte val)

public UByte
add(int val)

public int
compareTo(UByte
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.
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 UByte[]

Returns:

Array of cached values for UByte.
mkValues
()

Generate a cached value for each byte value.

private static short

Returns:

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

Throw exception if value out of range (short version)

private static short

Returns:

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

Throw exception if value out of range (int version)

private static short

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
readResolve
()

Replace version read through deserialization with cached version.

public UByte
subtract(final UByte val)

public UByte
subtract(final int val)

public BigInteger
public String
toString()

Overrides java.lang.Object.toString.

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

Get an instance of an unsigned byte

public static UByte
valueOf(byte value)

Get an instance of an unsigned byte by masking it with 0xFF i.e. (byte) -1 becomes (ubyte) 255

public static UByte
valueOf(short value)

Get an instance of an unsigned byte

public static UByte
valueOf(int value)

Get an instance of an unsigned byte

public static UByte
valueOf(long value)

Get an instance of an unsigned byte

private static UByte
valueOfUnchecked(short value)

Get the value of a short without checking the value.

Field Detail

MAXback to summary
public static final UByte MAX

A constant holding the maximum value an unsigned byte can have as UByte, 28-1.

MAX_VALUEback to summary
public static final short MAX_VALUE

A constant holding the maximum value an unsigned byte can have, 28-1.

MINback to summary
public static final UByte MIN

A constant holding the minimum value an unsigned byte can have as UByte, 0.

MIN_VALUEback to summary
public static final short MIN_VALUE

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

serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.jooq.types.UNumber.serialVersionUID.

Generated UID

valueback to summary
private final short value

The value modelling the content of this unsigned byte

VALUESback to summary
private static final UByte[] VALUES

Cached values

Constructor Detail

UByteback to summary
private UByte(long value) throws NumberFormatException

Create an unsigned byte

Exceptions
NumberFormatException:
If value is not in the range of an unsigned byte
UByteback to summary
private UByte(int value) throws NumberFormatException

Create an unsigned byte

Exceptions
NumberFormatException:
If value is not in the range of an unsigned byte
UByteback to summary
private UByte(short value) throws NumberFormatException

Create an unsigned byte

Exceptions
NumberFormatException:
If value is not in the range of an unsigned byte
UByteback to summary
private UByte(byte value)

Create an unsigned byte by masking it with 0xFF i.e. (byte) -1 becomes (ubyte) 255

UByteback to summary
private UByte(String value) throws NumberFormatException

Create an unsigned byte

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

Method Detail

addback to summary
public UByte add(UByte val) throws NumberFormatException
addback to summary
public UByte add(int val) throws NumberFormatException
compareToback to summary
public int compareTo(UByte 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:UByte

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
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 UByte[] mkValues()

Generate a cached value for each byte value.

Returns:UByte[]

Array of cached values for UByte.

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

Throw exception if value out of range (short version)

Parameters
value:short

Value to check

Returns:short

value if it is in range

Exceptions
NumberFormatException:
if value is out of range
rangeCheckback to summary
private static short rangeCheck(int value) throws NumberFormatException

Throw exception if value out of range (int version)

Parameters
value:int

Value to check

Returns:short

value if it is in range

Exceptions
NumberFormatException:
if value is out of range
rangeCheckback to summary
private static short rangeCheck(long value) throws NumberFormatException

Throw exception if value out of range (long version)

Parameters
value:long

Value to check

Returns:short

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. Note that this does not use the valueOfUnchecked(short) as we have no guarantee that the value from the stream is valid.

Returns:Object

cached instance of this object's value

subtractback to summary
public UByte subtract(final UByte val)
subtractback to summary
public UByte 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 UByte valueOf(String value) throws NumberFormatException

Get an instance of an unsigned byte

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

Get an instance of an unsigned byte by masking it with 0xFF i.e. (byte) -1 becomes (ubyte) 255

valueOfback to summary
public static UByte valueOf(short value) throws NumberFormatException

Get an instance of an unsigned byte

Exceptions
NumberFormatException:
If value is not in the range of an unsigned byte
valueOfback to summary
public static UByte valueOf(int value) throws NumberFormatException

Get an instance of an unsigned byte

Exceptions
NumberFormatException:
If value is not in the range of an unsigned byte
valueOfback to summary
public static UByte valueOf(long value) throws NumberFormatException

Get an instance of an unsigned byte

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

Get the value of a short without checking the value.