Package org.apache.cocoon.xml.sax

Class AbstractSAXConsumer

  • All Implemented Interfaces:
    org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler
    public abstract class AbstractSAXConsumer
extends java.lang.Object
implements org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler
    This abstract class provides default implementation of the methods specified by the ContentHandler and the LexicalHandler interface.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void characters​(char[] ch, int start, int len)
      Receive notification of character data.
      void comment​(char[] ch, int start, int len)
      Report an XML comment anywhere in the document.
      void endCDATA()
      Report the end of a CDATA section.
      void endDocument()
      Receive notification of the end of a document.
      void endDTD()
      Report the end of DTD declarations.
      void endElement​(java.lang.String uri, java.lang.String loc, java.lang.String raw)
      Receive notification of the end of an element.
      void endEntity​(java.lang.String name)
      Report the end of an entity.
      void endPrefixMapping​(java.lang.String prefix)
      End the scope of a prefix-URI mapping.
      void ignorableWhitespace​(char[] ch, int start, int len)
      Receive notification of ignorable whitespace in element content.
      void processingInstruction​(java.lang.String target, java.lang.String data)
      Receive notification of a processing instruction.
      void setDocumentLocator​(org.xml.sax.Locator locator)
      Receive an object for locating the origin of SAX document events.
      void skippedEntity​(java.lang.String name)
      Receive notification of a skipped entity.
      void startCDATA()
      Report the start of a CDATA section.
      void startDocument()
      Receive notification of the beginning of a document.
      void startDTD​(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
      Report the start of DTD declarations, if any.
      void startElement​(java.lang.String uri, java.lang.String loc, java.lang.String raw, org.xml.sax.Attributes a)
      Receive notification of the beginning of an element.
      void startEntity​(java.lang.String name)
      Report the beginning of an entity.
      void startPrefixMapping​(java.lang.String prefix, java.lang.String uri)
      Begin the scope of a prefix-URI Namespace mapping.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AbstractSAXConsumer

        public AbstractSAXConsumer()

    • Method Detail

      • setDocumentLocator

        public void setDocumentLocator​(org.xml.sax.Locator locator)
        Receive an object for locating the origin of SAX document events.
        Specified by:
        setDocumentLocator in interface org.xml.sax.ContentHandler
        Parameters:
        locator - An object that can return the location of any SAX document event.

      • startDocument

        public void startDocument()
                   throws org.xml.sax.SAXException
        Receive notification of the beginning of a document.
        Specified by:
        startDocument in interface org.xml.sax.ContentHandler
        Throws:
        org.xml.sax.SAXException

      • endDocument

        public void endDocument()
                 throws org.xml.sax.SAXException
        Receive notification of the end of a document.
        Specified by:
        endDocument in interface org.xml.sax.ContentHandler
        Throws:
        org.xml.sax.SAXException

      • startPrefixMapping

        public void startPrefixMapping​(java.lang.String prefix,
                               java.lang.String uri)
                        throws org.xml.sax.SAXException
        Begin the scope of a prefix-URI Namespace mapping.
        Specified by:
        startPrefixMapping in interface org.xml.sax.ContentHandler
        Parameters:
        prefix - The Namespace prefix being declared.
        uri - The Namespace URI the prefix is mapped to.
        Throws:
        org.xml.sax.SAXException

      • endPrefixMapping

        public void endPrefixMapping​(java.lang.String prefix)
                      throws org.xml.sax.SAXException
        End the scope of a prefix-URI mapping.
        Specified by:
        endPrefixMapping in interface org.xml.sax.ContentHandler
        Parameters:
        prefix - The prefix that was being mapping.
        Throws:
        org.xml.sax.SAXException

      • startElement

        public void startElement​(java.lang.String uri,
                         java.lang.String loc,
                         java.lang.String raw,
                         org.xml.sax.Attributes a)
                  throws org.xml.sax.SAXException
        Receive notification of the beginning of an element.
        Specified by:
        startElement in interface org.xml.sax.ContentHandler
        Parameters:
        uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
        loc - The local name (without prefix), or the empty string if Namespace processing is not being performed.
        raw - The raw XML 1.0 name (with prefix), or the empty string if raw names are not available.
        a - The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.
        Throws:
        org.xml.sax.SAXException

      • endElement

        public void endElement​(java.lang.String uri,
                       java.lang.String loc,
                       java.lang.String raw)
                throws org.xml.sax.SAXException
        Receive notification of the end of an element.
        Specified by:
        endElement in interface org.xml.sax.ContentHandler
        Parameters:
        uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
        loc - The local name (without prefix), or the empty string if Namespace processing is not being performed.
        raw - The raw XML 1.0 name (with prefix), or the empty string if raw names are not available.
        Throws:
        org.xml.sax.SAXException

      • characters

        public void characters​(char[] ch,
                       int start,
                       int len)
                throws org.xml.sax.SAXException
        Receive notification of character data.
        Specified by:
        characters in interface org.xml.sax.ContentHandler
        Parameters:
        ch - The characters from the XML document.
        start - The start position in the array.
        len - The number of characters to read from the array.
        Throws:
        org.xml.sax.SAXException

      • ignorableWhitespace

        public void ignorableWhitespace​(char[] ch,
                                int start,
                                int len)
                         throws org.xml.sax.SAXException
        Receive notification of ignorable whitespace in element content.
        Specified by:
        ignorableWhitespace in interface org.xml.sax.ContentHandler
        Parameters:
        ch - The characters from the XML document.
        start - The start position in the array.
        len - The number of characters to read from the array.
        Throws:
        org.xml.sax.SAXException

      • processingInstruction

        public void processingInstruction​(java.lang.String target,
                                  java.lang.String data)
                           throws org.xml.sax.SAXException
        Receive notification of a processing instruction.
        Specified by:
        processingInstruction in interface org.xml.sax.ContentHandler
        Parameters:
        target - The processing instruction target.
        data - The processing instruction data, or null if none was supplied.
        Throws:
        org.xml.sax.SAXException

      • skippedEntity

        public void skippedEntity​(java.lang.String name)
                   throws org.xml.sax.SAXException
        Receive notification of a skipped entity.
        Specified by:
        skippedEntity in interface org.xml.sax.ContentHandler
        Parameters:
        name - The name of the skipped entity. If it is a parameter entity, the name will begin with '%'.
        Throws:
        org.xml.sax.SAXException

      • startDTD

        public void startDTD​(java.lang.String name,
                     java.lang.String publicId,
                     java.lang.String systemId)
              throws org.xml.sax.SAXException
        Report the start of DTD declarations, if any.
        Specified by:
        startDTD in interface org.xml.sax.ext.LexicalHandler
        Parameters:
        name - The document type name.
        publicId - The declared public identifier for the external DTD subset, or null if none was declared.
        systemId - The declared system identifier for the external DTD subset, or null if none was declared.
        Throws:
        org.xml.sax.SAXException

      • endDTD

        public void endDTD()
            throws org.xml.sax.SAXException
        Report the end of DTD declarations.
        Specified by:
        endDTD in interface org.xml.sax.ext.LexicalHandler
        Throws:
        org.xml.sax.SAXException

      • startEntity

        public void startEntity​(java.lang.String name)
                 throws org.xml.sax.SAXException
        Report the beginning of an entity.
        Specified by:
        startEntity in interface org.xml.sax.ext.LexicalHandler
        Parameters:
        name - The name of the entity. If it is a parameter entity, the name will begin with '%'.
        Throws:
        org.xml.sax.SAXException

      • endEntity

        public void endEntity​(java.lang.String name)
               throws org.xml.sax.SAXException
        Report the end of an entity.
        Specified by:
        endEntity in interface org.xml.sax.ext.LexicalHandler
        Parameters:
        name - The name of the entity that is ending.
        Throws:
        org.xml.sax.SAXException

      • startCDATA

        public void startCDATA()
                throws org.xml.sax.SAXException
        Report the start of a CDATA section.
        Specified by:
        startCDATA in interface org.xml.sax.ext.LexicalHandler
        Throws:
        org.xml.sax.SAXException

      • endCDATA

        public void endCDATA()
              throws org.xml.sax.SAXException
        Report the end of a CDATA section.
        Specified by:
        endCDATA in interface org.xml.sax.ext.LexicalHandler
        Throws:
        org.xml.sax.SAXException

      • comment

        public void comment​(char[] ch,
                    int start,
                    int len)
             throws org.xml.sax.SAXException
        Report an XML comment anywhere in the document.
        Specified by:
        comment in interface org.xml.sax.ext.LexicalHandler
        Parameters:
        ch - An array holding the characters in the comment.
        start - The starting position in the array.
        len - The number of characters to use from the array.
        Throws:
        org.xml.sax.SAXException