DocumentHandler, DTDHandler, EntityResolver, ErrorHandler
@Deprecated(since="1.5") public class HandlerBase extends Object implements EntityResolver, DTDHandler, DocumentHandler, ErrorHandler
This class implements the default behavior 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.
| Constructor | Description |
|---|---|
HandlerBase() |
Deprecated. Creates a HandlerBase. |
| Modifier and Type | Method | Description |
|---|---|---|
void |
characters |
Deprecated. Receive notification of character data inside an element. |
void |
endDocument() |
Deprecated. Receive notification of the end of the document. |
void |
endElement |
Deprecated. Receive notification of the end of an element. |
void |
error |
Deprecated. Receive notification of a recoverable parser error. |
void |
fatalError |
Deprecated. Report a fatal XML parsing error. |
void |
ignorableWhitespace |
Deprecated. Receive notification of ignorable whitespace in element content. |
void |
notationDecl |
Deprecated. Receive notification of a notation declaration. |
void |
processingInstruction |
Deprecated. Receive notification of a processing instruction. |
InputSource |
resolveEntity |
Deprecated. Resolve an external entity. |
void |
setDocumentLocator |
Deprecated. Receive a Locator object for document events. |
void |
startDocument() |
Deprecated. Receive notification of the beginning of the document. |
void |
startElement |
Deprecated. Receive notification of the start of an element. |
void |
unparsedEntityDecl |
Deprecated. Receive notification of an unparsed entity declaration. |
void |
warning |
Deprecated. Receive notification of a parser warning. |
public HandlerBase()
HandlerBase.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 EntityResolver
publicId - The public identifier, or null if none is available.systemId - The system identifier provided in the XML document.SAXException - Any SAX exception, possibly wrapping another exception.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 DTDHandler
name - The notation name.publicId - The notation public identifier, or null if not available.systemId - The notation system identifier.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 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.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 DocumentHandler
locator - A locator for all SAX document events.public 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 DocumentHandler
SAXException - Any SAX exception, possibly wrapping another exception.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 DocumentHandler
SAXException - Any SAX exception, possibly wrapping another exception.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 DocumentHandler
name - The element type name.attributes - The specified or defaulted attributes.SAXException - Any SAX exception, possibly wrapping another exception.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 DocumentHandler
name - the element nameSAXException - Any SAX exception, possibly wrapping another exception.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 DocumentHandler
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.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 DocumentHandler
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.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 DocumentHandler
target - The processing instruction target.data - The processing instruction data, or null if none is supplied.SAXException - Any SAX exception, possibly wrapping another exception.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 ErrorHandler
e - The warning information encoded as an exception.SAXException - Any SAX exception, possibly wrapping another exception.public 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 ErrorHandler
e - The warning information encoded as an exception.SAXException - Any SAX exception, possibly wrapping another exception.public 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 ErrorHandler
e - The error information encoded as an exception.SAXException - Any SAX exception, possibly wrapping another exception.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.xml/org/xml/sax/HandlerBase.html
DocumentHandlerinterface. It has been replaced by the SAX2DefaultHandlerclass.