com.ibm.as400.access
Interface AS400DataType

All Superinterfaces:
java.lang.Cloneable, java.io.Serializable
All Known Implementing Classes:
AS400Array, AS400Bin2, AS400Bin4, AS400Bin8, AS400ByteArray, AS400Float8, AS400PackedDecimal, AS400Structure, AS400Text, AS400UnsignedBin2, AS400UnsignedBin4, AS400ZonedDecimal, AS400Float4

public interface AS400DataType
extends java.lang.Cloneable, java.io.Serializable

The AS400DataType interface provides an interface for conversions between Java objects and byte arrays representing AS/400 data types.


Field Summary
static long serialVersionUID
           
 
Method Summary
 java.lang.Object clone()
          Creates a new AS400DataType object that is identical to the current instance.
 int getByteLength()
          Returns the byte length of the data type.
 java.lang.Object getDefaultValue()
          Returns a Java object representing the default value of the data type.
 byte[] toBytes(java.lang.Object javaValue)
          Converts the specified Java object to AS/400 format.
 int toBytes(java.lang.Object javaValue, byte[] as400Value)
          Converts the specified Java object into AS/400 format in the specified byte array.
 int toBytes(java.lang.Object javaValue, byte[] as400Value, int offset)
          Converts the specified Java object into AS/400 format in the specified byte array.
 java.lang.Object toObject(byte[] as400Value)
          Converts the specified AS/400 data type to a Java object.
 java.lang.Object toObject(byte[] as400Value, int offset)
          Converts the specified AS/400 data type to a Java object.
 

Field Detail

serialVersionUID

public static final long serialVersionUID
Method Detail

clone

public java.lang.Object clone()
Creates a new AS400DataType object that is identical to the current instance.
Overrides:
clone in class java.lang.Object
Returns:
The new object.

getByteLength

public int getByteLength()
Returns the byte length of the data type.
Returns:
The number of bytes in the AS/400 representation of the data type.

getDefaultValue

public java.lang.Object getDefaultValue()
Returns a Java object representing the default value of the data type.
Returns:
The Object of the corresponding data type.

toBytes

public byte[] toBytes(java.lang.Object javaValue)
Converts the specified Java object to AS/400 format.
Parameters:
javaValue - The object corresponding to the data type. It must be an instance of the correct type.
Returns:
The AS/400 representation of the data type.

toBytes

public int toBytes(java.lang.Object javaValue,
                   byte[] as400Value)
Converts the specified Java object into AS/400 format in the specified byte array.
Parameters:
javaValue - The object corresponding to the data type. It must be an instance of the correct type.
as400Value - The array to receive the data type in AS/400 format. There must be enough space to hold the AS/400 value.
Returns:
The number of bytes in the AS/400 representation of the data type.

toBytes

public int toBytes(java.lang.Object javaValue,
                   byte[] as400Value,
                   int offset)
Converts the specified Java object into AS/400 format in the specified byte array.
Parameters:
javaValue - The object corresponding to the data type. It must be an instance of the correct type.
as400Value - The array to receive the data type in AS/400 format. There must be enough space to hold the AS/400 value.
offset - The offset into the byte array for the start of the AS/400 value. It must be greater than or equal to zero.
Returns:
The number of bytes in the AS/400 representation of the data type.

toObject

public java.lang.Object toObject(byte[] as400Value)
Converts the specified AS/400 data type to a Java object.
Parameters:
as400Value - The array containing the data type in AS/400 format. The entire data type must be represented.
Returns:
The object corresponding to the data type.

toObject

public java.lang.Object toObject(byte[] as400Value,
                                 int offset)
Converts the specified AS/400 data type to a Java object.
Parameters:
as400Value - The array containing the data type in AS/400 format. The entire data type must be represented.
offset - The offset into the byte array for the start of the AS/400 value. It must be greater than or equal to zero.
Returns:
The object corresponding to the data type.