unsigned
Class uShort

java.lang.Object
  extended by unsigned.uShort

public class uShort
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 Short Class.


Constructor Summary
uShort()
          Unsigned Short constructor with no value.
uShort(byte[] bytes, int offset)
          Unsigned Short 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
uShort(java.nio.ByteBuffer bb, int offset)
          Unsigned Short constructor that read gets an already read unsigned Short 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.
uShort(char tobecomeunsigned)
          Unsigned Short constructor with a value in Java format.
uShort(short unsigned)
          Unsigned Short constructor with an already read unsigned short to be converted to Java format.
 
Method Summary
 char getValue()
          getValue returns the actual value of the unsigned short.
 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 Short 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(short i)
          Read gets an already read unsigned Short and converts it into the proper format for Java
 void setValue(char value)
          SetValue sets a unSigned short value.
 byte[] write()
          WriteUnShort prepares the unsigned Shot from Java format to be written into the proper unsigned format for the wire.
 boolean write(byte[] bytes, int offset)
          Write prepares the unsigned Short 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 Short 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

uShort

public uShort()
Unsigned Short constructor with no value.


uShort

public uShort(short unsigned)
Unsigned Short constructor with an already read unsigned short to be converted to Java format.

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

uShort

public uShort(char tobecomeunsigned)
Unsigned Short constructor with a value in Java format.

Parameters:
tobecomeunsigned - The value in javaformat.

uShort

public uShort(java.nio.ByteBuffer bb,
              int offset)
Unsigned Short constructor that read gets an already read unsigned Short 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 Short exists
offset - The position that the 2 bytes of the unsigned Short starts

uShort

public uShort(byte[] bytes,
              int offset)
Unsigned Short 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 2 bytes of the unsigned integer starts
Method Detail

read

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

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

read

public void read(java.nio.ByteBuffer bb,
                 int offset)
Read gets an already read unsigned Short 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 Short exists
offset - The position that the 2 bytes of the unsigned Short 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 2 bytes of the unsigned integer starts

write

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

Returns:
Returns the unsigned short in a byte Array format

write

public boolean write(java.nio.ByteBuffer bb,
                     int offset)
Write prepares the unsigned Short 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 Short
offset - The position to start putting the 2 bytes
Returns:
Returns true if the short was written, false if the offset was wrong.

write

public boolean write(byte[] bytes,
                     int offset)
Write prepares the unsigned Short 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 Short
offset - The position to start putting the 2 bytes
Returns:
Returns true if the short was written, false if the offset was wrong.

getValue

public char getValue()
getValue returns the actual value of the unsigned short. Caution, returns a char.

Returns:
Returns the actual value of the unsigned short, in char data type.

setValue

public void setValue(char value)
SetValue sets a unSigned short value.

Parameters:
value - The value in char format.