FileDocCategorySizeDatePackage
HandlerBase.javaAPI DocJava SE 5 API12728Fri Aug 26 14:58:42 BST 2005org.xml.sax

HandlerBase

public class HandlerBase extends Object implements ErrorHandler, DocumentHandler, EntityResolver, DTDHandler
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 {@link org.xml.sax.helpers.DefaultHandler 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.

deprecated
This class works with the deprecated {@link org.xml.sax.DocumentHandler DocumentHandler} interface. It has been replaced by the SAX2 {@link org.xml.sax.helpers.DefaultHandler DefaultHandler} class.
since
SAX 1.0
author
David Megginson
version
2.0.1 (sax2r2)
see
org.xml.sax.EntityResolver
see
org.xml.sax.DTDHandler
see
org.xml.sax.DocumentHandler
see
org.xml.sax.ErrorHandler

Fields Summary
Constructors Summary
Methods Summary
public voidcharacters(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).

param
ch The characters.
param
start The start position in the character array.
param
length The number of characters to use from the character array.
exception
org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.
see
org.xml.sax.DocumentHandler#characters

	// no op
    
public voidendDocument()
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).

exception
org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.
see
org.xml.sax.DocumentHandler#endDocument

	// no op
    
public voidendElement(java.lang.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).

param
name the element name
exception
org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.
see
org.xml.sax.DocumentHandler#endElement

	// no op
    
public voiderror(org.xml.sax.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.

param
e The warning information encoded as an exception.
exception
org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.
see
org.xml.sax.ErrorHandler#warning
see
org.xml.sax.SAXParseException

	// no op
    
public voidfatalError(org.xml.sax.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.

param
e The error information encoded as an exception.
exception
org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.
see
org.xml.sax.ErrorHandler#fatalError
see
org.xml.sax.SAXParseException

	throw e;
    
public voidignorableWhitespace(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).

param
ch The whitespace characters.
param
start The start position in the character array.
param
length The number of characters to use from the character array.
exception
org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.
see
org.xml.sax.DocumentHandler#ignorableWhitespace

	// no op
    
public voidnotationDecl(java.lang.String name, java.lang.String publicId, java.lang.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.

param
name The notation name.
param
publicId The notation public identifier, or null if not available.
param
systemId The notation system identifier.
see
org.xml.sax.DTDHandler#notationDecl

	// no op
    
public voidprocessingInstruction(java.lang.String target, java.lang.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.

param
target The processing instruction target.
param
data The processing instruction data, or null if none is supplied.
exception
org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.
see
org.xml.sax.DocumentHandler#processingInstruction

	// no op
    
public org.xml.sax.InputSourceresolveEntity(java.lang.String publicId, java.lang.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.

param
publicId The public identifer, or null if none is available.
param
systemId The system identifier provided in the XML document.
return
The new input source, or null to require the default behaviour.
exception
org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.
see
org.xml.sax.EntityResolver#resolveEntity

	return null;
    
public voidsetDocumentLocator(org.xml.sax.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.

param
locator A locator for all SAX document events.
see
org.xml.sax.DocumentHandler#setDocumentLocator
see
org.xml.sax.Locator

	// no op
    
public voidstartDocument()
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).

exception
org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.
see
org.xml.sax.DocumentHandler#startDocument

	// no op
    
public voidstartElement(java.lang.String name, org.xml.sax.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).

param
name The element type name.
param
attributes The specified or defaulted attributes.
exception
org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.
see
org.xml.sax.DocumentHandler#startElement

	// no op
    
public voidunparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.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.

param
name The entity name.
param
publicId The entity public identifier, or null if not available.
param
systemId The entity system identifier.
param
notationName The name of the associated notation.
see
org.xml.sax.DTDHandler#unparsedEntityDecl

	// no op
    
public voidwarning(org.xml.sax.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.

param
e The warning information encoded as an exception.
exception
org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.
see
org.xml.sax.ErrorHandler#warning
see
org.xml.sax.SAXParseException

	// no op