HandlerBase

public class HandlerBase extends Object
implements EntityResolver DTDHandler DocumentHandler ErrorHandler

This class is deprecated.
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

• EntityResolver
• DTDHandler
• DocumentHandler
• ErrorHandler

Public Constructor Summary

HandlerBase()

Public Method Summary

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 Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface org.xml.sax.EntityResolver

abstract InputSource

resolveEntity(String publicId, String systemId) Allow the application to resolve external entities.

From interface org.xml.sax.DTDHandler

abstract void	notationDecl(String name, String publicId, String systemId) Receive notification of a notation declaration event.
abstract void	unparsedEntityDecl(String name, String publicId, String systemId, String notationName) Receive notification of an unparsed entity declaration event.

From interface org.xml.sax.DocumentHandler

abstract void	characters(char[] ch, int start, int length) Receive notification of character data.
abstract void	endDocument() Receive notification of the end of a document.
abstract void	endElement(String name) Receive notification of the end of an element.
abstract void	ignorableWhitespace(char[] ch, int start, int length) Receive notification of ignorable whitespace in element content.
abstract void	processingInstruction(String target, String data) Receive notification of a processing instruction.
abstract void	setDocumentLocator(Locator locator) Receive an object for locating the origin of SAX document events.
abstract void	startDocument() Receive notification of the beginning of a document.
abstract void	startElement(String name, AttributeList atts) Receive notification of the beginning of an element.

From interface org.xml.sax.ErrorHandler

abstract void	error(SAXParseException exception) Receive notification of a recoverable error.
abstract void	fatalError(SAXParseException exception) Receive notification of a non-recoverable error.
abstract void	warning(SAXParseException exception) Receive notification of a warning.

Public Constructors

public HandlerBase ()

Public Methods

public 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	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

• DocumentHandler.characters(char[], int, int)

public 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

• DocumentHandler.endDocument()

public 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	the element name

Throws

SAXException	Any SAX exception, possibly wrapping another exception.

See Also

• DocumentHandler.endElement(String)

public 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	The warning information encoded as an exception.

Throws

SAXException	Any SAX exception, possibly wrapping another exception.

See Also

• ErrorHandler.warning(SAXParseException)
• SAXParseException

public 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	The error information encoded as an exception.

Throws

SAXException	Any SAX exception, possibly wrapping another exception.

See Also

• ErrorHandler.fatalError(SAXParseException)
• SAXParseException

public 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	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

• DocumentHandler.ignorableWhitespace(char[], int, int)

public 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	The notation name.
publicId	The notation public identifier, or null if not available.
systemId	The notation system identifier.

See Also

• DTDHandler.notationDecl(String, String, String)

public 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	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

• DocumentHandler.processingInstruction(String, String)

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. 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 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

• EntityResolver.resolveEntity(String, String)

public 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	A locator for all SAX document events.

See Also

• DocumentHandler.setDocumentLocator(Locator)
• Locator

public 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

• DocumentHandler.startDocument()

public 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	The element type name.
attributes	The specified or defaulted attributes.

Throws

SAXException	Any SAX exception, possibly wrapping another exception.

See Also

• DocumentHandler.startElement(String, AttributeList)

public 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	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

• DTDHandler.unparsedEntityDecl(String, String, String, String)

public 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	The warning information encoded as an exception.

Throws

SAXException	Any SAX exception, possibly wrapping another exception.

See Also

• ErrorHandler.warning(SAXParseException)
• SAXParseException