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.
characters
public void characters(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).
- characters in interface ContentHandler
start - The start position in the character array.length - The number of characters to use from the
character array.
SAXException - Any SAX exception, possibly
wrapping another exception.
endDocument
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).
- endDocument in interface ContentHandler
SAXException - Any SAX exception, possibly
wrapping another exception.
endElement
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).
- endElement in interface ContentHandler
uri - The Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performed.localName - The local name (without prefix), or the
empty string if Namespace processing is not being
performed.qName - The qualified name (with prefix), or the
empty string if qualified names are not available.
SAXException - Any SAX exception, possibly
wrapping another exception.
endPrefixMapping
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.
- endPrefixMapping in interface ContentHandler
prefix - The Namespace prefix being declared.
SAXException - Any SAX exception, possibly
wrapping another exception.
error
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.
- error in interface ErrorHandler
e - The warning information encoded as an exception.
SAXException - Any SAX exception, possibly
wrapping another exception.
fatalError
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.
- fatalError in interface ErrorHandler
e - The error information encoded as an exception.
SAXException - Any SAX exception, possibly
wrapping another exception.
ignorableWhitespace
public void ignorableWhitespace(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).
- ignorableWhitespace in interface ContentHandler
start - The start position in the character array.length - The number of characters to use from the
character array.
SAXException - Any SAX exception, possibly
wrapping another exception.
notationDecl
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.
- notationDecl in interface DTDHandler
name - The notation name.publicId - The notation public identifier, or null if not
available.systemId - The notation system identifier.
SAXException - Any SAX exception, possibly
wrapping another exception.
processingInstruction
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.
- processingInstruction in interface ContentHandler
target - The processing instruction target.data - The processing instruction data, or null if
none is supplied.
SAXException - Any SAX exception, possibly
wrapping another exception.
resolveEntity
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.
- resolveEntity in interface EntityResolver
publicId - The public identifer, or null if none is
available.systemId - The system identifier provided in the XML
document.
- The new input source, or null to require the
default behaviour.
IOException - If there is an error setting
up the new input source.SAXException - Any SAX exception, possibly
wrapping another exception.
setDocumentLocator
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.
- setDocumentLocator in interface ContentHandler
locator - A locator for all SAX document events.
skippedEntity
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.
- skippedEntity in interface ContentHandler
name - The name of the skipped entity.
SAXException - Any SAX exception, possibly
wrapping another exception.
startDocument
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).
- startDocument in interface ContentHandler
SAXException - Any SAX exception, possibly
wrapping another exception.
startElement
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).
- startElement in interface ContentHandler
uri - The Namespace URI, or the empty string if the
element has no Namespace URI or if Namespace
processing is not being performed.localName - The local name (without prefix), or the
empty string if Namespace processing is not being
performed.qName - The qualified name (with prefix), or the
empty string if qualified names are not available.attributes - The attributes attached to the element. If
there are no attributes, it shall be an empty
Attributes object.
SAXException - Any SAX exception, possibly
wrapping another exception.
startPrefixMapping
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).
- startPrefixMapping in interface ContentHandler
prefix - The Namespace prefix being declared.uri - The Namespace URI mapped to the prefix.
SAXException - Any SAX exception, possibly
wrapping another exception.
unparsedEntityDecl
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.
- unparsedEntityDecl in interface DTDHandler
name - The entity name.publicId - The entity public identifier, or null if not
available.systemId - The entity system identifier.notationName - The name of the associated notation.
SAXException - Any SAX exception, possibly
wrapping another exception.
warning
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.
- warning in interface ErrorHandler
e - The warning information encoded as an exception.
SAXException - Any SAX exception, possibly
wrapping another exception.