| java.lang.Object
 org.xml.sax.HandlerBase
| HandlerBase | | public class HandlerBase implements EntityResolver,DTDHandler,DocumentHandler,ErrorHandler(Code) | | Default base class for handlers.
This module, both source code and documentation, is in the
Public Domain, and comes with NO WARRANTY.
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
org.xml.sax.helpers.DefaultHandler 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.
org.xml.sax.DocumentHandler DocumentHandlerorg.xml.sax.helpers.DefaultHandler DefaultHandler
since:
SAX 1.0
author:
David Megginson,
author:
sax@megginson.com
version:
2.0
See Also: org.xml.sax.EntityResolver
See Also: org.xml.sax.DTDHandler
See Also: org.xml.sax.DocumentHandler
See Also: org.xml.sax.ErrorHandler |
| Method Summary | |
| public void | characters(char ch, int start, int length)
Receive notification of character data inside an element.
By default, do nothing. | | public void | endDocument()
Receive notification of the end of the document.
By default, do nothing. | | public void | endElement(String name)
Receive notification of the end of an element.
By default, do nothing. | | public void | error(SAXParseException e)
Receive notification of a recoverable parser error.
The default implementation does nothing. | | public void | fatalError(SAXParseException e)
Report a fatal XML parsing error. | | public void | ignorableWhitespace(char ch, int start, int length)
Receive notification of ignorable whitespace in element content.
By default, do nothing. | | public void | notationDecl(String name, String publicId, String systemId)
Receive notification of a notation declaration.
By default, do nothing. | | public void | processingInstruction(String target, String data)
Receive notification of a processing instruction.
By default, do nothing. | | public InputSource | resolveEntity(String publicId, String systemId)
Resolve an external entity.
Always return null, so that the parser will use the system
identifier provided in the XML document. | | public void | setDocumentLocator(Locator locator)
Receive a Locator object for document events.
By default, do nothing. | | public void | startDocument()
Receive notification of the beginning of the document.
By default, do nothing. | | public void | startElement(String name, AttributeList attributes)
Receive notification of the start of an element.
By default, do nothing. | | public void | unparsedEntityDecl(String name, String publicId, String systemId, String notationName)
Receive notification of an unparsed entity declaration.
By default, do nothing. | | public void | warning(SAXParseException e)
Receive notification of a parser warning.
The default implementation does nothing. |
| characters | | public void characters(char ch, int start, int length) throws SAXException(Code) | | 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).
Parameters:
ch - The characters.
Parameters:
start - The start position in the character array.
Parameters:
length - The number of characters to use from thecharacter array.
exception:
org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also: org.xml.sax.DocumentHandler.characters |
| endDocument | | public void endDocument() throws SAXException(Code) | | 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 beginning
of a document (such as finalising a tree or closing an output
file).
exception:
org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also: org.xml.sax.DocumentHandler.endDocument |
| endElement | | public void endElement(String name) throws SAXException(Code) | | 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).
Parameters:
name - The element type name.
Parameters:
attributes - The specified or defaulted attributes.
exception:
org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also: org.xml.sax.DocumentHandler.endElement |
| fatalError | | public void fatalError(SAXParseException e) throws SAXException(Code) | | 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.
Parameters:
e - The error information encoded as an exception.
exception:
org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also: org.xml.sax.ErrorHandler.fatalError
See Also: org.xml.sax.SAXParseException |
| ignorableWhitespace | | public void ignorableWhitespace(char ch, int start, int length) throws SAXException(Code) | | 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).
Parameters:
ch - The whitespace characters.
Parameters:
start - The start position in the character array.
Parameters:
length - The number of characters to use from thecharacter array.
exception:
org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also: org.xml.sax.DocumentHandler.ignorableWhitespace |
| notationDecl | | public void notationDecl(String name, String publicId, String systemId)(Code) | | 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.
Parameters:
name - The notation name.
Parameters:
publicId - The notation public identifier, or null if notavailable.
Parameters:
systemId - The notation system identifier.
See Also: org.xml.sax.DTDHandler.notationDecl |
| processingInstruction | | public void processingInstruction(String target, String data) throws SAXException(Code) | | 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.
Parameters:
target - The processing instruction target.
Parameters:
data - The processing instruction data, or null ifnone is supplied.
exception:
org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also: org.xml.sax.DocumentHandler.processingInstruction |
| resolveEntity | | public InputSource resolveEntity(String publicId, String systemId) throws SAXException(Code) | | 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.
Parameters:
publicId - The public identifer, or null if none isavailable.
Parameters:
systemId - The system identifier provided in the XML document. The new input source, or null to require thedefault behaviour.
exception:
org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also: org.xml.sax.EntityResolver.resolveEntity |
| setDocumentLocator | | public void setDocumentLocator(Locator locator)(Code) | | 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.
Parameters:
locator - A locator for all SAX document events.
See Also: org.xml.sax.DocumentHandler.setDocumentLocator
See Also: org.xml.sax.Locator |
| startDocument | | public void startDocument() throws SAXException(Code) | | 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).
exception:
org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also: org.xml.sax.DocumentHandler.startDocument |
| startElement | | public void startElement(String name, AttributeList attributes) throws SAXException(Code) | | 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).
Parameters:
name - The element type name.
Parameters:
attributes - The specified or defaulted attributes.
exception:
org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also: org.xml.sax.DocumentHandler.startElement |
| unparsedEntityDecl | | public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName)(Code) | | 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.
Parameters:
name - The entity name.
Parameters:
publicId - The entity public identifier, or null if notavailable.
Parameters:
systemId - The entity system identifier.
Parameters:
notationName - The name of the associated notation.
See Also: org.xml.sax.DTDHandler.unparsedEntityDecl |
|
|