org.xml.sax.helpers
Class DefaultHandler
java.lang.Object
|
+--org.xml.sax.helpers.DefaultHandler
All Implemented Interfaces:
ContentHandler, DTDHandler, EntityResolver, ErrorHandlerKnown Direct 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:
org.xml.sax.EntityResolver EntityResolver
org.xml.sax.DTDHandler DTDHandler
org.xml.sax.ContentHandler ContentHandler
org.xml.sax.ErrorHandler ErrorHandler
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
org.xml.sax.HandlerBase HandlerBase class.
- SAX 2.0
- David Megginson,
org.xml.sax.EntityResolver
org.xml.sax.DTDHandler
org.xml.sax.ContentHandler
org.xml.sax.ErrorHandler
void | characters(char[] ch, int start, int length) |
void | endDocument() |
void | endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName) |
void | endPrefixMapping(java.lang.String prefix) |
void | error(SAXParseException e) |
void | fatalError(SAXParseException e) |
void | ignorableWhitespace(char[] ch, int start, int length) |
void | notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId) |
void | processingInstruction(java.lang.String target, java.lang.String data) |
InputSource | resolveEntity(java.lang.String publicId, java.lang.String systemId) |
void | setDocumentLocator(Locator locator) |
void | skippedEntity(java.lang.String name) |
void | startDocument() |
void | startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, Attributes attributes) |
void | startPrefixMapping(java.lang.String prefix, java.lang.String uri) |
void | unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName) |
void | warning(SAXParseException e) |
characters
public void characters(char[] ch, int start, int length)
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).
- ch - The characters.
- 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.
org.xml.sax.ContentHandler.characters
endDocument
public void endDocument()
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).
SAXException
- Any SAX exception, possibly
wrapping another exception.
org.xml.sax.ContentHandler.endDocument
endElement
public void endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)
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).
- 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.
org.xml.sax.ContentHandler.endElement
endPrefixMapping
public void endPrefixMapping(java.lang.String prefix)
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.
- prefix - The Namespace prefix being declared.
SAXException
- Any SAX exception, possibly
wrapping another exception.
org.xml.sax.ContentHandler.endPrefixMapping
error
public void error(SAXParseException e)
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.
- e - The warning information encoded as an exception.
SAXException
- Any SAX exception, possibly
wrapping another exception.
org.xml.sax.ErrorHandler.warning
org.xml.sax.SAXParseException
fatalError
public void fatalError(SAXParseException e)
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.
- e - The error information encoded as an exception.
SAXException
- Any SAX exception, possibly
wrapping another exception.
org.xml.sax.ErrorHandler.fatalError
org.xml.sax.SAXParseException
ignorableWhitespace
public void ignorableWhitespace(char[] ch, int start, int length)
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).
- ch - The whitespace characters.
- 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.
org.xml.sax.ContentHandler.ignorableWhitespace
notationDecl
public void notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
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.
- 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.
org.xml.sax.DTDHandler.notationDecl
processingInstruction
public void processingInstruction(java.lang.String target, java.lang.String data)
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.
- target - The processing instruction target.
- data - The processing instruction data, or null if
none is supplied.
SAXException
- Any SAX exception, possibly
wrapping another exception.
org.xml.sax.ContentHandler.processingInstruction
resolveEntity
public InputSource resolveEntity(java.lang.String publicId, java.lang.String systemId)
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.
- 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.
java.io.IOException
- If there is an error setting
up the new input source.SAXException
- Any SAX exception, possibly
wrapping another exception.
org.xml.sax.EntityResolver.resolveEntity
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.
- locator - A locator for all SAX document events.
org.xml.sax.ContentHandler.setDocumentLocator
org.xml.sax.Locator
skippedEntity
public void skippedEntity(java.lang.String name)
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.
- name - The name of the skipped entity.
SAXException
- Any SAX exception, possibly
wrapping another exception.
org.xml.sax.ContentHandler.processingInstruction
startDocument
public void startDocument()
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).
SAXException
- Any SAX exception, possibly
wrapping another exception.
org.xml.sax.ContentHandler.startDocument
startElement
public void startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, Attributes attributes)
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).
- 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.
SAXException
- Any SAX exception, possibly
wrapping another exception.
org.xml.sax.ContentHandler.startElement
startPrefixMapping
public void startPrefixMapping(java.lang.String prefix, java.lang.String uri)
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).
- prefix - The Namespace prefix being declared.
- uri - The Namespace URI mapped to the prefix.
SAXException
- Any SAX exception, possibly
wrapping another exception.
org.xml.sax.ContentHandler.startPrefixMapping
unparsedEntityDecl
public void unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName)
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.
- 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.
org.xml.sax.DTDHandler.unparsedEntityDecl
warning
public void warning(SAXParseException e)
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.
- e - The warning information encoded as an exception.
SAXException
- Any SAX exception, possibly
wrapping another exception.
org.xml.sax.ErrorHandler.warning
org.xml.sax.SAXParseException
org.xml.sax.EntityResolver EntityResolverorg.xml.sax.DTDHandler DTDHandlerorg.xml.sax.ContentHandler ContentHandlerorg.xml.sax.ErrorHandler ErrorHandlerApplication 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 org.xml.sax.HandlerBase HandlerBase class.