AS400ByteArray

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

All Implemented Interfaces:

AS400DataType, java.io.Serializable, java.lang.Cloneable
```
public class AS400ByteArray
extends java.lang.Object
implements AS400DataType
```
The AS400ByteArray class provides a converter between a byte array and fixed-length byte array representing IBM i data that is not convertible.

See Also:
Serialized Form

Field Summary
- Fields inherited from interface com.ibm.as400.access.AS400DataType
  TYPE_ARRAY, TYPE_BIN1, TYPE_BIN2, TYPE_BIN4, TYPE_BIN8, TYPE_BYTE_ARRAY, TYPE_DATE, TYPE_DECFLOAT, TYPE_FLOAT4, TYPE_FLOAT8, TYPE_PACKED, TYPE_STRUCTURE, TYPE_TEXT, TYPE_TIME, TYPE_TIME_OF_DAY, TYPE_TIMESTAMP, TYPE_UBIN1, TYPE_UBIN2, TYPE_UBIN4, TYPE_UBIN8, TYPE_VARCHAR, TYPE_ZONED

Constructor Summary

Constructors
Constructor and Description

AS400ByteArray(int length)
Constructs an AS400ByteArray object.

Constructors
Constructor and Description
`AS400ByteArray(int length)` Constructs an AS400ByteArray object.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` Creates a new AS400ByteArray object that is identical to the current instance.
`int`	`getByteLength()` Returns the byte length of the data type.
`java.lang.Object`	`getDefaultValue()` Returns a Java object representing the default value of the data type.
`int`	`getInstanceType()` Returns `TYPE_BYTE_ARRAY`.
`java.lang.Class`	`getJavaType()` Returns the Java class that corresponds with this data type.
`byte[]`	`toBytes(java.lang.Object javaValue)` Converts the specified Java object to IBM i format.
`int`	`toBytes(java.lang.Object javaValue, byte[] as400Value)` Converts the specified Java object into IBM i format in the specified byte array.
`int`	`toBytes(java.lang.Object javaValue, byte[] as400Value, int offset)` Converts the specified Java object into IBM i format in the specified byte array.
`java.lang.Object`	`toObject(byte[] as400Value)` Converts the specified IBM i data type to a Java object.
`java.lang.Object`	`toObject(byte[] as400Value, int offset)` Converts the specified IBM i 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
  - AS400ByteArray
```
public AS400ByteArray(int length)
```
    Constructs an AS400ByteArray object.
    
    Parameters:
    length - The byte length of the IBM i byte array. It must be greater than or equal to zero.
- Method Detail
  - clone
```
public java.lang.Object clone()
```
    Creates a new AS400ByteArray object that is identical to the current instance.
    
    Specified by:
    
    clone in interface AS400DataType
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    The new object.
  - getByteLength
```
public int getByteLength()
```
    Returns the byte length of the data type.
    
    Specified by:
    
    getByteLength in interface AS400DataType
    
    Returns:
    The number of bytes in the IBM i representation of the data type.
  - getDefaultValue
```
public java.lang.Object getDefaultValue()
```
    Returns a Java object representing the default value of the data type.
    
    Specified by:
    
    getDefaultValue in interface AS400DataType
    
    Returns:
    The zero length byte array.
  - getInstanceType
```
public int getInstanceType()
```
    Returns TYPE_BYTE_ARRAY.
    
    Specified by:
    
    getInstanceType in interface AS400DataType
    
    Returns:
    AS400DataType.TYPE_BYTE_ARRAY.
  - getJavaType
```
public java.lang.Class getJavaType()
```
    Returns the Java class that corresponds with this data type.
    
    Specified by:
    
    getJavaType in interface AS400DataType
    
    Returns:
    byte[].class.
  - toBytes
```
public byte[] toBytes(java.lang.Object javaValue)
```
    Converts the specified Java object to IBM i format.
    
    Specified by:
    
    toBytes in interface AS400DataType
    
    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 IBM i representation of the data type.
  - toBytes
```
public int toBytes(java.lang.Object javaValue,
          byte[] as400Value)
```
    Converts the specified Java object into IBM i format in the specified byte array.
    
    Specified by:
    
    toBytes in interface AS400DataType
    
    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 IBM i format. There must be enough space to hold the value.
    
    Returns:
    The number of bytes in the IBM i representation of the data type.
  - toBytes
```
public int toBytes(java.lang.Object javaValue,
          byte[] as400Value,
          int offset)
```
    Converts the specified Java object into IBM i format in the specified byte array.
    
    Specified by:
    
    toBytes in interface AS400DataType
    
    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 IBM i format. There must be enough space to hold the value.
    offset - The offset into the byte array for the start of the IBM i value. It must be greater than or equal to zero.
    
    Returns:
    The number of bytes in the IBM i representation of the data type.
  - toObject
```
public java.lang.Object toObject(byte[] as400Value)
```
    Converts the specified IBM i data type to a Java object.
    
    Specified by:
    
    toObject in interface AS400DataType
    
    Parameters:
    as400Value - The array containing the data type in IBM i format. The entire data type must be represented.
    
    Returns:
    The byte array corresponding to the data type.
  - toObject
```
public java.lang.Object toObject(byte[] as400Value,
                        int offset)
```
    Converts the specified IBM i data type to a Java object.
    
    Specified by:
    
    toObject in interface AS400DataType
    
    Parameters:
    as400Value - The array containing the data type in IBM i format. The entire data type must be represented.
    offset - The offset into the byte array for the start of the IBM i value. It must be greater than or equal to zero.
    
    Returns:
    The byte array corresponding to the data type.

Fields inherited from interface com.ibm.as400.access.AS400DataType

Methods inherited from class java.lang.Object

AS400ByteArray

clone

getByteLength

getDefaultValue

getInstanceType

getJavaType

toBytes

toBytes

toBytes

toObject

toObject