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.
org.xml.sax.EntityResolver , org.xml.sax.DTDHandler , org.xml.sax.ContentHandler , org.xml.sax.ErrorHandler
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public void | characters(char[]
The characters. ch, int The start position in the character array. start, int The number of characters to use from the
character array. length)Implements jdk. Receive notification of character data inside an element. |
| public void | endDocument()
Implements jdk. Receive notification of the end of the document. |
| public void | endElement(String
The Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performed. uri, String The local name (without prefix), or the
empty string if Namespace processing is not being
performed. localName, String The qualified name (with prefix), or the
empty string if qualified names are not available. qName)Implements jdk. Receive notification of the end of an element. |
| public void | endPrefixMapping(String
The Namespace prefix being declared. prefix)Implements jdk. Receive notification of the end of a Namespace mapping. |
| public void | error(SAXParseException
The error information encoded as an exception. e)Implements jdk. Receive notification of a recoverable parser error. |
| public void | fatalError(SAXParseException
The error information encoded as an exception. e)Implements jdk. Report a fatal XML parsing error. |
| public void | ignorableWhitespace(char[]
The whitespace characters. ch, int The start position in the character array. start, int The number of characters to use from the
character array. length)Implements jdk. Receive notification of ignorable whitespace in element content. |
| public void | notationDecl(String
The notation name. name, String The notation public identifier, or null if not
available. publicId, String The notation system identifier. systemId)Implements jdk. Receive notification of a notation declaration. |
| public void | processingInstruction(String
The processing instruction target. target, String The processing instruction data, or null if
none is supplied. data)Implements jdk. Receive notification of a processing instruction. |
| public InputSource | Returns: The new input source, or null to require the default behaviour.The public identifier, or null if none is
available. publicId, String The system identifier provided in the XML
document. systemId)Implements jdk. Resolve an external entity. |
| public void | setDocumentLocator(Locator
A locator for all SAX document events. locator)Implements jdk. Receive a Locator object for document events. |
| public void | skippedEntity(String
The name of the skipped entity. name)Implements jdk. Receive notification of a skipped entity. |
| public void | startDocument()
Implements jdk. Receive notification of the beginning of the document. |
| public void | startElement(String
The Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performed. uri, String The local name (without prefix), or the
empty string if Namespace processing is not being
performed. localName, String The qualified name (with prefix), or the
empty string if qualified names are not available. qName, Attributes The attributes attached to the element. If
there are no attributes, it shall be an empty
Attributes object. attributes)Implements jdk. Receive notification of the start of an element. |
| public void | startPrefixMapping(String
The Namespace prefix being declared. prefix, String The Namespace URI mapped to the prefix. uri)Implements jdk. Receive notification of the start of a Namespace mapping. |
| public void | unparsedEntityDecl(String
The entity name. name, String The entity public identifier, or null if not
available. publicId, String The entity system identifier. systemId, String The name of the associated notation. notationName)Implements jdk. Receive notification of an unparsed entity declaration. |
| public void | warning(SAXParseException
The warning information encoded as an exception. e)Implements jdk. Receive notification of a parser warning. |
| DefaultHandler | back to summary |
|---|---|
| public DefaultHandler() | |
| characters | back to summary |
|---|---|
| public void characters(char[] ch, int start, int length) throws SAXException Implements jdk. 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).
| |
| endDocument | back to summary |
|---|---|
| public void endDocument() throws SAXException Implements jdk. 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).
| |
| endElement | back to summary |
|---|---|
| public void endElement(String uri, String localName, String qName) throws SAXException Implements jdk. 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).
| |
| endPrefixMapping | back to summary |
|---|---|
| public void endPrefixMapping(String prefix) throws SAXException Implements jdk. 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.
| |
| error | back to summary |
|---|---|
| public void error(SAXParseException e) throws SAXException Implements jdk. 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.
| |
| fatalError | back to summary |
|---|---|
| public void fatalError(SAXParseException e) throws SAXException Implements jdk. 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.
| |
| ignorableWhitespace | back to summary |
|---|---|
| public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException Implements jdk. 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).
| |
| notationDecl | back to summary |
|---|---|
| public void notationDecl(String name, String publicId, String systemId) throws SAXException Implements jdk. 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.
| |
| processingInstruction | back to summary |
|---|---|
| public void processingInstruction(String target, String data) throws SAXException Implements jdk. 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.
| |
| resolveEntity | back to summary |
|---|---|
| public InputSource resolveEntity(String publicId, String systemId) throws IOException, SAXException Implements jdk. 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.
| |
| setDocumentLocator | back to summary |
|---|---|
| public void setDocumentLocator(Locator locator) Implements jdk. 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.
| |
| skippedEntity | back to summary |
|---|---|
| public void skippedEntity(String name) throws SAXException Implements jdk. 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.
| |
| startDocument | back to summary |
|---|---|
| public void startDocument() throws SAXException Implements jdk. 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).
| |
| startElement | back to summary |
|---|---|
| public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException Implements jdk. 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).
| |
| startPrefixMapping | back to summary |
|---|---|
| public void startPrefixMapping(String prefix, String uri) throws SAXException Implements jdk. 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).
| |
| unparsedEntityDecl | back to summary |
|---|---|
| public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName) throws SAXException Implements jdk. 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.
| |
| warning | back to summary |
|---|---|
| public void warning(SAXParseException e) throws SAXException Implements jdk. 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.
| |