Package org.apache.qpid.protonj2.types

Class UnsignedInteger

java.lang.Object

java.lang.Number

org.apache.qpid.protonj2.types.UnsignedInteger

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<UnsignedInteger>

public final class UnsignedInteger
extends java.lang.Number
implements java.lang.Comparable<UnsignedInteger>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static UnsignedInteger	MAX_VALUE
static UnsignedInteger	ONE
static UnsignedInteger	ZERO

Constructor Summary

Constructors

Constructor	Description
UnsignedInteger(int underlying)

Method Summary

Modifier and Type	Method	Description
UnsignedInteger	add(UnsignedInteger value)	Adds the value of the given UnsignedInteger to this instance and return a new UnsignedInteger instance that represents the newly computed value.
static int	compare(int left, int right)	Compares two integer values numerically treating the values as unsigned.
static int	compare(long left, long right)	Compares two long values numerically treating the values as unsigned.
int	compareTo(int value)	Compares the give integer value to this unsigned integer numerically treating the given value as unsigned.
int	compareTo(long value)	Compares the give long value to this unsigned integer numerically treating the given value as unsigned.
int	compareTo(UnsignedInteger value)
double	doubleValue()
boolean	equals(java.lang.Object o)
float	floatValue()
int	hashCode()
int	intValue()
long	longValue()
UnsignedInteger	subtract(UnsignedInteger value)	Subtract the value of the given UnsignedInteger from this instance and return a new UnsignedInteger instance that represents the newly computed value.
java.lang.String	toString()
static long	toUnsignedLong(int value)	Returns a long that represents the unsigned view of the given int value.
static UnsignedInteger	valueOf(int value)	Returns an UnsignedInteger instance representing the specified int value.
static UnsignedInteger	valueOf(long value)	Returns an UnsignedInteger instance representing the specified long value.
static UnsignedInteger	valueOf(java.lang.String value)	Returns an UnsignedInteger instance representing the specified String value.

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ZERO

public static final UnsignedInteger ZERO

ONE

public static final UnsignedInteger ONE

MAX_VALUE

public static final UnsignedInteger MAX_VALUE

Constructor Detail

UnsignedInteger

public UnsignedInteger(int underlying)

Method Detail

intValue

public int intValue()

Specified by:

intValue in class java.lang.Number

longValue

public long longValue()

Specified by:

longValue in class java.lang.Number

floatValue

public float floatValue()

Specified by:

floatValue in class java.lang.Number

doubleValue

public double doubleValue()

Specified by:

doubleValue in class java.lang.Number

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(int value)

Compares the give integer value to this unsigned integer numerically treating the given value as unsigned.

Parameters:

value - the integer to compare to this unsigned integer instance.

Returns:

the value 0 if this == value; a value less than 0 if this < value as unsigned values; and a value greater than 0 if this > value as unsigned values

compareTo

public int compareTo(long value)

Compares the give long value to this unsigned integer numerically treating the given value as unsigned.

Parameters:

value - the long to compare to this unsigned integer instance.

Returns:

the value 0 if this == value; a value less than 0 if this < value as unsigned values; and a value greater than 0 if this > value as unsigned values

compareTo

public int compareTo(UnsignedInteger value)

Specified by:

compareTo in interface java.lang.Comparable<UnsignedInteger>

compare

public static int compare(int left,
                          int right)

Compares two integer values numerically treating the values as unsigned.

Parameters:

left - the left hand side integer to compare

right - the right hand side integer to compare

Returns:

the value 0 if left == right; a value less than 0 if left < right as unsigned values; and a value greater than 0 if left > right as unsigned values

compare

public static int compare(long left,
                          long right)

Compares two long values numerically treating the values as unsigned.

Parameters:

left - the left hand side long value to compare

right - the right hand side long value to compare

Returns:

the value 0 if left == right; a value less than 0 if left < right as unsigned values; and a value greater than 0 if left > right as unsigned values

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

valueOf

public static UnsignedInteger valueOf(int value)

Returns an UnsignedInteger instance representing the specified int value. This method always returns a cached UnsignedInteger instance for values in the range [0...255] which can save space and time over calling the constructor UnsignedInteger(int) which will always create a new instance of the UnsignedInteger type.

Parameters:

value - The int value to return as an UnsignedInteger instance.

Returns:

an UnsignedInteger instance representing the unsigned view of the given int.

add

public UnsignedInteger add(UnsignedInteger value)

Adds the value of the given UnsignedInteger to this instance and return a new UnsignedInteger instance that represents the newly computed value.

Parameters:

value - The UnsignedInteger whose underlying value should be added to this instance's value.

Returns:

a new immutable UnsignedInteger resulting from the addition of this with the given value.

subtract

public UnsignedInteger subtract(UnsignedInteger value)

Subtract the value of the given UnsignedInteger from this instance and return a new UnsignedInteger instance that represents the newly computed value.

Parameters:

value - The UnsignedInteger whose underlying value should be subtracted to this instance's value.

Returns:

a new immutable UnsignedInteger resulting from the subtraction the given value from this.

valueOf

public static UnsignedInteger valueOf(java.lang.String value)

Returns an UnsignedInteger instance representing the specified String value. This method always returns a cached UnsignedInteger instance for values in the range [0...255] which can save space and time over calling the constructor UnsignedInteger(int) which will always create a new instance of the UnsignedInteger type.

Parameters:

value - The String value to return as an UnsignedInteger instance.

Returns:

an UnsignedInteger instance representing the unsigned view of the given String.

Throws:

java.lang.NumberFormatException - if the given value is greater than the max UnsignedInteger value possible or the String value given cannot be converted to a numeric value.

valueOf

public static UnsignedInteger valueOf(long value)

Returns an UnsignedInteger instance representing the specified long value. This method always returns a cached UnsignedInteger instance for values in the range [0...255] which can save space and time over calling the constructor UnsignedInteger(int) which will always create a new instance of the UnsignedInteger type.

Parameters:

value - The long value to return as an UnsignedInteger instance.

Returns:

an UnsignedInteger instance representing the unsigned view of the given long.

Throws:

java.lang.NumberFormatException - if the given value is greater than the max UnsignedInteger value possible.

toUnsignedLong

public static long toUnsignedLong(int value)

Returns a long that represents the unsigned view of the given int value.

Parameters:

value - The integer whose unsigned value should be converted to a long.

Returns:

a positive long value that represents the given int as unsigned.