All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.access.AS400ByteArray

java.lang.Object
   |
   +----com.ibm.as400.access.AS400ByteArray

public class AS400ByteArray
extends 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.


Constructor Index

 o AS400ByteArray(int)
Constructs an AS400ByteArray object.

Method Index

 o clone()
Creates a new AS400ByteArray object that is identical to the current instance.
 o getByteLength()
Returns the byte length of the data type.
 o getDefaultValue()
Returns a Java object representing the default value of the data type.
 o toBytes(Object)
Converts the specified Java object to AS/400 format.
 o toBytes(Object, byte[])
Converts the specified Java object into AS/400 format in the specified byte array.
 o toBytes(Object, byte[], int)
Converts the specified Java object into AS/400 format in the specified byte array.
 o toObject(byte[])
Converts the specified AS/400 data type to a Java object.
 o toObject(byte[], int)
Converts the specified AS/400 data type to a Java object.

Constructors

 o 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.

Methods

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

Returns:
The new object.
Overrides:
clone in class Object
 o 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.
 o getDefaultValue
 public Object getDefaultValue()
Returns a Java object representing the default value of the data type.

Returns:
The zero length byte array.
 o toBytes
 public byte[] toBytes(Object javaValue)
Converts the specified Java object to AS/400 format.

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.
 o toBytes
 public int toBytes(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 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.
 o toBytes
 public int toBytes(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 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.
 o toObject
 public 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 byte array corresponding to the data type.
 o toObject
 public 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 byte array corresponding to the data type.

All Packages  Class Hierarchy  This Package  Previous  Next  Index