Package me.olhalvo.unum.types

Class UByte

java.lang.Object

java.lang.Number

me.olhalvo.unum.types.UNumber

me.olhalvo.unum.types.UByte

All Implemented Interfaces:

Serializable, Comparable<Number>

Direct Known Subclasses:

UByteO

public class UByte
extends UNumber
implements Comparable<Number>

Class used to represent an unsigned byte (0 to 255)

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final short	MAX_VALUE	The maximum value an UByte can have (255)
static final short	MIN_VALUE	The minimum value an UByte can have (0)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UByte(byte value)
protected	UByte(int value)
protected	UByte(long value)
protected	UByte(short value)

Method Summary

Modifier and Type	Method	Description
<T extends Number> UByte	add(T b)	Adds the given number to this UByte and returns a new UByte with the result
<T extends Number> UByte	and(T b)	Performs a bitwise AND operation between this UByte and the given number, returning a new UByte with the result
UByteO	asOverflow()
<T extends Number> UByte	divide(T b)	Divides this Ubyte by the passed number and returns a new UByte with the result
double	doubleValue()	see Number.doubleValue()
boolean	equals(Object obj)	Checks equality between this UByte and another object
float	floatValue()	see Number.floatValue()
int	hashCode()
int	intValue()	see Number.intValue()
long	longValue()	see Number.longValue()
UByte	lsl(int n)	Performs a logical left shift operation on this UByte
UByte	lsr(int n)	Performs a logical right shift operation on this UByte
<T extends Number> UByte	multiply(T b)	Multiplies this Ubyte by the passed number and returns a new UByte with the result
protected UByte	newInstance(byte value)	Protected methods to be used so that arithmetic methods can have similar behaviour in overflow classes
protected UByte	newInstance(int value)	Protected methods to be used so that arithmetic methods can have similar behaviour in overflow classes
protected UByte	newInstance(long value)	Protected methods to be used so that arithmetic methods can have similar behaviour in overflow classes
protected UByte	newInstance(short value)	Protected methods to be used so that arithmetic methods can have similar behaviour in overflow classes
UByte	not()	Performs a bitwise NOT operation on this UByte
<T extends Number> UByte	or(T b)	Performs a bitwise OR operation between this UByte and the given number, returning a new UByte with the result
<T extends Number> UByte	remainder(T b)	Calculates the remainder of this Ubyte divided by the passed number and returns a new UByte with the result
<T extends Number> UByte	subtract(T b)	Subtracts the given number to this UByte and returns a new UByte with the result
String	toString()	see Byte.compareTo(Byte)
static UByte	valueOf(byte value)	see: valueOf(short)
static UByte	valueOf(int value)	see: valueOf(short)
static UByte	valueOf(long value)	see: valueOf(short)
static UByte	valueOf(short value)	Returns a UByte instance representing the specified value
static UByte	valueOf(String value)	see: valueOf(short)
<T extends Number> UByte	xor(T b)	Performs a bitwise XOR operation between this UByte and the given number, returning a new UByte with the result

Methods inherited from class me.olhalvo.unum.types.UNumber

compareTo

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Field Details

MIN_VALUE

public static final short MIN_VALUE

The minimum value an UByte can have (0)

See Also:

• MAX_VALUE
• Constant Field Values

MAX_VALUE

public static final short MAX_VALUE

The maximum value an UByte can have (255)

See Also:

• MIN_VALUE
• Constant Field Values

Constructor Details

UByte

protected UByte(short value)
         throws OutOfUnsignedRangeException

Throws:

OutOfUnsignedRangeException

UByte

protected UByte(byte value)

UByte

protected UByte(long value)
         throws OutOfUnsignedRangeException

Throws:

OutOfUnsignedRangeException

UByte

protected UByte(int value)
         throws OutOfUnsignedRangeException

Throws:

OutOfUnsignedRangeException

Method Details

valueOf

public static UByte valueOf(short value)
                     throws OutOfUnsignedRangeException

Returns a UByte instance representing the specified value

Parameters:

value - the value to represent

Returns:

a UByte instance representing the specified value

Throws:

OutOfUnsignedRangeException - if the value is out of range(MIN_VALUE to MAX_VALUE)

See Also:

• MIN_VALUE
• MAX_VALUE
• valueOf(byte)
• valueOf(int)
• valueOf(long)
• valueOf(String)

valueOf

public static UByte valueOf(byte value)

see: valueOf(short)

valueOf

public static UByte valueOf(long value)
                     throws OutOfUnsignedRangeException

see: valueOf(short)

Throws:

OutOfUnsignedRangeException

valueOf

public static UByte valueOf(int value)
                     throws OutOfUnsignedRangeException

see: valueOf(short)

Throws:

OutOfUnsignedRangeException

valueOf

public static UByte valueOf(String value)
                     throws OutOfUnsignedRangeException

see: valueOf(short)

Throws:

OutOfUnsignedRangeException

newInstance

protected UByte newInstance(byte value)
                     throws OutOfUnsignedRangeException

Protected methods to be used so that arithmetic methods can have similar behaviour in overflow classes

Throws:

OutOfUnsignedRangeException

See Also:

• valueOf(byte)

newInstance

protected UByte newInstance(short value)
                     throws OutOfUnsignedRangeException

Protected methods to be used so that arithmetic methods can have similar behaviour in overflow classes

Throws:

OutOfUnsignedRangeException

See Also:

• valueOf(short)

newInstance

protected UByte newInstance(int value)
                     throws OutOfUnsignedRangeException

Protected methods to be used so that arithmetic methods can have similar behaviour in overflow classes

