Class XfdfReader

java.lang.Object
com.aowagie.text.pdf.XfdfReader
All Implemented Interfaces:
SimpleXMLDocHandler

class XfdfReader extends Object implements SimpleXMLDocHandler
Reads a XFDF.
  • Field Details

    • foundRoot

      private boolean foundRoot
    • fieldNames

      private final Stack fieldNames
    • fieldValues

      private final Stack fieldValues
    • fields

      private HashMap fields
    • listFields

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

      private String fileSpec
  • Constructor Details

    • XfdfReader

      XfdfReader()
  • 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
    • getFieldValue

      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

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