Class DefaultHandler

  • All Implemented Interfaces:
    ResultHandler, org.xml.sax.ContentHandler, org.xml.sax.DocumentHandler

    public class DefaultHandler
    extends java.lang.Object
    implements org.xml.sax.ContentHandler, ResultHandler
    The default implementation of ResultHandler. It uses the Apache Serializer classes written by my friend and colleague Assaf Arkin.
    Version:
    $Revision: 4774 $ $Date: 2004-09-28 21:28:19 +0200 (Tue, 28 Sep 2004) $
    Author:
    Keith Visco
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void cdata​(char[] chars, int start, int length)
      Signals to receive CDATA characters
      void characters​(char[] chars, int start, int length)
      Signals the start of characters
      void comment​(java.lang.String data)
      Signals to recieve a comment
      void endDocument()
      Signals the end of the document
      void endElement​(java.lang.String name)
      Signals the start of element
      void endElement​(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName)
      ContentHandler#endElement
      void endPrefixMapping​(java.lang.String prefix)
      Signals to end the namespace prefix mapping
      void entityReference​(java.lang.String name)
      Signals to recieve an entity reference with the given name
      void ignorableWhitespace​(char[] chars, int start, int length)
      Signals the start of ignorable whitespace characters
      void processingInstruction​(java.lang.String target, java.lang.String data)
      Signals to recieve a processing instruction
      void setDocumentLocator​(org.xml.sax.Locator locator)
      Sets the document locator
      void setIndentSize​(short indentSize)
      Sets the indent size for all formatters that perform serialization, in which indentation is applicable.
      void setOutputFormat​(OutputFormat format)
      Sets the output format information for Formatters that perform serialization.
      void skippedEntity​(java.lang.String name)
      Signals that an entity was skipped by the parser
      void startDocument()
      Signals the start of a document
      void startElement​(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)
      ContentHandler#startElement
      void startElement​(java.lang.String name, org.xml.sax.AttributeList atts)
      Signals the start of element
      void startPrefixMapping​(java.lang.String prefix, java.lang.String uri)
      Signals to start the namespace - prefix mapping
      void unescapedCharacters​(char[] chars, int start, int length)
      Signals to receive characters which should not be escaped
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DefaultHandler

        public DefaultHandler​(java.io.Writer out)
        Creates a new DefaultHandler
      • DefaultHandler

        public DefaultHandler​(java.io.OutputStream out)
        Creates a new DefaultHandler
      • DefaultHandler

        public DefaultHandler​(java.io.Writer out,
                              OutputFormat format)
        Creates a new DefaultHandler
      • DefaultHandler

        public DefaultHandler​(java.io.OutputStream out,
                              OutputFormat format)
        Creates a new DefaultHandler
    • Method Detail

      • cdata

        public void cdata​(char[] chars,
                          int start,
                          int length)
        Signals to receive CDATA characters
        Specified by:
        cdata in interface ResultHandler
        Parameters:
        chars - the character array containing the characters to receive
        start - the index into the character array to start receiving characters at
        length - the number of characters to recieve
      • characters

        public void characters​(char[] chars,
                               int start,
                               int length)
                        throws org.xml.sax.SAXException
        Signals the start of characters
        Specified by:
        characters in interface org.xml.sax.ContentHandler
        Specified by:
        characters in interface org.xml.sax.DocumentHandler
        Parameters:
        chars - the character array containing the characters to receive
        start - the index into the character array to start receiving characters at
        length - the number of characters to recieve
        Throws:
        org.xml.sax.SAXException
      • comment

        public void comment​(java.lang.String data)
        Description copied from interface: ResultHandler
        Signals to recieve a comment
        Specified by:
        comment in interface ResultHandler
        Parameters:
        data - , the content of the comment
      • endDocument

        public void endDocument()
                         throws org.xml.sax.SAXException
        Signals the end of the document
        Specified by:
        endDocument in interface org.xml.sax.ContentHandler
        Specified by:
        endDocument in interface org.xml.sax.DocumentHandler
        Throws:
        org.xml.sax.SAXException
      • endElement

        public void endElement​(java.lang.String name)
                        throws org.xml.sax.SAXException
        Signals the start of element
        Specified by:
        endElement in interface org.xml.sax.DocumentHandler
        Parameters:
        name - the name of the element
        atts - the AttributeList containing the associated attributes for the element
        Throws:
        org.xml.sax.SAXException
      • endElement

        public void endElement​(java.lang.String namespaceURI,
                               java.lang.String localName,
                               java.lang.String qName)
                        throws org.xml.sax.SAXException

        ContentHandler#endElement

        Signals the end of an element
        Specified by:
        endElement in interface org.xml.sax.ContentHandler
        Parameters:
        name - the name of the element
        Throws:
        org.xml.sax.SAXException
      • endPrefixMapping

        public void endPrefixMapping​(java.lang.String prefix)
                              throws org.xml.sax.SAXException
        Signals to end the namespace prefix mapping
        Specified by:
        endPrefixMapping in interface org.xml.sax.ContentHandler
        Parameters:
        prefix - the namespace prefix
        Throws:
        org.xml.sax.SAXException
      • entityReference

        public void entityReference​(java.lang.String name)
        Signals to recieve an entity reference with the given name
        Specified by:
        entityReference in interface ResultHandler
        Parameters:
        name - the name of the entity reference
      • ignorableWhitespace

        public void ignorableWhitespace​(char[] chars,
                                        int start,
                                        int length)
                                 throws org.xml.sax.SAXException
        Signals the start of ignorable whitespace characters
        Specified by:
        ignorableWhitespace in interface org.xml.sax.ContentHandler
        Specified by:
        ignorableWhitespace in interface org.xml.sax.DocumentHandler
        Parameters:
        chars - the character array containing the characters to receive
        start - the index into the character array to start receiving characters at
        length - the number of characters to recieve
        Throws:
        org.xml.sax.SAXException
      • processingInstruction

        public void processingInstruction​(java.lang.String target,
                                          java.lang.String data)
                                   throws org.xml.sax.SAXException
        Signals to recieve a processing instruction
        Specified by:
        processingInstruction in interface org.xml.sax.ContentHandler
        Specified by:
        processingInstruction in interface org.xml.sax.DocumentHandler
        Parameters:
        target - the target of the processing instruction
        data - the content of the processing instruction
        Throws:
        org.xml.sax.SAXException
      • setDocumentLocator

        public void setDocumentLocator​(org.xml.sax.Locator locator)
        Sets the document locator
        Specified by:
        setDocumentLocator in interface org.xml.sax.ContentHandler
        Specified by:
        setDocumentLocator in interface org.xml.sax.DocumentHandler
        Parameters:
        locator - the Locator used by this DocumentHandler
      • setIndentSize

        public void setIndentSize​(short indentSize)
        Sets the indent size for all formatters that perform serialization, in which indentation is applicable.
        Specified by:
        setIndentSize in interface ResultHandler
        Parameters:
        indentSize - the number of characters to indent
      • setOutputFormat

        public void setOutputFormat​(OutputFormat format)
        Sets the output format information for Formatters that perform serialization.
        Specified by:
        setOutputFormat in interface ResultHandler
        Parameters:
        format - the OutputFormat used to specify properties during serialization
      • skippedEntity

        public void skippedEntity​(java.lang.String name)
                           throws org.xml.sax.SAXException
        Signals that an entity was skipped by the parser
        Specified by:
        skippedEntity in interface org.xml.sax.ContentHandler
        Parameters:
        name - the skipped entity's name
        Throws:
        org.xml.sax.SAXException
      • startDocument

        public void startDocument()
                           throws org.xml.sax.SAXException
        Signals the start of a document
        Specified by:
        startDocument in interface org.xml.sax.ContentHandler
        Specified by:
        startDocument in interface org.xml.sax.DocumentHandler
        Throws:
        org.xml.sax.SAXException
      • startElement

        public void startElement​(java.lang.String name,
                                 org.xml.sax.AttributeList atts)
                          throws org.xml.sax.SAXException
        Signals the start of element
        Specified by:
        startElement in interface org.xml.sax.DocumentHandler
        Parameters:
        name - the name of the element
        atts - the AttributeList containing the associated attributes for the element
        Throws:
        org.xml.sax.SAXException
      • startElement

        public void startElement​(java.lang.String namespaceURI,
                                 java.lang.String localName,
                                 java.lang.String qName,
                                 org.xml.sax.Attributes atts)
                          throws org.xml.sax.SAXException

        ContentHandler#startElement

        Signals the start of element
        Specified by:
        startElement in interface org.xml.sax.ContentHandler
        Parameters:
        name - the name of the element
        atts - the AttributeList containing the associated attributes for the element
        Throws:
        org.xml.sax.SAXException
      • startPrefixMapping

        public void startPrefixMapping​(java.lang.String prefix,
                                       java.lang.String uri)
                                throws org.xml.sax.SAXException
        Signals to start the namespace - prefix mapping
        Specified by:
        startPrefixMapping in interface org.xml.sax.ContentHandler
        Parameters:
        prefix - the namespace prefix to map
        uri - the namespace URI
        Throws:
        org.xml.sax.SAXException
      • unescapedCharacters

        public void unescapedCharacters​(char[] chars,
                                        int start,
                                        int length)
        Signals to receive characters which should not be escaped
        Specified by:
        unescapedCharacters in interface ResultHandler
        Parameters:
        chars - the character array containing the characters to receive
        start - the index into the character array to start receiving characters at
        length - the number of characters to recieve