Throws:

OutOfUnsignedRangeException

See Also:

• valueOf(int)

newInstance

protected UByte newInstance(long value)
                     throws OutOfUnsignedRangeException

Protected methods to be used so that arithmetic methods can have similar behaviour in overflow classes

Throws:

OutOfUnsignedRangeException

See Also:

• valueOf(long)

intValue

public int intValue()

see Number.intValue()

Specified by:

intValue in class Number

longValue

public long longValue()

see Number.longValue()

Specified by:

longValue in class Number

floatValue

public float floatValue()

see Number.floatValue()

Specified by:

floatValue in class Number

doubleValue

public double doubleValue()

see Number.doubleValue()

Specified by:

doubleValue in class Number

toString

public String toString()

see Byte.compareTo(Byte)

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Checks equality between this UByte and another object

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if the other object is either an exact copy of this or a Number with the same value as this UByte, otherwise false

hashCode

public int hashCode()

Overrides:

hashCode in class Object

add

public <T extends Number> UByte add(T b)
                             throws OutOfUnsignedRangeException

Adds the given number to this UByte and returns a new UByte with the result

Type Parameters:

T - the type of the number

Parameters:

b - the number to add

Returns:

a new UByte with the result

Throws:

OutOfUnsignedRangeException - if the result is out of range(MIN_VALUE to MAX_VALUE)

See Also:

• subtract(Number)
• multiply(Number)
• divide(Number)
• remainder(Number)

subtract

public <T extends Number> UByte subtract(T b)
                                  throws OutOfUnsignedRangeException

Subtracts the given number to this UByte and returns a new UByte with the result

Type Parameters:

T - the type of the number

Parameters:

b - the number to subtract

Returns:

a new UByte with the result

Throws:

OutOfUnsignedRangeException - if the result is out of range(MIN_VALUE to MAX_VALUE)

See Also:

• add(Number)
• multiply(Number)
• divide(Number)
• remainder(Number)

multiply

public <T extends Number> UByte multiply(T b)
                                  throws OutOfUnsignedRangeException

Multiplies this Ubyte by the passed number and returns a new UByte with the result

Type Parameters:

T - the type of the number

Parameters:

b - the number to multiply by

Returns:

a new UByte with the result

Throws:

OutOfUnsignedRangeException - if the result is out of range(MIN_VALUE to MAX_VALUE)

See Also:

• subtract(Number)
• add(Number)
• divide(Number)
• remainder(Number)

divide

public <T extends Number> UByte divide(T b)
                                throws OutOfUnsignedRangeException

Divides this Ubyte by the passed number and returns a new UByte with the result

Type Parameters:

T - the type of the number

Parameters:

b - the number to Divide by

Returns:

a new UByte with the result

Throws:

OutOfUnsignedRangeException - if the result is out of range(MIN_VALUE to MAX_VALUE)

See Also:

• subtract(Number)
• multiply(Number)
• add(Number)
• remainder(Number)

remainder

public <T extends Number> UByte remainder(T b)
                                   throws OutOfUnsignedRangeException

Calculates the remainder of this Ubyte divided by the passed number and returns a new UByte with the result

Type Parameters:

T - the type of the number

Parameters:

b - the number to divide by

Returns:

a new UByte with the result

Throws:

OutOfUnsignedRangeException - if the result is out of range(MIN_VALUE to MAX_VALUE)

See Also:

• subtract(Number)
• multiply(Number)
• divide(Number)
• add(Number)

and

public <T extends Number> UByte and(T b)

Performs a bitwise AND operation between this UByte and the given number, returning a new UByte with the result

Type Parameters:

T - the type of the number

Parameters:

b - the number to AND with

Returns:

a new UByte with the result

See Also:

• or(Number)
• xor(Number)
• not()
• lsl(int)
• lsr(int)

or

public <T extends Number> UByte or(T b)
                            throws OutOfUnsignedRangeException

Performs a bitwise OR operation between this UByte and the given number, returning a new UByte with the result

Type Parameters:

T - the type of the number

Parameters:

b - the number to OR with

Returns:

a new UByte with the result

Throws:

OutOfUnsignedRangeException - if the result is out of range(MIN_VALUE to MAX_VALUE)

See Also:

• and(Number)
• xor(Number)
• not()
• lsl(int)
• lsr(int)

xor

public <T extends Number> UByte xor(T b)
                             throws OutOfUnsignedRangeException

Performs a bitwise XOR operation between this UByte and the given number, returning a new UByte with the result

Type Parameters:

T - the type of the number

Parameters:

b - the number to XOR with

Returns:

a new UByte with the result

Throws:

OutOfUnsignedRangeException - if the result is out of range(MIN_VALUE to MAX_VALUE)

See Also:

• or(Number)
• and(Number)
• not()
• lsl(int)
• lsr(int)

not

public UByte not()

Performs a bitwise NOT operation on this UByte

Returns:

a new UByte with the result

See Also:

• or(Number)
• xor(Number)
• and(Number)
• lsl(int)
• lsr(int)

lsl

public UByte lsl(int n)

Performs a logical left shift operation on this UByte

Parameters:

n - the number of bits to shift

Returns:

a new UByte with the result

See Also:

• or(Number)
• xor(Number)
• not()
• and(Number)
• lsr(int)

lsr

public UByte lsr(int n)

Performs a logical right shift operation on this UByte

Parameters:

n - the number of bits to shift

Returns:

a new UByte with the result

See Also:

• or(Number)
• xor(Number)
• not()
• lsl(int)
• and(Number)

asOverflow

public UByteO asOverflow()