com.ibm.as400.access
Class AS400Array

java.lang.Object
  extended bycom.ibm.as400.access.AS400Array
All Implemented Interfaces:
AS400DataType, Cloneable, Serializable

public class AS400Array
extends Object
implements AS400DataType

The AS400Array class provides a composite data type representing an array of AS400DataType objects.

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.ibm.as400.access.AS400DataType
TYPE_ARRAY, TYPE_BIN2, TYPE_BIN4, TYPE_BIN8, TYPE_BYTE_ARRAY, TYPE_FLOAT4, TYPE_FLOAT8, TYPE_PACKED, TYPE_STRUCTURE, TYPE_TEXT, TYPE_UBIN2, TYPE_UBIN4, TYPE_ZONED
 
Constructor Summary
AS400Array()
          Constructs an AS400Array object.
AS400Array(AS400DataType type, int size)
          Constructs an AS400Array object.
 
Method Summary
 Object clone()
          Creates a new AS400Array object that is identical to the current instance.
 int getByteLength()
          Returns the byte length of the data type.
 Object getDefaultValue()
          Returns a Java object that represents the default value of the data type.
 int getInstanceType()
          Returns TYPE_ARRAY.
 int getNumberOfElements()
          Returns the number of elements in the data type.
 AS400DataType getType()
          Returns the type of the array.
 void setNumberOfElements(int size)
          Sets the number of elements in the data type.
 void setType(AS400DataType type)
          Sets the type of the array.
 byte[] toBytes(Object javaValue)
          Converts the specified Java object to server format.
 int toBytes(Object javaValue, byte[] as400Value)
          Converts the specified Java object into server format in the specified byte array.
 int toBytes(Object javaValue, byte[] as400Value, int offset)
          Converts the specified Java object into server format in the specified byte array.
 Object toObject(byte[] as400Value)
          Converts the specified server data type to a Java object.
 Object toObject(byte[] as400Value, int offset)
          Converts the specified server 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

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.


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.
Method Detail

clone

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

Specified by:
clone in interface AS400DataType
Returns:
The new object.

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.

Specified by:
getByteLength in interface AS400DataType
Returns:
The number of bytes in the server representation of the data type.

getDefaultValue

public Object getDefaultValue()
Returns a Java object that represents the default value of the data type.

Specified by:
getDefaultValue in interface AS400DataType
Returns:
The zero-length Object array.

getInstanceType

public int getInstanceType()
Returns TYPE_ARRAY.

Specified by:
getInstanceType in interface AS400DataType
Returns:
Returns AS400DataType.TYPE_ARRAY.

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.

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.

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.

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.

toBytes

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

Specified by:
toBytes in interface AS400DataType
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 server representation of the data type.

toBytes

public int toBytes(Object javaValue,
                   byte[] as400Value)
Converts the specified Java object into server format in the specified byte array. The type and number of elements in this array must be set before calling this method.

Specified by:
toBytes in interface AS400DataType
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 server format. There must be enough space to hold the server value.
Returns:
The number of bytes in the server representation of the data type.

toBytes

public int toBytes(Object javaValue,
                   byte[] as400Value,
                   int offset)
Converts the specified Java object into server format in the specified byte array. The type and number of elements in this array must be set before calling this method.

Specified by:
toBytes in interface AS400DataType
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 server format. There must be enough space to hold the server value.
offset - The offset into the byte array for the start of the server value. It must be greater than or equal to zero.
Returns:
The number of bytes in the server representation of the data type.

toObject

public Object toObject(byte[] as400Value)
Converts the specified server data type to a Java object. The type and number of elements in this array must be set before calling this method.

Specified by:
toObject in interface AS400DataType
Parameters:
as400Value - The array containing the data type in server 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.

toObject

public Object toObject(byte[] as400Value,
                       int offset)
Converts the specified server data type to a Java object. The type and number of elements in this array must be set before calling this method.

Specified by:
toObject in interface AS400DataType
Parameters:
as400Value - The array containing the data type in server format. The entire data type must be represented.
offset - The offset into the byte array for the start of the server 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.