All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.access.AS400Structure

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

public class AS400Structure
extends Object
implements AS400DataType
The AS400Structure class provides a composite data type representing a structure of AS400DataType objects.


Constructor Index

 o AS400Structure()
Constructs an AS400Structure object.
 o AS400Structure(AS400DataType[])
Constructs an AS400Structure object.

Method Index

 o clone()
Creates a new AS400Structure 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 getMembers()
Returns the data types of the members of the structure.
 o getMembers(int)
Returns the data type of the member of the structure at the specified index.
 o getNumberOfMembers()
Returns the number of members in the data type.
 o setMembers(AS400DataType[])
Sets the data types of the members of the structure.
 o setMembers(int, AS400DataType)
Sets the data type of the member of the structure at the specified index.
 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 AS400Structure
 public AS400Structure()
Constructs an AS400Structure object. The setMembers() method must be called before any conversion methods or getByteLength() on this object.

 o AS400Structure
 public AS400Structure(AS400DataType members[])
Constructs an AS400Structure object.

Parameters:
members - The data types of the members of the structure.

Methods

 o clone
 public Object clone()
Creates a new AS400Structure 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 members of this structure 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 representing the default value of the data type.

Returns:
The zero length Object array.
 o getNumberOfMembers
 public int getNumberOfMembers()
Returns the number of members in the data type.

Returns:
The number of members in the structure data type. If the members have not been set, negative one (-1) is returned.
 o getMembers
 public AS400DataType[] getMembers()
Returns the data types of the members of the structure.

Returns:
The data types of the members of the structure. If the members have not been set, null is returned.
 o getMembers
 public AS400DataType getMembers(int index)
Returns the data type of the member of the structure at the specified index. The member array of this structure must be set before calling this method.

Parameters:
index - The index into the structure for the member. It must be greater than or equal to zero and less than or equal to the number of members in the data type.
Returns:
The data type of the member of the structure.
 o setMembers
 public void setMembers(AS400DataType members[])
Sets the data types of the members of the structure. This method must be called after a call to the null constructor and before a call to any of the conversion methods.

Parameters:
members - The data types of the members of the structure.
 o setMembers
 public void setMembers(int index,
                        AS400DataType member)
Sets the data type of the member of the structure at the specified index. This method must be called after a call to the null constructor and before a call to any of the conversion methods. The member array of this structure must be set before calling this method.

Parameters:
index - The index into the structure for the member. It must be greater than or equal to zero and less than or equal to the number of members in the data type.
member - The data type of the member of the structure.
 o toBytes
 public byte[] toBytes(Object javaValue)
Converts the specified Java object to AS/400 format. The members of this structure 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 members of this structure 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 members of this structure 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 members of this structure 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 Objects. Each element of this array is a Java object of the corresponding type of a member of this AS400Structure object.
 o toObject
 public Object toObject(byte as400Value[],
                        int offset)
Converts the specified AS/400 data type to a Java object. The members of this structure 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 Objects. Each element of this array is a Java object of the corresponding type of a member of this AS400Structure object.

All Packages  Class Hierarchy  This Package  Previous  Next  Index