Class XfdfReader

java.lang.Object
com.gitlab.pdftk_java.com.lowagie.text.pdf.XfdfReader
All Implemented Interfaces:
SimpleXMLDocHandler
public class XfdfReader extends Object implements SimpleXMLDocHandler
Reads a XFDF.

  • Field Details

    • foundRoot

      private boolean foundRoot

    • fieldNames

      private Stack fieldNames

    • fieldValues

      private Stack fieldValues

    • fields

      HashMap fields

    • listFields

      protected HashMap listFields
      Storage for field values if there's more than one value for a field.
      Since:
      2.1.4

    • fieldsRichText

      HashMap fieldsRichText

    • fieldsMultiValue

      HashMap<String, ArrayList<String>> fieldsMultiValue

    • fileSpec

      String fileSpec

  • Constructor Details

    • XfdfReader

      public XfdfReader(String filename) throws IOException
      Reads an XFDF form.
      Parameters:
      filename - the file name of the form
      Throws:
      IOException - on error

    • XfdfReader

      public XfdfReader(InputStream fin) throws IOException
      Throws:
      IOException

    • XfdfReader

      public XfdfReader(byte[] xfdfIn) throws IOException
      Reads an XFDF form.
      Parameters:
      xfdfIn - the byte array with the form
      Throws:
      IOException - on error

  • Method Details

    • getFields

      public HashMap getFields()
      Gets all the fields. The map is keyed by the fully qualified field name and the value is a merged PdfDictionary with the field content.
      Returns:
      all the fields

    • getField

      public String getField(String name)
      Gets the field value.
      Parameters:
      name - the fully qualified field name
      Returns:
      the field's value

    • getFieldValue

      public String getFieldValue(String name)
      Gets the field value or null if the field does not exist or has no value defined.
      Parameters:
      name - the fully qualified field name
      Returns:
      the field value or null

    • getListValues

      public List getListValues(String name)
      Gets the field values for a list or null if the field does not exist or has no value defined.
      Parameters:
      name - the fully qualified field name
      Returns:
      the field values or null
      Since:
      2.1.4

    • getFieldRichValue

      public String getFieldRichValue(String name)

    • getFileSpec

      public String getFileSpec()
      Gets the PDF file specification contained in the FDF.
      Returns:
      the PDF file specification contained in the FDF

    • startElement

      public void startElement(String tag, HashMap h)
      Called when a start tag is found.
      Specified by:
      startElement in interface SimpleXMLDocHandler
      Parameters:
      tag - the tag name
      h - the tag's attributes

    • endElement

      public void endElement(String tag)
      Called when an end tag is found.
      Specified by:
      endElement in interface SimpleXMLDocHandler
      Parameters:
      tag - the tag name

    • startDocument

      public void startDocument()
      Called when the document starts to be parsed.
      Specified by:
      startDocument in interface SimpleXMLDocHandler

    • endDocument

      public void endDocument()
      Called after the document is parsed.
      Specified by:
      endDocument in interface SimpleXMLDocHandler

    • text

      public void text(String str)
      Called when a text element is found.
      Specified by:
      text in interface SimpleXMLDocHandler
      Parameters:
      str - the text element, probably a fragment.