Module java.xml
Package org.xml.sax

Class HandlerBase

  • All Implemented Interfaces:
    DocumentHandler, DTDHandler, EntityResolver, ErrorHandler
    Deprecated. 
    This class works with the deprecated DocumentHandler interface. It has been replaced by the SAX2 DefaultHandler class.

    public class HandlerBase
extends Object
implements EntityResolver, DTDHandler, DocumentHandler, ErrorHandler
    Default base class for handlers.
    This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. See http://www.saxproject.org for further information.

    This class implements the default behaviour for four SAX1 interfaces: EntityResolver, DTDHandler, DocumentHandler, and ErrorHandler. It is now obsolete, but is included in SAX2 to support legacy SAX1 applications. SAX2 applications should use the DefaultHandler class instead.

    Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.

    Note that the use of this class is optional.

    Since:
    1.4, SAX 1.0
    See Also:
    EntityResolver, DTDHandler, DocumentHandler, ErrorHandler

    • Constructor Detail

      • HandlerBase

        public HandlerBase​()
        Deprecated. 

    • Method Detail

      • resolveEntity

        public InputSource resolveEntity​(String publicId,
                                 String systemId)
                          throws SAXException
        Deprecated. 
        Resolve an external entity.

        Always return null, so that the parser will use the system identifier provided in the XML document. This method implements the SAX default behaviour: application writers can override it in a subclass to do special translations such as catalog lookups or URI redirection.

        Specified by:
        resolveEntity in interface EntityResolver
        Parameters:
        publicId - The public identifer, or null if none is available.
        systemId - The system identifier provided in the XML document.
        Returns:
        The new input source, or null to require the default behaviour.
        Throws:
        SAXException - Any SAX exception, possibly wrapping another exception.
        See Also:
        EntityResolver.resolveEntity(java.lang.String, java.lang.String)

      • notationDecl

        public void notationDecl​(String name,
                         String publicId,
                         String systemId)
        Deprecated. 
        Receive notification of a notation declaration.

        By default, do nothing. Application writers may override this method in a subclass if they wish to keep track of the notations declared in a document.

        Specified by:
        notationDecl in interface DTDHandler
        Parameters:
        name - The notation name.
        publicId - The notation public identifier, or null if not available.
        systemId - The notation system identifier.
        See Also:
        DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String)

      • startDocument

        public void startDocument​()
                   throws SAXException
        Deprecated. 
        Receive notification of the beginning of the document.

        By default, do nothing. Application writers may override this method in a subclass to take specific actions at the beginning of a document (such as allocating the root node of a tree or creating an output file).

        Specified by:
        startDocument in interface DocumentHandler
        Throws:
        SAXException - Any SAX exception, possibly wrapping another exception.
        See Also:
        DocumentHandler.startDocument()

      • endDocument

        public void endDocument​()
                 throws SAXException
        Deprecated. 
        Receive notification of the end of the document.

        By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of a document (such as finalising a tree or closing an output file).

        Specified by:
        endDocument in interface DocumentHandler
        Throws:
        SAXException - Any SAX exception, possibly wrapping another exception.
        See Also:
        DocumentHandler.endDocument()

      • endElement

        public void endElement​(String name)
                throws SAXException
        Deprecated. 
        Receive notification of the end of an element.

        By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).

        Specified by:
        endElement in interface DocumentHandler
        Parameters:
        name - the element name
        Throws:
        SAXException - Any SAX exception, possibly wrapping another exception.
        See Also:
        DocumentHandler.endElement(java.lang.String)

      • characters

        public void characters​(char[] ch,
                       int start,
                       int length)
                throws SAXException
        Deprecated. 
        Receive notification of character data inside an element.

        By default, do nothing. Application writers may override this method to take specific actions for each chunk of character data (such as adding the data to a node or buffer, or printing it to a file).

        Specified by:
        characters in interface DocumentHandler
        Parameters:
        ch - The characters.
        start - The start position in the character array.
        length - The number of characters to use from the character array.
        Throws:
        SAXException - Any SAX exception, possibly wrapping another exception.
        See Also:
        DocumentHandler.characters(char[], int, int)

      • ignorableWhitespace

        public void ignorableWhitespace​(char[] ch,
                                int start,
                                int length)
                         throws SAXException
        Deprecated. 
        Receive notification of ignorable whitespace in element content.

        By default, do nothing. Application writers may override this method to take specific actions for each chunk of ignorable whitespace (such as adding data to a node or buffer, or printing it to a file).

        Specified by:
        ignorableWhitespace in interface DocumentHandler
        Parameters:
        ch - The whitespace characters.
        start - The start position in the character array.
        length - The number of characters to use from the character array.
        Throws:
        SAXException - Any SAX exception, possibly wrapping another exception.
        See Also:
        DocumentHandler.ignorableWhitespace(char[], int, int)

      • processingInstruction

        public void processingInstruction​(String target,
                                  String data)
                           throws SAXException
        Deprecated. 
        Receive notification of a processing instruction.

        By default, do nothing. Application writers may override this method in a subclass to take specific actions for each processing instruction, such as setting status variables or invoking other methods.

        Specified by:
        processingInstruction in interface DocumentHandler
        Parameters:
        target - The processing instruction target.
        data - The processing instruction data, or null if none is supplied.
        Throws:
        SAXException - Any SAX exception, possibly wrapping another exception.
        See Also:
        DocumentHandler.processingInstruction(java.lang.String, java.lang.String)

      • fatalError

        public void fatalError​(SAXParseException e)
                throws SAXException
        Deprecated. 
        Report a fatal XML parsing error.

        The default implementation throws a SAXParseException. Application writers may override this method in a subclass if they need to take specific actions for each fatal error (such as collecting all of the errors into a single report): in any case, the application must stop all regular processing when this method is invoked, since the document is no longer reliable, and the parser may no longer report parsing events.

        Specified by:
        fatalError in interface ErrorHandler
        Parameters:
        e - The error information encoded as an exception.
        Throws:
        SAXException - Any SAX exception, possibly wrapping another exception.
        See Also:
        ErrorHandler.fatalError(org.xml.sax.SAXParseException), SAXParseException