com.ibm.as400.access
Class AS400Bin2

java.lang.Object
  extended bycom.ibm.as400.access.AS400Bin2
All Implemented Interfaces:
AS400DataType, Cloneable, Serializable

public class AS400Bin2
extends Object
implements AS400DataType

The AS400Bin2 class provides a converter between a Short object and a signed two-byte binary number.

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.ibm.as400.access.AS400DataType
TYPE_ARRAY, TYPE_BIN2, TYPE_BIN4, TYPE_BIN8, TYPE_BYTE_ARRAY, TYPE_FLOAT4, TYPE_FLOAT8, TYPE_PACKED, TYPE_STRUCTURE, TYPE_TEXT, TYPE_UBIN2, TYPE_UBIN4, TYPE_ZONED
 
Constructor Summary
AS400Bin2()
          Constructs an AS400Bin2 object.
 
Method Summary
 Object clone()
          Creates a new AS400Bin2 that is identical to the current instance.
 int getByteLength()
          Returns the byte length of the data type.
 Object getDefaultValue()
          Returns a Java object representing the default value of the data type.
 int getInstanceType()
          Returns TYPE_BIN2.
 byte[] toBytes(Object javaValue)
          Converts the specified Java object to server format.
 int toBytes(Object javaValue, byte[] as400Value)
          Converts the specified Java object into server format in the specified byte array.
 int toBytes(Object javaValue, byte[] as400Value, int offset)
          Converts the specified Java object into server format in the specified byte array.
 byte[] toBytes(short shortValue)
          Converts the specified short to server format.
 int toBytes(short shortValue, byte[] as400Value)
          Converts the specified short into server format in the specified byte array.
 int toBytes(short shortValue, byte[] as400Value, int offset)
          Converts the specified short into server format in the specified byte array.
 Object toObject(byte[] as400Value)
          Converts the specified server data type to a Java object.
 Object toObject(byte[] as400Value, int offset)
          Converts the specified server data type to a Java object.
 short toShort(byte[] as400Value)
          Converts the specified server data type to a short.
 short toShort(byte[] as400Value, int offset)
          Converts the specified server data type to a short.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AS400Bin2

public AS400Bin2()
Constructs an AS400Bin2 object.

Method Detail

clone

public Object clone()
Creates a new AS400Bin2 that is identical to the current instance.

Specified by:
clone in interface AS400DataType
Returns:
The new object.

getByteLength

public int getByteLength()
Returns the byte length of the data type.

Specified by:
getByteLength in interface AS400DataType
Returns:
Two (2), the number of bytes in the server representation of the data type.

getDefaultValue

public Object getDefaultValue()
Returns a Java object representing the default value of the data type.

Specified by:
getDefaultValue in interface AS400DataType
Returns:
The Short object with a value of zero.

getInstanceType

public int getInstanceType()
Returns TYPE_BIN2.

Specified by:
getInstanceType in interface AS400DataType
Returns:
Returns AS400DataType.TYPE_BIN2.

toBytes

public byte[] toBytes(Object javaValue)
Converts the specified Java object to server format.

Specified by:
toBytes in interface AS400DataType
Parameters:
javaValue - The object corresponding to the data type. It must be an instance of Short.
Returns:
The server representation of the data type.

toBytes

public byte[] toBytes(short shortValue)
Converts the specified short to server format.

Parameters:
shortValue - The value to be converted to server format.
Returns:
The server representation of the data type.

toBytes

public int toBytes(Object javaValue,
                   byte[] as400Value)
Converts the specified Java object into server format in the specified byte array.

Specified by:
toBytes in interface AS400DataType
Parameters:
javaValue - The object corresponding to the data type. It must be an instance of Short.
as400Value - The array to receive the data type in server format. There must be enough space to hold the server value.
Returns:
Two (2), the number of bytes in the server representation of the data type.

toBytes

public int toBytes(short shortValue,
                   byte[] as400Value)
Converts the specified short into server format in the specified byte array.

Parameters:
shortValue - The value to be converted to server format.
as400Value - The array to receive the data type in server format. There must be enough space to hold the server value.
Returns:
Two (2), the number of bytes in the server representation of the data type.

toBytes

public int toBytes(Object javaValue,
                   byte[] as400Value,
                   int offset)
Converts the specified Java object into server format in the specified byte array.

Specified by:
toBytes in interface AS400DataType
Parameters:
javaValue - The object corresponding to the data type. It must be an instance of Short.
as400Value - The array to receive the data type in server format. There must be enough space to hold the server value.
offset - The offset into the byte array for the start of the server value. It must be greater than or equal to zero.
Returns:
Two (2), the number of bytes in the server representation of the data type.

toBytes

public int toBytes(short shortValue,
                   byte[] as400Value,
                   int offset)
Converts the specified short into server format in the specified byte array.

Parameters:
shortValue - The value to be converted to server format.
as400Value - The array to receive the data type in server format. There must be enough space to hold the server value.
offset - The offset into the byte array for the start of the server value. It must be greater than or equal to zero.
Returns:
Two (2), the number of bytes in the server representation of the data type.

toObject

public Object toObject(byte[] as400Value)
Converts the specified server data type to a Java object.

Specified by:
toObject in interface AS400DataType
Parameters:
as400Value - The array containing the data type in server format. The entire data type must be represented.
Returns:
The Short object corresponding to the data type.

toObject

public Object toObject(byte[] as400Value,
                       int offset)
Converts the specified server data type to a Java object.

Specified by:
toObject in interface AS400DataType
Parameters:
as400Value - The array containing the data type in server format. The entire data type must be represented.
offset - The offset into the byte array for the start of the server value. It must be greater than or equal to zero.
Returns:
The Short object corresponding to the data type.

toShort

public short toShort(byte[] as400Value)
Converts the specified server data type to a short.

Parameters:
as400Value - The array containing the data type in server format. The entire data type must be represented.
Returns:
The short corresponding to the data type.

toShort

public short toShort(byte[] as400Value,
                     int offset)
Converts the specified server data type to a short.

Parameters:
as400Value - The array containing the data type in server format. The entire data type must be represented.
offset - The offset into the byte array for the start of the server value. It must be greater than or equal to zero.
Returns:
The short corresponding to the data type.