- All Implemented Interfaces:
DocumentHandler
,DTDHandler
,EntityResolver
,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.
- Since:
- 1.4, SAX 1.0
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
characters
(char[] ch, int start, int length) Deprecated.Receive notification of character data inside an element.void
Deprecated.Receive notification of the end of the document.void
endElement
(String name) Deprecated.Receive notification of the end of an element.void
Deprecated.Receive notification of a recoverable parser error.void
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.resolveEntity
(String publicId, String systemId) Deprecated.Resolve an external entity.void
setDocumentLocator
(Locator locator) Deprecated.Receive a Locator object for document events.void
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
Deprecated.Receive notification of a parser warning.
-
Constructor Details
-
HandlerBase
public HandlerBase()Deprecated.Creates aHandlerBase
.
-
-
Method Details
-
resolveEntity
Deprecated.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.
- Specified by:
resolveEntity
in interfaceEntityResolver
- Parameters:
publicId
- The public identifier, or null if none is available.systemId
- The system identifier provided in the XML document.- Returns:
- The new input source, or null to require the default behaviour.
- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.- See Also:
-
notationDecl
Deprecated.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.
- Specified by:
notationDecl
in interfaceDTDHandler
- Parameters:
name
- The notation name.publicId
- The notation public identifier, or null if not available.systemId
- The notation system identifier.- See Also:
-
unparsedEntityDecl
Deprecated.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.
- Specified by:
unparsedEntityDecl
in interfaceDTDHandler
- Parameters:
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.- See Also:
-
setDocumentLocator
Deprecated.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.
- Specified by:
setDocumentLocator
in interfaceDocumentHandler
- Parameters:
locator
- A locator for all SAX document events.- See Also:
-
startDocument
Deprecated.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).
- Specified by:
startDocument
in interfaceDocumentHandler
- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.- See Also:
-
endDocument
Deprecated.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).
- Specified by:
endDocument
in interfaceDocumentHandler
- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.- See Also:
-
startElement
Deprecated.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).
- Specified by:
startElement
in interfaceDocumentHandler
- Parameters:
name
- The element type name.attributes
- The specified or defaulted attributes.- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.- See Also:
-
endElement
Deprecated.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).
- Specified by:
endElement
in interfaceDocumentHandler
- Parameters:
name
- the element name- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.- See Also:
-
characters
Deprecated.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).
- Specified by:
characters
in interfaceDocumentHandler
- Parameters:
ch
- The characters.start
- The start position in the character array.length
- The number of characters to use from the character array.- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.- See Also:
-
ignorableWhitespace
Deprecated.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).
- Specified by:
ignorableWhitespace
in interfaceDocumentHandler
- Parameters:
ch
- The whitespace characters.start
- The start position in the character array.length
- The number of characters to use from the character array.- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.- See Also:
-
processingInstruction
Deprecated.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.
- Specified by:
processingInstruction
in interfaceDocumentHandler
- Parameters:
target
- The processing instruction target.data
- The processing instruction data, or null if none is supplied.- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.- See Also:
-
warning
Deprecated.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.
- Specified by:
warning
in interfaceErrorHandler
- Parameters:
e
- The warning information encoded as an exception.- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.- See Also:
-
error
Deprecated.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.
- Specified by:
error
in interfaceErrorHandler
- Parameters:
e
- The warning information encoded as an exception.- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.- See Also:
-
fatalError
Deprecated.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.
- Specified by:
fatalError
in interfaceErrorHandler
- Parameters:
e
- The error information encoded as an exception.- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.- See Also:
-
DocumentHandler
interface. It has been replaced by the SAX2DefaultHandler
class.