Class UnparsedStructuredField


  • public final class UnparsedStructuredField
    extends java.lang.Object
    Represents an unparsed (generic) AFP structured field.
    • Constructor Detail

      • UnparsedStructuredField

        UnparsedStructuredField​(UnparsedStructuredField.Introducer introducer,
                                byte[] data,
                                byte[] extData)
        Parameters:
        Structured - field introducer
        data - Structured field data
        extData - Structured field extension data
    • Method Detail

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • getTypeCodeAsString

        private java.lang.String getTypeCodeAsString()
        Returns type code function name for this field.
        Returns:
        the type code function name
      • getCategoryCodeAsString

        private java.lang.String getCategoryCodeAsString()
        Returns category code function name for this field.
        Returns:
        the category code function name
      • getSfLength

        public short getSfLength()
        Returns the structured field's length.
        Returns:
        the field length
      • getSfTypeID

        public int getSfTypeID()
        Returns the structured field's identifier.
        Returns:
        the field identifier
      • getSfClassCode

        public byte getSfClassCode()
        Returns the structured field's class code.
        Returns:
        the field class code
      • getSfTypeCode

        public byte getSfTypeCode()
        Returns the structured field's type code.
        Returns:
        the type code
      • getSfCategoryCode

        public byte getSfCategoryCode()
        Returns the structured field's category code.
        Returns:
        the sfCategoryCode
      • isSfiExtensionPresent

        public boolean isSfiExtensionPresent()
        Indicates whether an field introducer extension is present.
        Returns:
        true if an field introducer extension is present
      • isSfiSegmentedData

        public boolean isSfiSegmentedData()
        Indicates whether segmented data is present.
        Returns:
        true if the data is segmented
      • isSfiPaddingPresent

        public boolean isSfiPaddingPresent()
        Indicates whether the data is padded.
        Returns:
        true if the data is padded
      • getExtLength

        public short getExtLength()
        Returns the length of the extension if present.
        Returns:
        the length of the extension (or 0 if no extension is present)
      • getExtData

        byte[] getExtData()
        Returns the extension data if present.
        Returns:
        the extension data (or null if no extension is present)
      • getData

        public byte[] getData()
        Returns the structured field's payload.
        Returns:
        the field's data
      • getIntroducerData

        byte[] getIntroducerData()
      • getCompleteFieldAsBytes

        public byte[] getCompleteFieldAsBytes()
        Returns the complete structured field as a byte array.
        Returns:
        the complete field data
      • writeTo

        public void writeTo​(java.io.OutputStream out)
                     throws java.io.IOException
        Writes this structured field to the given OutputStream.
        Parameters:
        out - the output stream
        Throws:
        java.io.IOException - if an I/O error occurs