com.ibm.as400.access

Class HexFieldDescription

  • All Implemented Interfaces:
    VariableLengthFieldDescription, java.io.Serializable

    public class HexFieldDescription
extends FieldDescription
implements VariableLengthFieldDescription, java.io.Serializable
    The HexFieldDescription class represents the description of the data in a hexadecimal field. It allows:
    • The user to describe a hexadecimal field to the RecordFormat object.
    • The RecordFormat object to describe a hexadecimal field to the user.
    Click hereto see an example.
    See Also:
    Serialized Form

    • Constructor Detail

      • HexFieldDescription

        public HexFieldDescription()
        Constructs a HexFieldDescription object.

      • HexFieldDescription

        public HexFieldDescription(AS400ByteArray dataType,
                   java.lang.String name)
        Constructs a HexFieldDescription object. It uses the specified data type and name of the field. The length of the field will be the length specified on the AS400ByteArray object.
        Parameters:
        dataType - Describes the field and provides the conversion capability for the contents of the field.
        name - The name of the field.

      • HexFieldDescription

        public HexFieldDescription(AS400ByteArray dataType,
                   java.lang.String name,
                   java.lang.String ddsName)
        Constructs a HexFieldDescription object. It uses the specified data type, name, and DDS name of the field. The length of the field will be the length specified on the AS400ByteArray object.
        Parameters:
        dataType - Describes the field and provides the conversion capability for the contents of the field.
        name - The name of the field.
        ddsName - The DDS name of this field. This is the name of the field as it would appear in a DDS description of the field. The length of ddsName must be 10 characters or less.

    • Method Detail

      • getVARLEN

        public int getVARLEN()
        Returns the value specified for the VARLEN keyword for this field.
        Returns:
        The value specified for VARLEN for this field. If VARLEN was not specified for this field, 0 is returned.

      • isVariableLength

        public boolean isVariableLength()
        Indicates if the field is a variable-length field.
        Specified by:
        isVariableLength in interface VariableLengthFieldDescription
        Returns:
        true if the field is a variable-length field; false otherwise.

      • setDataType

        public void setDataType(AS400ByteArray dataType)
        Sets the AS400DataType object describing this field.
        Parameters:
        dataType - The AS400DataType that describes this field. The dataType cannot be null.

      • setDFT

        public void setDFT(byte[] defaultValue)
        Sets the value for the DFT keyword for this field.
        Parameters:
        defaultValue - The default value for this field. The length of defaultValue must be greater than zero. To set a default value of *NULL, use the setDFTNull() method.

      • setDFTNull

        public void setDFTNull()
        Sets the value for the DFT keyword to be *NULL for this field. Calling this method will replace the DFT keyword that was previously set on a call to setDFT(). Note: This field must also have its ALWNULL keyword set to true to prevent DDS errors.

      • setVariableLength

        public void setVariableLength(boolean value)
        Indicates that the field is a variable-length field.
        Specified by:
        setVariableLength in interface VariableLengthFieldDescription
        Parameters:
        value - true if the field is a variable-length field; false otherwise.

      • setVARLEN

        public void setVARLEN(int varLen)
        Sets the value to specify for the VARLEN keyword for this field.
        Parameters:
        varLen - The value to specify for the VARLEN keyword for this field. The varLen cannot be less than zero.
JTOpen 10.7