All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class org.xml.sax.HandlerBase

java.lang.Object
   |
   +----org.xml.sax.HandlerBase

public class HandlerBase
extends Object
implements EntityResolver, DTDHandler, DocumentHandler, ErrorHandler
Default base class for handlers.

This class implements the default behaviour for four SAX interfaces: EntityResolver, DTDHandler, DocumentHandler, and ErrorHandler.

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

Constructor Index

 o HandlerBase()

Method Index

 o characters(char[], int, int)
Receive notification of character data inside an element.
 o endDocument()
Receive notification of the end of the document.
 o endElement(String)
Receive notification of the end of an element.
 o error(SAXParseException)
Receive notification of a recoverable parser error.
 o fatalError(SAXParseException)
Report a fatal XML parsing error.
 o ignorableWhitespace(char[], int, int)
Receive notification of ignorable whitespace in element content.
 o notationDecl(String, String, String)
Receive notification of a notation declaration.
 o processingInstruction(String, String)
Receive notification of a processing instruction.
 o resolveEntity(String, String)
Resolve an external entity.
 o setDocumentLocator(Locator)
Receive a Locator object for document events.
 o startDocument()
Receive notification of the beginning of the document.
 o startElement(String, AttributeList)
Receive notification of the start of an element.
 o unparsedEntityDecl(String, String, String, String)
Receive notification of an unparsed entity declaration.
 o warning(SAXParseException)
Receive notification of a parser warning.

Constructors

 o HandlerBase
 public HandlerBase()

Methods

 o resolveEntity
 public InputSource resolveEntity(String publicId,
                                  String systemId) throws SAXException
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 identifer, 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:
resolveEntity
 o notationDecl
 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:
notationDecl
 o unparsedEntityDecl
 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:
unparsedEntityDecl
 o setDocumentLocator
 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:
setDocumentLocator, Locator
 o startDocument
 public void startDocument() throws SAXException
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:
startDocument
 o endDocument
 public void endDocument() throws SAXException
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:
endDocument
 o startElement
 public void startElement(String name,
                          AttributeList attributes) throws SAXException
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:
startElement
 o endElement
 public void endElement(String name) throws SAXException
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 type name.
attributes - The specified or defaulted attributes.
Throws: SAXException
Any SAX exception, possibly wrapping another exception.
See Also:
endElement
 o characters
 public void characters(char ch[],
                        int start,
                        int length) throws SAXException
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:
characters
 o ignorableWhitespace
 public void ignorableWhitespace(char ch[],
                                 int start,
                                 int length) throws SAXException
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:
ignorableWhitespace
 o processingInstruction
 public void processingInstruction(String target,
                                   String data) throws SAXException
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:
processingInstruction
 o warning
 public void warning(SAXParseException e) throws SAXException
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:
warning, SAXParseException
 o error
 public void error(SAXParseException e) throws SAXException
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:
warning, SAXParseException
 o fatalError
 public void fatalError(SAXParseException e) throws SAXException
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:
fatalError, SAXParseException

All Packages  Class Hierarchy  This Package  Previous  Next  Index