unsigned
Class uInt

java.lang.Object
  extended by unsigned.uInt

public class uInt
extends java.lang.Object

Written by Evangelos Haleplidis, e_halep at yahoo dot gr, and Sean R Owens, sean at guild dot net, released to the public domain. Share and enjoy. Since some people argue that it is impossible to release software to the public domain, you are also free to use this code under any version of the GPL, LPGL, or BSD licenses, or contact the authors for use of another license. The unsigned Integer Class.


Constructor Summary
uInt()
          Unsigned Int constructor with no value.
uInt(byte[] bytes, int offset)
          Unsigned Int constructor that gets an already read unsigned Integer that exists inside a Byte Array at position offset and converts it into the proper format for Java
uInt(java.nio.ByteBuffer bb, int offset)
          Unsigned Int constructor that read gets an already read unsigned Int that exists inside a ByteBuffer at position offset and converts it into the proper format for Java Caution, the position of the bytebuffer is not changed inside the constructor.
uInt(int unsigned)
          Unsigned Int constructor with an already read unsigned Int to be converted to Java format.
uInt(long tobecomeunsigned)
          Unsigned Int constructor with a value in Java format.
 
Method Summary
 long getValue()
          getValue returns the actual value of the unsigned int.
 void read(byte[] bytes, int offset)
          Read gets an already read unsigned Integer that exists inside a Byte Array at position offset and converts it into the proper format for Java
 void read(java.nio.ByteBuffer bb, int offset)
          Read gets an already read unsigned Integer that exists inside a ByteBuffer at position offset and converts it into the proper format for Java Caution, the position of the bytebuffer is not changed inside this read call.
 void read(int i)
          Read gets an already read unsigned Integer and converts it into the proper format for Java
 void setValue(long value)
          SetValue sets an int value.
 byte[] write()
          Write prepares the unsigned Int from Java format to be written into the proper unsigned format for the wire.
 boolean write(byte[] bytes, int offset)
          Write prepares the unsigned Int from Java format to be written into the proper unsigned format for the wire and puts it at a ByteArray at position equal to offset.
 boolean write(java.nio.ByteBuffer bb, int offset)
          Write prepares the unsigned Int from Java format to be written into the proper unsigned format for the wire and puts it at a ByteBuffer at position equal to offset.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

uInt

public uInt()
Unsigned Int constructor with no value.


uInt

public uInt(int unsigned)
Unsigned Int constructor with an already read unsigned Int to be converted to Java format.

Parameters:
unsigned - The already read unsigned Int that needs to be converted to Java format.

uInt

public uInt(long tobecomeunsigned)
Unsigned Int constructor with a value in Java format.

Parameters:
tobecomeunsigned - The value in javaformat.

uInt

public uInt(java.nio.ByteBuffer bb,
            int offset)
Unsigned Int constructor that read gets an already read unsigned Int that exists inside a ByteBuffer at position offset and converts it into the proper format for Java Caution, the position of the bytebuffer is not changed inside the constructor.

Parameters:
bb - The ByteBuffer in which the already read unsigned Int exists
offset - The position that the 4 bytes of the unsigned Int starts

uInt

public uInt(byte[] bytes,
            int offset)
Unsigned Int constructor that gets an already read unsigned Integer that exists inside a Byte Array at position offset and converts it into the proper format for Java

Parameters:
bytes - The byte array
offset - The position that the 4 bytes of the unsigned integer starts
Method Detail

read

public void read(int i)
Read gets an already read unsigned Integer and converts it into the proper format for Java

Parameters:
i - The read unsigned integer that needs to be converted to Java format.

read

public void read(java.nio.ByteBuffer bb,
                 int offset)
Read gets an already read unsigned Integer that exists inside a ByteBuffer at position offset and converts it into the proper format for Java Caution, the position of the bytebuffer is not changed inside this read call.

Parameters:
bb - The ByteBuffer in which the already read unsigned Integer exists
offset - The position that the 4 bytes of the unsigned integer starts

read

public void read(byte[] bytes,
                 int offset)
Read gets an already read unsigned Integer that exists inside a Byte Array at position offset and converts it into the proper format for Java

Parameters:
bytes - The byte array
offset - The position that the 4 bytes of the unsigned integer starts

write

public byte[] write()
Write prepares the unsigned Int from Java format to be written into the proper unsigned format for the wire.

Returns:
Returns the unsigned int in a byte[] format

write

public boolean write(java.nio.ByteBuffer bb,
                     int offset)
Write prepares the unsigned Int from Java format to be written into the proper unsigned format for the wire and puts it at a ByteBuffer at position equal to offset.

Parameters:
bb - The Bytebuffer to put the Unsigned Int
offset - The position to start putting the 4 bytes
Returns:
Returns true if the integer was written, false if the offset was wrong.

write

public boolean write(byte[] bytes,
                     int offset)
Write prepares the unsigned Int from Java format to be written into the proper unsigned format for the wire and puts it at a ByteArray at position equal to offset.

Parameters:
bytes - The Byte Array to put the Unsigned Int
offset - The position to start putting the 4 bytes
Returns:
Returns true if the integer was written, false if the offset was wrong.

getValue

public long getValue()
getValue returns the actual value of the unsigned int. Caution, returns a long int.

Returns:
Returns the actual value of the unsigned int, in long data type.

setValue

public void setValue(long value)
SetValue sets an int value.

Parameters:
value - The value.