Home » xml-commons-external-1.4.01-src » org.xml » sax » helpers » [javadoc | source]
org.xml.sax.helpers
public class: DefaultHandler [javadoc | source]
java.lang.Object
   org.xml.sax.helpers.DefaultHandler

All Implemented Interfaces:
    ContentHandler, DTDHandler, ErrorHandler, EntityResolver

Direct Known Subclasses:
    DefaultHandler2

Default base class for SAX2 event 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 is available as a convenience base class for SAX2 applications: it provides default implementations for all of the callbacks in the four core SAX2 handler classes:

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.

This class replaces the deprecated SAX1 HandlerBase class.

Method from org.xml.sax.helpers.DefaultHandler Summary:
characters,   endDocument,   endElement,   endPrefixMapping,   error,   fatalError,   ignorableWhitespace,   notationDecl,   processingInstruction,   resolveEntity,   setDocumentLocator,   skippedEntity,   startDocument,   startElement,   startPrefixMapping,   unparsedEntityDecl,   warning
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.xml.sax.helpers.DefaultHandler Detail:
 public  void characters(char[] ch,
    int start,
    int length) throws SAXException 
    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).

 public  void endDocument() throws SAXException 
    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).

 public  void endElement(String uri,
    String localName,
    String qName) throws SAXException 
    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).

 public  void endPrefixMapping(String prefix) throws SAXException 
    Receive notification of the end of a Namespace mapping.

    By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each prefix mapping.

 public  void error(SAXParseException e) throws SAXException 
    Receive notification of a recoverable parser error.

    The default implementation does nothing. Application writers may override this method in a subclass to take specific actions for each error, such as inserting the message in a log file or printing it to the console.

 public  void fatalError(SAXParseException e) throws SAXException 
    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.

 public  void ignorableWhitespace(char[] ch,
    int start,
    int length) throws SAXException 
    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).

 public  void notationDecl(String name,
    String publicId,
    String systemId) throws SAXException 
    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.

 public  void processingInstruction(String target,
    String data) throws SAXException 
    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.

 public InputSource resolveEntity(String publicId,
    String systemId) throws IOException, SAXException 
    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.

 public  void setDocumentLocator(Locator locator) 
    Receive a Locator object for document events.

    By default, do nothing. Application writers may override this method in a subclass if they wish to store the locator for use with other document events.

 public  void skippedEntity(String name) throws SAXException 
    Receive notification of a skipped entity.

    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.

 public  void startDocument() throws SAXException 
    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).

 public  void startElement(String uri,
    String localName,
    String qName,
    Attributes attributes) throws SAXException 
    Receive notification of the start of an element.

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

 public  void startPrefixMapping(String prefix,
    String uri) throws SAXException 
    Receive notification of the start of a Namespace mapping.

    By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each Namespace prefix scope (such as storing the prefix mapping).

 public  void unparsedEntityDecl(String name,
    String publicId,
    String systemId,
    String notationName) throws SAXException 
    Receive notification of an unparsed entity declaration.

    By default, do nothing. Application writers may override this method in a subclass to keep track of the unparsed entities declared in a document.

 public  void warning(SAXParseException e) throws SAXException 
    Receive notification of a parser warning.

    The default implementation does nothing. Application writers may override this method in a subclass to take specific actions for each warning, such as inserting the message in a log file or printing it to the console.