Module de.bernd_michaely.x3f.types

Package de.bernd_michaely.x3f.types

Class UnsignedInteger

java.lang.Object

java.lang.Number

de.bernd_michaely.x3f.types.UnsignedInteger

All Implemented Interfaces:

Serializable, Comparable<UnsignedInteger>

Direct Known Subclasses:

UInt32

public class UnsignedInteger
extends Number
implements Comparable<UnsignedInteger>

Class for representing and handling of unsigned 32 Bit integer values.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	uint32

Constructor Summary

Constructors

Constructor	Description
UnsignedInteger()	Initializes this unsigned integer with a value of zero.
UnsignedInteger(int value)	Initializes this unsigned integer with a given value.

Method Summary

Modifier and Type	Method	Description
byte	byteValue()	This method gets the low 7 bits and returns them as byte.
int	compareTo(UnsignedInteger otherValue)
double	doubleValue()
boolean	equals(Object obj)
float	floatValue()
int	get16BitHigh()	Gets the high 16 bits and returns them as integer.
int	get16BitLow()	Gets the low 16 bits and returns them as integer.
String	getAsBitString()	Returns this value in a bit representation.
byte[]	getAsByteArray()	Return this 32 bit value as little-endian four byte array.
int	getByte(int index)	Returns the unsigned byte at the given index.
int	getUnsignedByteValue()	Gets the lowest unsigned byte and returns it as integer.
int	hashCode()
int	intValue()	This method gets the low 31 bits and returns them as integer.
long	longValue()	Returns this value as long integer.
short	shortValue()	This method gets the low 15 bits and returns them as short.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

uint32

protected int uint32

Constructor Detail

UnsignedInteger

public UnsignedInteger()

Initializes this unsigned integer with a value of zero.

UnsignedInteger

public UnsignedInteger(int value)

Initializes this unsigned integer with a given value.

Parameters:

value - a given initialization value

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(UnsignedInteger otherValue)

Specified by:

compareTo in interface Comparable<UnsignedInteger>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

longValue

public long longValue()

Returns this value as long integer. The return value will be in the range of [0..2³²-1]. Note that this is the only method to return this value as an integral value without loss of the magnitude of the original 32 bit unsigned integer.

Specified by:

longValue in class Number

Returns:

this value as long integer

intValue

public int intValue()

This method gets the low 31 bits and returns them as integer. That is the value will be in the range of [0..2³¹-1]. Note, that the value to hold is a 32 bit unsigned integer, but the return type is a 32 bit signed integer. So if the highest bit is expected to be set in this value, use the longValue() method instead.

Specified by:

intValue in class Number

Returns:

this value as integer

shortValue

public short shortValue()

This method gets the low 15 bits and returns them as short. That is the value will be in the range of [0..2¹⁵-1].

Overrides:

shortValue in class Number

Returns:

the low 15 bits as short

byteValue

public byte byteValue()

This method gets the low 7 bits and returns them as byte. That is the value will be in the range of [0..2⁷-1].

Overrides:

byteValue in class Number

Returns:

the low 7 bits as byte

floatValue

public float floatValue()

Specified by:

floatValue in class Number

doubleValue

public double doubleValue()

Specified by:

doubleValue in class Number

getByte

public int getByte(int index)

Returns the unsigned byte at the given index. That is the return value will be in the range of [0..2⁸-1].

Parameters:

index - the byte index, valid values are [0..3], 0 returns the least significant byte

Returns:

the unsigned byte at the given index as int

Throws:

IllegalArgumentException - if index is invalid

getAsByteArray

public byte[] getAsByteArray()

Return this 32 bit value as little-endian four byte array.

Returns:

this 32 bit value as little-endian four byte array

Since:

2.0

getUnsignedByteValue

public int getUnsignedByteValue()

Gets the lowest unsigned byte and returns it as integer. That is the value will be in the range of [0..2⁸-1].

Returns:

the lowest unsigned byte

get16BitHigh

public int get16BitHigh()

Gets the high 16 bits and returns them as integer. That is the value will be in the range of [0..2¹⁶-1].

Returns:

the high 16 bits as integer

get16BitLow

public int get16BitLow()

Gets the low 16 bits and returns them as integer. That is the value will be in the range of [0..2¹⁶-1].

Returns:

the low 16 bits as integer

getAsBitString

public String getAsBitString()

Returns this value in a bit representation. This bits are written from the most to the least significant bit: "76543210 76543210 76543210 76543210":

Returns:

this value as a binary string