com.ibm.as400.access

Class 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
    • 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.
      • 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.