APIdia Launch Partner
Top Description Constructors Methods
org.xml.sax.helpers

public Class DefaultHandler

extends Object
implements EntityResolver, DTDHandler, ContentHandler, ErrorHandler
Class Inheritance
All Implemented Interfaces
org.xml.sax.ErrorHandler, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver
Known Direct Subclasses
com.sun.org.apache.xml.internal.utils.StylesheetPIHandler, com.sun.org.apache.xalan.internal.xsltc.trax.SAX2StAXBaseWriter, com.sun.org.apache.xerces.internal.jaxp.DefaultValidationErrorHandler, com.sun.org.apache.xerces.internal.jaxp.JAXPValidatorComponent.SAX2XNI, javax.xml.catalog.CatalogReader, org.xml.sax.ext.DefaultHandler2
Imports
java.io.IOException, org.xml.sax.InputSource, .Locator, .Attributes, .EntityResolver, .DTDHandler, .ContentHandler, .ErrorHandler, .SAXException, .SAXParseException

Default base class for SAX2 event handlers.

This class is available as a convenience base class for SAX2 applications: it provides default implementations for all of the callbacks in the four core SAX2 handler classes:

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.

This class replaces the deprecated SAX1 HandlerBase class.

Author
David Megginson,
Since
1.4, SAX 2.0
See Also
org.xml.sax.EntityResolver, org.xml.sax.DTDHandler, org.xml.sax.ContentHandler, org.xml.sax.ErrorHandler

Constructor Summary

AccessConstructor and Description
public
DefaultHandler()

Constructs a DefaultHandler.

Method Summary

Modifier and TypeMethod and Description
public void
characters(char[]
The characters.
ch
,
int
The start position in the character array.
start
,
int
The number of characters to use from the character array.
length
)

Implements org.xml.sax.ContentHandler.characters.

Receive notification of character data inside an element.

public void
endDocument()

Implements org.xml.sax.ContentHandler.endDocument.

Receive notification of the end of the document.

public void
endElement(String
The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
uri
,
String
The local name (without prefix), or the empty string if Namespace processing is not being performed.
localName
,
String
The qualified name (with prefix), or the empty string if qualified names are not available.
qName
)

Implements org.xml.sax.ContentHandler.endElement.

Receive notification of the end of an element.

public void
endPrefixMapping(String
The Namespace prefix being declared.
prefix
)

Implements org.xml.sax.ContentHandler.endPrefixMapping.

Receive notification of the end of a Namespace mapping.

public void
error(SAXParseException
The error information encoded as an exception.
e
)

Implements org.xml.sax.ErrorHandler.error.

Receive notification of a recoverable parser error.

public void
fatalError(SAXParseException
The error information encoded as an exception.
e
)

Implements org.xml.sax.ErrorHandler.fatalError.

Report a fatal XML parsing error.

public void
ignorableWhitespace(char[]
The whitespace characters.
ch
,
int
The start position in the character array.
start
,
int
The number of characters to use from the character array.
length
)

Implements org.xml.sax.ContentHandler.ignorableWhitespace.

Receive notification of ignorable whitespace in element content.

public void
notationDecl(String
The notation name.
name
,
String
The notation public identifier, or null if not available.
publicId
,
String
The notation system identifier.
systemId
)

Implements org.xml.sax.DTDHandler.notationDecl.

Receive notification of a notation declaration.

public void
processingInstruction(String
The processing instruction target.
target
,
String
The processing instruction data, or null if none is supplied.
data
)

Implements org.xml.sax.ContentHandler.processingInstruction.

Receive notification of a processing instruction.

public InputSource

Returns:

The new input source, or null to require the default behaviour.
resolveEntity
(String
The public identifier, or null if none is available.
publicId
,
String
The system identifier provided in the XML document.
systemId
)

Implements org.xml.sax.EntityResolver.resolveEntity.

Resolve an external entity.

public void
setDocumentLocator(Locator
A locator for all SAX document events.
locator
)

Implements org.xml.sax.ContentHandler.setDocumentLocator.

Receive a Locator object for document events.

public void
skippedEntity(String
The name of the skipped entity.
name
)

Implements org.xml.sax.ContentHandler.skippedEntity.

Receive notification of a skipped entity.

public void
startDocument()

Implements org.xml.sax.ContentHandler.startDocument.

Receive notification of the beginning of the document.

public void
startElement(String
The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
uri
,
String
The local name (without prefix), or the empty string if Namespace processing is not being performed.
localName
,
String
The qualified name (with prefix), or the empty string if qualified names are not available.
qName
,
Attributes
The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.
attributes
)

Implements org.xml.sax.ContentHandler.startElement.

Receive notification of the start of an element.

public void
startPrefixMapping(String
The Namespace prefix being declared.
prefix
,
String
The Namespace URI mapped to the prefix.
uri
)

Implements org.xml.sax.ContentHandler.startPrefixMapping.

Receive notification of the start of a Namespace mapping.

public void
unparsedEntityDecl(String
The entity name.
name
,
String
The entity public identifier, or null if not available.
publicId
,
String
The entity system identifier.
systemId
,
String
The name of the associated notation.
notationName
)

Implements org.xml.sax.DTDHandler.unparsedEntityDecl.

Receive notification of an unparsed entity declaration.

public void
warning(SAXParseException
The warning information encoded as an exception.
e
)

