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

public Class HandlerBase

extends Object
implements EntityResolver, DTDHandler, DocumentHandler, ErrorHandler
Class Inheritance
All Implemented Interfaces
org.xml.sax.ErrorHandler, org.xml.sax.DocumentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver
Annotations
@Deprecated
since:1.5

Deprecated

since 1.5.

This class works with the deprecated DocumentHandler interface. It has been replaced by the SAX2 DefaultHandler class.

Default base class for handlers.

This class implements the default behavior 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.

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

Constructor Summary

AccessConstructor and Description
public
HandlerBase()

Creates a HandlerBase.

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

Receive notification of character data inside an element.

public void
endDocument()

Implements org.xml.sax.DocumentHandler.endDocument.

Receive notification of the end of the document.

public void
endElement(String
the element name
name
)

Implements org.xml.sax.DocumentHandler.endElement.

Receive notification of the end of an element.

public void
error(SAXParseException
The warning 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.DocumentHandler.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.DocumentHandler.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.DocumentHandler.setDocumentLocator.

Receive a Locator object for document events.

public void
startDocument()

Implements org.xml.sax.DocumentHandler.startDocument.

Receive notification of the beginning of the document.

public void
startElement(String
The element type name.
name
,
AttributeList
The specified or defaulted attributes.
attributes
)

Implements org.xml.sax.DocumentHandler.startElement.

References Deprecated AttributeList is deprecated or references (maybe indirectly) at least one deprecated element.

Receive notification of the start of an element.

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

HandlerBaseback to summary
public HandlerBase()

Creates a HandlerBase.

Method Detail

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

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

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

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

Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
See Also
org.xml.sax.DocumentHandler#endDocument
endElementback to summary
public void endElement(String name) throws SAXException

Implements org.xml.sax.DocumentHandler.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
name:String

the element name

Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
See Also
org.xml.sax.DocumentHandler#endElement
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 warning information encoded as an exception.

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.

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

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

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.

See Also
org.xml.sax.DTDHandler#notationDecl
processingInstructionback to summary
public void processingInstruction(String target, String data) throws SAXException

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

Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
See Also
org.xml.sax.DocumentHandler#processingInstruction
resolveEntityback to summary
public InputSource resolveEntity(String publicId, String systemId) throws 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.

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

See Also
org.xml.sax.DocumentHandler#setDocumentLocator, org.xml.sax.Locator
startDocumentback to summary
public void startDocument() throws SAXException

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

Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
See Also
org.xml.sax.DocumentHandler#startDocument
startElementback to summary
public void startElement(String name, AttributeList attributes) throws SAXException

Implements org.xml.sax.DocumentHandler.startElement.

References Deprecated

AttributeList is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

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.

Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
See Also
org.xml.sax.DocumentHandler#startElement
unparsedEntityDeclback to summary
public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName)

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.

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.

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