Skip to content

Most visited

Recently visited

navigation
Added in API level 1
Deprecated since API level 1

HandlerBase

public class HandlerBase
extends Object implements EntityResolver, DTDHandler, DocumentHandler, ErrorHandler

java.lang.Object
   ↳ org.xml.sax.HandlerBase


This class was deprecated in API level 1.
This class works with the deprecated DocumentHandler interface. It has been replaced by the SAX2 DefaultHandler class.

Default base class for 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 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.

See also:

Summary

Public constructors

HandlerBase()

Public methods

void characters(char[] ch, int start, int length)

Receive notification of character data inside an element.

void endDocument()

Receive notification of the end of the document.

void endElement(String name)

Receive notification of the end of an element.

void error(SAXParseException e)

Receive notification of a recoverable parser error.

void fatalError(SAXParseException e)

Report a fatal XML parsing error.

void ignorableWhitespace(char[] ch, int start, int length)

Receive notification of ignorable whitespace in element content.

void notationDecl(String name, String publicId, String systemId)

Receive notification of a notation declaration.

void processingInstruction(String target, String data)

Receive notification of a processing instruction.

InputSource resolveEntity(String publicId, String systemId)

Resolve an external entity.

void setDocumentLocator(Locator locator)

Receive a Locator object for document events.

void startDocument()

Receive notification of the beginning of the document.

void startElement(String name, AttributeList attributes)

Receive notification of the start of an element.

void unparsedEntityDecl(String name, String publicId, String systemId, String notationName)

Receive notification of an unparsed entity declaration.

void warning(SAXParseException e)

Receive notification of a parser warning.

Inherited methods

From class java.lang.Object
From interface org.xml.sax.EntityResolver
From interface org.xml.sax.DTDHandler
From interface org.xml.sax.DocumentHandler
From interface org.xml.sax.ErrorHandler

Public constructors

HandlerBase

Added in API level 1
HandlerBase ()

Public methods

characters

Added in API level 1
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).

Parameters
ch char: The characters.
start int: The start position in the character array.
length int: The number of characters to use from the character array.
Throws
SAXException Any SAX exception, possibly wrapping another exception.

See also:

endDocument

Added in API level 1
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 beginning of a document (such as finalising a tree or closing an output file).

Throws
SAXException Any SAX exception, possibly wrapping another exception.

See also:

endElement

Added in API level 1
void endElement (String name)

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 String: the element name
Throws
SAXException Any SAX exception, possibly wrapping another exception.

See also:

error

Added in API level 1
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.

Parameters
e SAXParseException: The warning information encoded as an exception.
Throws
SAXException Any SAX exception, possibly wrapping another exception.

See also:

fatalError

Added in API level 1
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.

Parameters
e SAXParseException: The error information encoded as an exception.
Throws
SAXException Any SAX exception, possibly wrapping another exception.

See also:

ignorableWhitespace

Added in API level 1
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).

Parameters
ch char: The whitespace characters.
start int: The start position in the character array.
length int: The number of characters to use from the character array.
Throws
SAXException Any SAX exception, possibly wrapping another exception.

See also:

notationDecl

Added in API level 1
void notationDecl (String name, 
                String publicId, 
                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.

Parameters
name String: The notation name.
publicId String: The notation public identifier, or null if not available.
systemId String: The notation system identifier.

See also:

processingInstruction

Added in API level 1
void processingInstruction (String target, 
                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.

Parameters
target String: The processing instruction target.
data String: The processing instruction data, or null if none is supplied.
Throws
SAXException Any SAX exception, possibly wrapping another exception.

See also:

resolveEntity

Added in API level 1
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. 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 String: The public identifer, or null if none is available.
systemId String: The system identifier provided in the XML document.
Returns
InputSource The new input source, or null to require the default behaviour.
Throws
SAXException Any SAX exception, possibly wrapping another exception.

See also:

setDocumentLocator

Added in API level 1
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.

Parameters
locator Locator: A locator for all SAX document events.

See also:

startDocument

Added in API level 1
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).

Throws
SAXException Any SAX exception, possibly wrapping another exception.

See also:

startElement

Added in API level 1
void startElement (String name, 
                AttributeList 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).

Parameters
name String: The element type name.
attributes AttributeList: The specified or defaulted attributes.
Throws
SAXException Any SAX exception, possibly wrapping another exception.

See also:

unparsedEntityDecl

Added in API level 1
void unparsedEntityDecl (String name, 
                String publicId, 
                String systemId, 
                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.

Parameters
name String: The entity name.
publicId String: The entity public identifier, or null if not available.
systemId String: The entity system identifier.
notationName String: The name of the associated notation.

See also:

warning

Added in API level 1
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.

Parameters
e SAXParseException: The warning information encoded as an exception.
Throws
SAXException Any SAX exception, possibly wrapping another exception.

See also:

This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.