DocumentHandler
interface. It has been replaced by the SAX2
DefaultHandler
class.public class HandlerBase extends Object implements EntityResolver, DTDHandler, DocumentHandler, ErrorHandler
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 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 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.
EntityResolver,
DTDHandler,
DocumentHandler,
ErrorHandler| Constructor and Description |
|---|
HandlerBase()
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
void |
characters(char[] ch,
int start,
int length)
Deprecated.
Receive notification of character data inside an element.
|
void |
endDocument()
Deprecated.
Receive notification of the end of the document.
|
void |
endElement(String name)
Deprecated.
Receive notification of the end of an element.
|
void |
error(SAXParseException e)
Deprecated.
Receive notification of a recoverable parser error.
|
void |
fatalError(SAXParseException e)
Deprecated.
Report a fatal XML parsing error.
|
void |
ignorableWhitespace(char[] ch,
int start,
int length)
Deprecated.
Receive notification of ignorable whitespace in element content.
|
void |
notationDecl(String name,
String publicId,
String systemId)
Deprecated.
Receive notification of a notation declaration.
|
void |
processingInstruction(String target,
String data)
Deprecated.
Receive notification of a processing instruction.
|
InputSource |
resolveEntity(String publicId,
String systemId)
Deprecated.
Resolve an external entity.
|
void |
setDocumentLocator(Locator locator)
Deprecated.
Receive a Locator object for document events.
|
void |
startDocument()
Deprecated.
Receive notification of the beginning of the document.
|
void |
startElement(String name,
AttributeList attributes)
Deprecated.
Receive notification of the start of an element.
|
void |
unparsedEntityDecl(String name,
String publicId,
String systemId,
String notationName)
Deprecated.
Receive notification of an unparsed entity declaration.
|
void |
warning(SAXParseException e)
Deprecated.
Receive notification of a parser warning.
|
public InputSource resolveEntity(String publicId, String systemId) throws SAXException
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 EntityResolverpublicId - The public identifer, or null if none is
available.systemId - The system identifier provided in the XML
document.SAXException - Any SAX exception, possibly
wrapping another exception.EntityResolver.resolveEntity(java.lang.String, java.lang.String)public void notationDecl(String name, String publicId, String systemId)
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 DTDHandlername - The notation name.publicId - The notation public identifier, or null if not
available.systemId - The notation system identifier.DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String)public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName)
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 DTDHandlername - 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.DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)public void setDocumentLocator(Locator locator)
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 DocumentHandlerlocator - A locator for all SAX document events.DocumentHandler.setDocumentLocator(org.xml.sax.Locator),
Locatorpublic void startDocument()
throws SAXException
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 DocumentHandlerSAXException - Any SAX exception, possibly
wrapping another exception.DocumentHandler.startDocument()public void endDocument()
throws SAXException
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 DocumentHandlerSAXException - Any SAX exception, possibly
wrapping another exception.DocumentHandler.endDocument()public void startElement(String name, AttributeList attributes) throws SAXException
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 DocumentHandlername - The element type name.attributes - The specified or defaulted attributes.SAXException - Any SAX exception, possibly
wrapping another exception.DocumentHandler.startElement(java.lang.String, org.xml.sax.AttributeList)public void endElement(String name) throws SAXException
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 DocumentHandlername - the element nameSAXException - Any SAX exception, possibly
wrapping another exception.DocumentHandler.endElement(java.lang.String)public void characters(char[] ch,
int start,
int length)
throws SAXException
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 DocumentHandlerch - 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.DocumentHandler.characters(char[], int, int)public void ignorableWhitespace(char[] ch,
int start,
int length)
throws SAXException
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 DocumentHandlerch - 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.DocumentHandler.ignorableWhitespace(char[], int, int)public void processingInstruction(String target, String data) throws SAXException
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 DocumentHandlertarget - The processing instruction target.data - The processing instruction data, or null if
none is supplied.SAXException - Any SAX exception, possibly
wrapping another exception.DocumentHandler.processingInstruction(java.lang.String, java.lang.String)public void warning(SAXParseException e) throws SAXException
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 ErrorHandlere - The warning information encoded as an exception.SAXException - Any SAX exception, possibly
wrapping another exception.ErrorHandler.warning(org.xml.sax.SAXParseException),
SAXParseExceptionpublic void error(SAXParseException e) throws SAXException
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 ErrorHandlere - The warning information encoded as an exception.SAXException - Any SAX exception, possibly
wrapping another exception.ErrorHandler.warning(org.xml.sax.SAXParseException),
SAXParseExceptionpublic void fatalError(SAXParseException e) throws SAXException
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 ErrorHandlere - The error information encoded as an exception.SAXException - Any SAX exception, possibly
wrapping another exception.ErrorHandler.fatalError(org.xml.sax.SAXParseException),
SAXParseException Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2018, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.