Package org.apache.qpid.protonj2.types
Class UnsignedInteger
- java.lang.Object
-
- java.lang.Number
-
- org.apache.qpid.protonj2.types.UnsignedInteger
-
- All Implemented Interfaces:
Serializable
,Comparable<UnsignedInteger>
public final class UnsignedInteger extends Number implements 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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description UnsignedInteger
add(UnsignedInteger value)
Adds the value of the givenUnsignedInteger
to this instance and return a newUnsignedInteger
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(Object o)
float
floatValue()
int
hashCode()
int
intValue()
long
longValue()
UnsignedInteger
subtract(UnsignedInteger value)
Subtract the value of the givenUnsignedInteger
from this instance and return a newUnsignedInteger
instance that represents the newly computed value.String
toString()
static long
toUnsignedLong(int value)
Returns along
that represents the unsigned view of the givenint
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(String value)
Returns anUnsignedInteger
instance representing the specifiedString
value.-
Methods inherited from class java.lang.Number
byteValue, shortValue
-
-
-
-
Field Detail
-
ZERO
public static final UnsignedInteger ZERO
-
ONE
public static final UnsignedInteger ONE
-
MAX_VALUE
public static final UnsignedInteger MAX_VALUE
-
-
Method Detail
-
floatValue
public float floatValue()
- Specified by:
floatValue
in classNumber
-
doubleValue
public double doubleValue()
- Specified by:
doubleValue
in classNumber
-
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 interfaceComparable<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 compareright
- 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 compareright
- 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
-
valueOf
public static UnsignedInteger valueOf(int value)
Returns an UnsignedInteger instance representing the specified int value. This method always returns a cachedUnsignedInteger
instance for values in the range [0...255] which can save space and time over calling the constructorUnsignedInteger(int)
which will always create a new instance of theUnsignedInteger
type.- Parameters:
value
- The int value to return as anUnsignedInteger
instance.- Returns:
- an
UnsignedInteger
instance representing the unsigned view of the given int.
-
add
public UnsignedInteger add(UnsignedInteger value)
Adds the value of the givenUnsignedInteger
to this instance and return a newUnsignedInteger
instance that represents the newly computed value.- Parameters:
value
- TheUnsignedInteger
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 givenUnsignedInteger
from this instance and return a newUnsignedInteger
instance that represents the newly computed value.- Parameters:
value
- TheUnsignedInteger
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(String value)
Returns anUnsignedInteger
instance representing the specifiedString
value. This method always returns a cachedUnsignedInteger
instance for values in the range [0...255] which can save space and time over calling the constructorUnsignedInteger(int)
which will always create a new instance of theUnsignedInteger
type.- Parameters:
value
- The String value to return as anUnsignedInteger
instance.- Returns:
- an
UnsignedInteger
instance representing the unsigned view of the given String. - Throws:
NumberFormatException
- if the given value is greater than the maxUnsignedInteger
value possible or theString
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 cachedUnsignedInteger
instance for values in the range [0...255] which can save space and time over calling the constructorUnsignedInteger(int)
which will always create a new instance of theUnsignedInteger
type.- Parameters:
value
- The long value to return as anUnsignedInteger
instance.- Returns:
- an
UnsignedInteger
instance representing the unsigned view of the given long. - Throws:
NumberFormatException
- if the given value is greater than the maxUnsignedInteger
value possible.
-
toUnsignedLong
public static long toUnsignedLong(int value)
Returns along
that represents the unsigned view of the givenint
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.
-
-