net.sourceforge.juint
Class UInt8

java.lang.Object
  extended by java.lang.Number
      extended by net.sourceforge.juint.UInt8
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable, Bitwise<UInt8>

public class UInt8
extends java.lang.Number
implements java.io.Serializable, java.lang.Comparable, Bitwise<UInt8>

Unsigned 8-bit integer.

See Also:
Serialized Form

Field Summary
static short MAX_VALUE
          The largest possible value.
static short MIN_VALUE
          The smallest possible value.
 
Constructor Summary
UInt8(byte bite)
          Creates a new instance from a byte.
UInt8(int bite)
          Creates a new instance from an int.
UInt8(long bite)
          Creates a new instance from a long.
UInt8(short bite)
          Creates a new instance from a short.
 
Method Summary
 UInt8 addBitmask(UInt8 bitmask)
          Sets the bits in the given bitmask.
 UInt8 and(UInt8 number)
          Logical and.
 int compareTo(java.lang.Object object)
          Compares this UInt8 to another UInt8 for order.
 double doubleValue()
          Gets the value as a double.
 boolean equals(java.lang.Object object)
          Compares this UInt8 to anoter UInt8 for equality.
 float floatValue()
          Gets the value as a float.
 boolean hasBitmask(UInt8 bitmask)
          Determines if this number has the given bitmask.
 int hashCode()
          Gets the hash code.
 int intValue()
          Gets the value as an int.
 long longValue()
          Gets the value as a long.
 UInt8 not()
          Logical not.
 UInt8 or(UInt8 number)
          Logical or.
 UInt8 removeBitmask(UInt8 bitmask)
          Unsets the bits in the given bitmask.
 short shortValue()
          Gets the value as a short.
 java.lang.String toString()
          Gets the value as a String.
 short uint8Value()
          Gets the value as an unsigned 8-bit integer.
 UInt8 xor(UInt8 number)
          Logical xor.
 
Methods inherited from class java.lang.Number
byteValue
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

MAX_VALUE

public static final short MAX_VALUE
The largest possible value.

255

See Also:
Constant Field Values

MIN_VALUE

public static final short MIN_VALUE
The smallest possible value.

0

See Also:
Constant Field Values
Constructor Detail

UInt8

public UInt8(byte bite)
Creates a new instance from a byte.

Parameters:
bite - the value to be represented

UInt8

public UInt8(short bite)
Creates a new instance from a short.

Parameters:
bite - the value to be represented

UInt8

public UInt8(int bite)
Creates a new instance from an int.

Parameters:
bite - the value to be represented

UInt8

public UInt8(long bite)
Creates a new instance from a long.

Parameters:
bite - the value to be represented
Method Detail

uint8Value

public short uint8Value()
Gets the value as an unsigned 8-bit integer.

Returns:
the value as an unsigned 8-bit integer

shortValue

public short shortValue()
Gets the value as a short.

Overrides:
shortValue in class java.lang.Number
Returns:
the value as a short

intValue

public int intValue()
Gets the value as an int.

Specified by:
intValue in class java.lang.Number
Returns:
the value as an int

longValue

public long longValue()
Gets the value as a long.

Specified by:
longValue in class java.lang.Number
Returns:
the value as a long

floatValue

public float floatValue()
Gets the value as a float.

Specified by:
floatValue in class java.lang.Number
Returns:
the value as a float

doubleValue

public double doubleValue()
Gets the value as a double.

Specified by:
doubleValue in class java.lang.Number
Returns:
the value as a double

compareTo

public int compareTo(java.lang.Object object)
Compares this UInt8 to another UInt8 for order.

Specified by:
compareTo in interface java.lang.Comparable
Parameters:
object - a UInt8

equals

public boolean equals(java.lang.Object object)
Compares this UInt8 to anoter UInt8 for equality.

Overrides:
equals in class java.lang.Object
Parameters:
object - a UInt8

hashCode

public int hashCode()
Gets the hash code. The result is the value returned from intValue().

Overrides:
hashCode in class java.lang.Object
Returns:
the hash code

toString

public java.lang.String toString()
Gets the value as a String.

Overrides:
toString in class java.lang.Object
Returns:
the value as a String

and

public UInt8 and(UInt8 number)
Description copied from interface: Bitwise
Logical and.

Specified by:
and in interface Bitwise<UInt8>
Returns:
the result of the and

not

public UInt8 not()
Description copied from interface: Bitwise
Logical not.

Specified by:
not in interface Bitwise<UInt8>
Returns:
the result of the not

or

public UInt8 or(UInt8 number)
Description copied from interface: Bitwise
Logical or.

Specified by:
or in interface Bitwise<UInt8>
Returns:
the result of the or

xor

public UInt8 xor(UInt8 number)
Description copied from interface: Bitwise
Logical xor.

Specified by:
xor in interface Bitwise<UInt8>
Returns:
the result of the xor

addBitmask

public UInt8 addBitmask(UInt8 bitmask)
Description copied from interface: Bitwise
Sets the bits in the given bitmask.

Specified by:
addBitmask in interface Bitwise<UInt8>
Returns:
the number with the bits set

hasBitmask

public boolean hasBitmask(UInt8 bitmask)
Description copied from interface: Bitwise
Determines if this number has the given bitmask.

Specified by:
hasBitmask in interface Bitwise<UInt8>
Returns:
true if the number has the bitmask; false otherwise

removeBitmask

public UInt8 removeBitmask(UInt8 bitmask)
Description copied from interface: Bitwise
Unsets the bits in the given bitmask.

Specified by:
removeBitmask in interface Bitwise<UInt8>
Returns:
the number with the bits unset