Class AbstractXMLDocumentParser

java.lang.Object
org.htmlunit.cyberneko.xerces.parsers.XMLParser
org.htmlunit.cyberneko.xerces.parsers.AbstractXMLDocumentParser
All Implemented Interfaces:
XMLDocumentHandler
Direct Known Subclasses:
AbstractDOMParser, AbstractSAXParser

public abstract class AbstractXMLDocumentParser extends XMLParser implements XMLDocumentHandler
This is the base class for all XML document parsers. XMLDocumentParser provides a common implementation shared by the various document parsers in the Xerces package. While this class is provided for convenience, it does not prevent other kinds of parsers to be constructed using the XNI interfaces.
  • Field Details

  • Constructor Details

    • AbstractXMLDocumentParser

      protected AbstractXMLDocumentParser(XMLParserConfiguration config)
      Constructs a document parser using the default symbol table and grammar pool.
      Parameters:
      config - the config
  • Method Details

    • startDocument

      public void startDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs) throws XNIException
      The start of the document.
      Specified by:
      startDocument in interface XMLDocumentHandler
      Parameters:
      locator - The system identifier of the entity if the entity is external, null otherwise.
      encoding - The auto-detected IANA encoding name of the entity stream. This value will be null in those situations where the entity encoding is not auto-detected (e.g. internal entities or a document entity that is parsed from a java.io.Reader).
      namespaceContext - The namespace context in effect at the start of this document. This object represents the current context. Implementors of this class are responsible for copying the namespace bindings from the the current context (and its parent contexts) if that information is important.
      augs - Additional information that may include infoset augmentations
      Throws:
      XNIException - Thrown by handler to signal an error.
    • xmlDecl

      public void xmlDecl(String version, String encoding, String standalone, Augmentations augs) throws XNIException
      Notifies of the presence of an XMLDecl line in the document. If present, this method will be called immediately following the startDocument call.
      Specified by:
      xmlDecl in interface XMLDocumentHandler
      Parameters:
      version - The XML version.
      encoding - The IANA encoding name of the document, or null if not specified.
      standalone - The standalone value, or null if not specified.
      augs - Additional information that may include infoset augmentations
      Throws:
      XNIException - Thrown by handler to signal an error.
    • doctypeDecl

      public void doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs) throws XNIException
      Notifies of the presence of the DOCTYPE line in the document.
      Specified by:
      doctypeDecl in interface XMLDocumentHandler
      Parameters:
      rootElement - The name of the root element.
      publicId - The public identifier if an external DTD or null if the external DTD is specified using SYSTEM.
      systemId - The system identifier if an external DTD, null
      augs - Additional information that may include infoset augmentations otherwise.
      Throws:
      XNIException - Thrown by handler to signal an error.
    • startElement

      public void startElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException
      The start of an element. If the document specifies the start element by using an empty tag, then the startElement method will immediately be followed by the endElement method, with no intervening methods.
      Specified by:
      startElement in interface XMLDocumentHandler
      Parameters:
      element - The name of the element.
      attributes - The element attributes.
      augs - Additional information that may include infoset augmentations
      Throws:
      XNIException - Thrown by handler to signal an error.
    • emptyElement

      public void emptyElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException
      An empty element.
      Specified by:
      emptyElement in interface XMLDocumentHandler
      Parameters:
      element - The name of the element.
      attributes - The element attributes.
      augs - Additional information that may include infoset augmentations
      Throws:
      XNIException - Thrown by handler to signal an error.
    • characters

      public void characters(XMLString text, Augmentations augs) throws XNIException
      Character content.
      Specified by:
      characters in interface XMLDocumentHandler
      Parameters:
      text - The content.
      augs - Additional information that may include infoset augmentations
      Throws:
      XNIException - Thrown by handler to signal an error.
    • endElement

      public void endElement(QName element, Augmentations augs) throws XNIException
      The end of an element.
      Specified by:
      endElement in interface XMLDocumentHandler
      Parameters:
      element - The name of the element.
      augs - Additional information that may include infoset augmentations
      Throws:
      XNIException - Thrown by handler to signal an error.
    • startCDATA

      public void startCDATA(Augmentations augs) throws XNIException
      The start of a CDATA section.
      Specified by:
      startCDATA in interface XMLDocumentHandler
      Parameters:
      augs - Additional information that may include infoset augmentations
      Throws:
      XNIException - Thrown by handler to signal an error.
    • endCDATA

      public void endCDATA(Augmentations augs) throws XNIException
      The end of a CDATA section.
      Specified by:
      endCDATA in interface XMLDocumentHandler
      Parameters:
      augs - Additional information that may include infoset augmentations
      Throws:
      XNIException - Thrown by handler to signal an error.
    • endDocument

      public void endDocument(Augmentations augs) throws XNIException
      The end of the document.
      Specified by:
      endDocument in interface XMLDocumentHandler
      Parameters:
      augs - Additional information that may include infoset augmentations
      Throws:
      XNIException - Thrown by handler to signal an error.
    • comment

      public void comment(XMLString text, Augmentations augs) throws XNIException
      A comment.
      Specified by:
      comment in interface XMLDocumentHandler
      Parameters:
      text - The text in the comment.
      augs - Additional information that may include infoset augmentations
      Throws:
      XNIException - Thrown by application to signal an error.
    • processingInstruction

      public void processingInstruction(String target, XMLString data, Augmentations augs) throws XNIException
      A processing instruction. Processing instructions consist of a target name and, optionally, text data. The data is only meaningful to the application.

      Typically, a processing instruction's data will contain a series of pseudo-attributes. These pseudo-attributes follow the form of element attributes but are not parsed or presented to the application as anything other than text. The application is responsible for parsing the data.

      Specified by:
      processingInstruction in interface XMLDocumentHandler
      Parameters:
      target - The target.
      data - The data or null if none specified.
      augs - Additional information that may include infoset augmentations
      Throws:
      XNIException - Thrown by handler to signal an error.
    • setDocumentSource

      public void setDocumentSource(XMLDocumentSource source)
      Sets the document source.
      Specified by:
      setDocumentSource in interface XMLDocumentHandler
      Parameters:
      source - the new source
    • getDocumentSource

      public XMLDocumentSource getDocumentSource()
      Specified by:
      getDocumentSource in interface XMLDocumentHandler
      Returns:
      the document source.