Implements org.xml.sax.ErrorHandler.warning.

Receive notification of a parser warning.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

DefaultHandlerback to summary
public DefaultHandler()

Constructs a DefaultHandler.

Method Detail

charactersback to summary
public void characters(char[] ch, int start, int length) throws SAXException

Implements org.xml.sax.ContentHandler.characters.

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.

Annotations
@Override
Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
See Also
org.xml.sax.ContentHandler#characters
endDocumentback to summary
public void endDocument() throws SAXException

Implements org.xml.sax.ContentHandler.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 end of a document (such as finalising a tree or closing an output file).

Annotations
@Override
Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
See Also
org.xml.sax.ContentHandler#endDocument
endElementback to summary
public void endElement(String uri, String localName, String qName) throws SAXException

Implements org.xml.sax.ContentHandler.endElement.

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
uri:String

The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.

localName:String

The local name (without prefix), or the empty string if Namespace processing is not being performed.

qName:String

The qualified name (with prefix), or the empty string if qualified names are not available.

Annotations
@Override
Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
See Also
org.xml.sax.ContentHandler#endElement
endPrefixMappingback to summary
public void endPrefixMapping(String prefix) throws SAXException

Implements org.xml.sax.ContentHandler.endPrefixMapping.

Receive notification of the end of a Namespace mapping.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each prefix mapping.

Parameters
prefix:String

The Namespace prefix being declared.

Annotations
@Override
Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
See Also
org.xml.sax.ContentHandler#endPrefixMapping
errorback to summary
public void error(SAXParseException e) throws SAXException

Implements org.xml.sax.ErrorHandler.error.

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

Annotations
@Override
Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
See Also
org.xml.sax.ErrorHandler#warning, org.xml.sax.SAXParseException
fatalErrorback to summary
public void fatalError(SAXParseException e) throws SAXException

Implements org.xml.sax.ErrorHandler.fatalError.

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.

Annotations
@Override
Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
See Also
org.xml.sax.ErrorHandler#fatalError, org.xml.sax.SAXParseException
ignorableWhitespaceback to summary
public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException

Implements org.xml.sax.ContentHandler.ignorableWhitespace.

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.

Annotations
@Override
Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
See Also
org.xml.sax.ContentHandler#ignorableWhitespace
notationDeclback to summary
public void notationDecl(String name, String publicId, String systemId) throws SAXException

Implements org.xml.sax.DTDHandler.notationDecl.

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.

Annotations
@Override
Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
See Also
org.xml.sax.DTDHandler#notationDecl
processingInstructionback to summary
public void processingInstruction(String target, String data) throws SAXException

Implements org.xml.sax.ContentHandler.processingInstruction.

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.

Annotations
@Override
Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
See Also
org.xml.sax.ContentHandler#processingInstruction
resolveEntityback to summary
public InputSource resolveEntity(String publicId, String systemId) throws IOException, SAXException

Implements org.xml.sax.EntityResolver.resolveEntity.

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

Annotations
@Override
Exceptions
IOException:
If there is an error setting up the new input source.
SAXException:
Any SAX exception, possibly wrapping another exception.
See Also
org.xml.sax.EntityResolver#resolveEntity
setDocumentLocatorback to summary
public void setDocumentLocator(Locator locator)

Implements org.xml.sax.ContentHandler.setDocumentLocator.

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.

Annotations
@Override
See Also
org.xml.sax.ContentHandler#setDocumentLocator, org.xml.sax.Locator
skippedEntityback to summary
public void skippedEntity(String name) throws SAXException

Implements org.xml.sax.ContentHandler.skippedEntity.

Receive notification of a skipped entity.

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
name:String

The name of the skipped entity.

Annotations
@Override
Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
See Also
org.xml.sax.ContentHandler#processingInstruction
startDocumentback to summary
public void startDocument() throws SAXException

Implements org.xml.sax.ContentHandler.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).

Annotations
@Override
Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
See Also
org.xml.sax.ContentHandler#startDocument
startElementback to summary
public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException

Implements org.xml.sax.ContentHandler.startElement.

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
uri:String

The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.

localName:String

The local name (without prefix), or the empty string if Namespace processing is not being performed.

qName:String

The qualified name (with prefix), or the empty string if qualified names are not available.

attributes:Attributes

The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.

Annotations
@Override
Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
See Also
org.xml.sax.ContentHandler#startElement
startPrefixMappingback to summary
public void startPrefixMapping(String prefix, String uri) throws SAXException

Implements org.xml.sax.ContentHandler.startPrefixMapping.

Receive notification of the start of a Namespace mapping.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each Namespace prefix scope (such as storing the prefix mapping).

Parameters
prefix:String

The Namespace prefix being declared.

uri:String

The Namespace URI mapped to the prefix.

Annotations
@Override
Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
See Also
org.xml.sax.ContentHandler#startPrefixMapping
unparsedEntityDeclback to summary
public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName) throws SAXException

Implements org.xml.sax.DTDHandler.unparsedEntityDecl.

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.

Annotations
@Override
Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
See Also
org.xml.sax.DTDHandler#unparsedEntityDecl
warningback to summary
public void warning(SAXParseException e) throws SAXException

Implements org.xml.sax.ErrorHandler.warning.

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.

Annotations
@Override
Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
See Also
org.xml.sax.ErrorHandler#warning, org.xml.sax.SAXParseException