com.ibm.as400.access
Class AS400ByteArray

java.lang.Object
  |
  +--com.ibm.as400.access.AS400ByteArray
All Implemented Interfaces:
AS400DataType, java.lang.Cloneable, java.io.Serializable

public class AS400ByteArray
extends java.lang.Object
implements AS400DataType

The AS400ByteArray class provides a converter between a byte array and fixed-length byte array representing AS/400 data that is not convertible.

See Also:
Serialized Form

Fields inherited from interface com.ibm.as400.access.AS400DataType
serialVersionUID
 
Constructor Summary
AS400ByteArray(int length)
          Constructs an AS400ByteArray object.
 
Method Summary
 java.lang.Object clone()
          Creates a new AS400ByteArray 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.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AS400ByteArray

public AS400ByteArray(int length)
Constructs an AS400ByteArray object.
Parameters:
length - The byte length of the AS/400 byte array. It must be greater than or equal to zero.
Method Detail

clone

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

getByteLength

public int getByteLength()
Returns the byte length of the data type.
Specified by:
getByteLength in interface AS400DataType
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.
Specified by:
getDefaultValue in interface AS400DataType
Returns:
The zero length byte array.

toBytes

public byte[] toBytes(java.lang.Object javaValue)
Converts the specified Java object to AS/400 format.
Specified by:
toBytes in interface AS400DataType
Parameters:
javaValue - The object corresponding to the data type. It must be a byte array. If the provided byte array is not long enough to fill the return array, the remaining bytes will be zero filled. Any extra bytes in the provided array will not be used.
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.
Specified by:
toBytes in interface AS400DataType
Parameters:
javaValue - The object corresponding to the data type. It must be a byte array. If the provided byte array is not long enough to fill the return array, the remaining bytes will be zero filled. Any extra bytes in the provided array will not be used.
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.
Specified by:
toBytes in interface AS400DataType
Parameters:
javaValue - The object corresponding to the data type. It must be a byte array. If the provided byte array is not long enough to fill the return array, the remaining bytes will be zero filled. Any extra bytes in the provided array will not be used.
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.
Specified by:
toObject in interface AS400DataType
Parameters:
as400Value - The array containing the data type in AS/400 format. The entire data type must be represented.
Returns:
The byte array 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.
Specified by:
toObject in interface AS400DataType
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 byte array corresponding to the data type.