All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.as400.access.AS400Text
java.lang.Object
|
+----com.ibm.as400.access.AS400Text
- public class AS400Text
- extends Object
- implements AS400DataType
The AS400Text class provides character set conversion between Java String objects and AS/400 native code pages.
-
AS400Text(int)
- Constructs an AS400Text object.
-
AS400Text(int, int)
- Constructs an AS400Text object.
-
AS400Text(int, int, AS400)
- Constructs an AS400Text object.
-
AS400Text(int, String)
- Constructs AS400Text object.
-
clone()
- Creates a new AS400Text object that is identical to the current instance.
-
getByteLength()
- Returns the byte length of the data type.
-
getCcsid()
- Returns the CCSID of the data type.
-
getDefaultValue()
- Returns a Java object representing the default value of the data type.
-
getEncoding()
- Returns the encoding of the data type.
-
toBytes(Object)
- Converts the specified Java object to AS/400 format.
-
toBytes(Object, byte[])
- Converts the specified Java object into AS/400 format in the specified byte array.
-
toBytes(Object, byte[], int)
- Converts the specified Java object into AS/400 format in the specified byte array.
-
toObject(byte[])
- Converts the specified AS/400 data type to a Java object.
-
toObject(byte[], int)
- Converts the specified AS/400 data type to a Java object.
AS400Text
public AS400Text(int length)
- Constructs an AS400Text object. It uses the most likely CCSID based on the default locale.
- Parameters:
- length - The byte length of the AS/400 text. It must be greater than or equal to zero.
AS400Text
public AS400Text(int length,
int ccsid)
- Constructs an AS400Text object.
- Parameters:
- length - The byte length of the AS/400 text. It must be greater than or equal to zero.
- ccsid - The CCSID of the AS/400 text. It must refer to a valid and available CCSID. The value 65535 will cause the data type to use the most likely CCSID based on the default locale.
AS400Text
public AS400Text(int length,
String encoding)
- Constructs AS400Text object.
- Parameters:
- length - The byte length of the AS/400 text. It must be greater than or equal to zero.
- encoding - The name of a character encoding. It must be a valid and available encoding.
AS400Text
public AS400Text(int length,
int ccsid,
AS400 system)
- Constructs an AS400Text object.
- Parameters:
- length - The byte length of the AS/400 text. It must be greater than or equal to zero.
- ccsid - The CCSID of the AS/400 text. It must refer to a valid and available CCSID. The value 65535 will cause the data type to use the most likely CCSID based on the default locale.
- system - The AS/400 system from which the conversion table may be downloaded.
clone
public Object clone()
- Creates a new AS400Text object that is identical to the current instance.
- Returns:
- The new object.
- Overrides:
- clone in class Object
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.
getCcsid
public int getCcsid()
- Returns the CCSID of the data type.
- Returns:
- The CCSID.
getDefaultValue
public Object getDefaultValue()
- Returns a Java object representing the default value of the data type.
- Returns:
- The String object representing an empty string ("").
getEncoding
public String getEncoding()
- Returns the encoding of the data type.
- Returns:
- The encoding of the data type.
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 an instance of String, and the converted text length must be less than or equal to the byte length of this data type. If the provided string is not long enough to fill the return array, the remaining bytes will be padded with space bytes (EBCDIC 0x40, ASCII 0x20, or Unicode 0x0020).
- Returns:
- The AS/400 representation of the data type.
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 an instance of String, and the converted text length must be less than or equal to the byte length of this data type. If the provided string is not long enough to fill the return array, the remaining bytes will be padded with space bytes (EBCDIC 0x40, ASCII 0x20, or Unicode 0x0020).
- 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(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 an instance of String, and the converted text length must be less than or equal to the byte length of this data type. If the provided string is not long enough to fill the return array, the remaining bytes will be padded with space bytes (EBCDIC 0x40, ASCII 0x20, or Unicode 0x0020).
- 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 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 String object corresponding to the data type.
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 String object corresponding to the data type.
All Packages Class Hierarchy This Package Previous Next Index