All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.access.AS400Array

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

public class AS400Array
extends Object
implements AS400DataType
The AS400Array class provides a composite data type representing an array of AS400DataType objects.


Constructor Index

 o AS400Array()
Constructs an AS400Array object.
 o AS400Array(AS400DataType, int)
Constructs an AS400Array object.

Method Index

 o clone()
Creates a new AS400Array object that is identical to the current instance.
 o getByteLength()
Returns the byte length of the data type.
 o getDefaultValue()
Returns a Java object that represents the default value of the data type.
 o getNumberOfElements()
Returns the number of elements in the data type.
 o getType()
Returns the type of the array.
 o setNumberOfElements(int)
Sets the number of elements in the data type.
 o setType(AS400DataType)
Sets the type of the array.
 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 AS400Array
 public AS400Array()
Constructs an AS400Array object. The setNumberOfElements() and setType() methods must be called before a call to any conversion methods or the getByteLength() on this object.

 o AS400Array
 public AS400Array(AS400DataType type,
                   int size)
Constructs an AS400Array object.

Parameters:
type - The type of the array.
size - The number of elements in the array. It must be greater than or equal to zero.

Methods

 o clone
 public Object clone()
Creates a new AS400Array 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. The type and number of elements in this array must be set before calling this method.

Returns:
The number of bytes in the AS/400 representation of the data type.
 o getDefaultValue
 public Object getDefaultValue()
Returns a Java object that represents the default value of the data type.

Returns:
The zero-length Object array.
 o getNumberOfElements
 public int getNumberOfElements()
Returns the number of elements in the data type.

Returns:
The number of elements in the array data type. If the number of elements has not been set, negative one (-1) is returned.
 o getType
 public AS400DataType getType()
Returns the type of the array.

Returns:
The type of this array data type. If the array type has not been set, null is returned.
 o setNumberOfElements
 public void setNumberOfElements(int size)
Sets the number of elements in the data type. This method must be called after a call to the null constructor and before a call to any of the conversion methods or getByteLength().

Parameters:
size - The number of elements in the array. It must be greater than or equal to zero.
 o setType
 public void setType(AS400DataType type)
Sets the type of the array. This method must be called after a call to the null constructor and before a call to any of the conversion methods or getByteLength().

Parameters:
type - The type of the array.
 o toBytes
 public byte[] toBytes(Object javaValue)
Converts the specified Java object to AS/400 format. The type and number of elements in this array must be set before calling this method.

Parameters:
javaValue - The object corresponding to the data type. It must be an Object array; the array must contain the correct number of elements, and each element must be of the correct type.
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. The type and number of elements in this array must be set before calling this method.

Parameters:
javaValue - The object corresponding to the data type. It must be an Object array; the array must contain the correct number of elements, and each element must be 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.
 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. The type and number of elements in this array must be set before calling this method.

Parameters:
javaValue - The object corresponding to the data type. It must be an Object array; the array must contain the correct number of elements, and each element must be 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.
 o toObject
 public Object toObject(byte as400Value[])
Converts the specified AS/400 data type to a Java object. The type and number of elements in this array must be set before calling this method.

Parameters:
as400Value - The array containing the data type in AS/400 format. The entire data type must be represented.
Returns:
The array of Object. Each element of this array is an Object corresponding to the type of this AS400Array object.
 o toObject
 public Object toObject(byte as400Value[],
                        int offset)
Converts the specified AS/400 data type to a Java object. The type and number of elements in this array must be set before calling this method.

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 array of Object. Each element of this array is an Object corresponding to the type of this AS400Array object.

All Packages  Class Hierarchy  This Package  Previous  Next  Index