Added in API level 1

DefaultHandler

open class DefaultHandler : EntityResolver, DTDHandler, ContentHandler, ErrorHandler

kotlin.Any
↳	org.xml.sax.helpers.DefaultHandler

Known Direct Subclasses

DefaultHandler2

This class extends the SAX2 base handler class to support the SAX2 LexicalHandler, DeclHandler, and EntityResolver2 extensions.

Default base class for SAX2 event 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 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.

Summary

Public constructors
`DefaultHandler()`

Public methods
open Unit	`characters(ch: CharArray!, start: Int, length: Int)` Receive notification of character data inside an element.
open Unit	`endDocument()` Receive notification of the end of the document.
open Unit	`endElement(uri: String!, localName: String!, qName: String!)` Receive notification of the end of an element.
open Unit	`endPrefixMapping(prefix: String!)` Receive notification of the end of a Namespace mapping.
open Unit	`error(e: SAXParseException!)` Receive notification of a recoverable parser error.
open Unit	`fatalError(e: SAXParseException!)` Report a fatal XML parsing error.
open Unit	`ignorableWhitespace(ch: CharArray!, start: Int, length: Int)` Receive notification of ignorable whitespace in element content.
open Unit	`notationDecl(name: String!, publicId: String!, systemId: String!)` Receive notification of a notation declaration.
open Unit	`processingInstruction(target: String!, data: String!)` Receive notification of a processing instruction.
open InputSource!	`resolveEntity(publicId: String!, systemId: String!)` Resolve an external entity.
open Unit	`setDocumentLocator(locator: Locator!)` Receive a Locator object for document events.
open Unit	`skippedEntity(name: String!)` Receive notification of a skipped entity.
open Unit	`startDocument()` Receive notification of the beginning of the document.
open Unit	`startElement(uri: String!, localName: String!, qName: String!, attributes: Attributes!)` Receive notification of the start of an element.
open Unit	`startPrefixMapping(prefix: String!, uri: String!)` Receive notification of the start of a Namespace mapping.
open Unit	`unparsedEntityDecl(name: String!, publicId: String!, systemId: String!, notationName: String!)` Receive notification of an unparsed entity declaration.
open Unit	`warning(e: SAXParseException!)` Receive notification of a parser warning.

Public constructors

DefaultHandler

Added in API level 1

DefaultHandler()

Public methods

characters

Added in API level 1

open fun characters(
    ch: CharArray!, 
    start: Int, 
    length: Int
): Unit

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`	CharArray!: The characters.
`start`	Int: The start position in the character array.
`length`	Int: The number of characters to use from the character array.

Exceptions
`org.xml.sax.SAXException`	any SAX exception, possibly wrapping another exception
`org.xml.sax.SAXException`	Any SAX exception, possibly wrapping another exception.

See Also

org.xml.sax.ContentHandler#characters

endDocument

Added in API level 1

open fun endDocument(): Unit

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
`org.xml.sax.SAXException`	any SAX exception, possibly wrapping another exception
`org.xml.sax.SAXException`	Any SAX exception, possibly wrapping another exception.

See Also

org.xml.sax.ContentHandler#endDocument

endElement

Added in API level 1

open fun endElement(
    uri: String!, 
    localName: String!, 
    qName: String!
): Unit

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.

Exceptions
`org.xml.sax.SAXException`	any SAX exception, possibly wrapping another exception
`org.xml.sax.SAXException`	Any SAX exception, possibly wrapping another exception.

See Also

org.xml.sax.ContentHandler#endElement

endPrefixMapping

Added in API level 1

open fun endPrefixMapping(prefix: String!): Unit

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.

Exceptions
`org.xml.sax.SAXException`	the client may throw an exception during processing
`org.xml.sax.SAXException`	Any SAX exception, possibly wrapping another exception.

See Also

org.xml.sax.ContentHandler#endPrefixMapping

error

Added in API level 1

open fun error(e: SAXParseException!): Unit

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
`exception`	The error information encapsulated in a SAX parse exception.
`e`	SAXParseException!: The warning information encoded as an exception.

Exceptions
`org.xml.sax.SAXException`	Any SAX exception, possibly wrapping another exception.

See Also

fatalError

Added in API level 1

open fun fatalError(e: SAXParseException!): Unit

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
`exception`	The error information encapsulated in a SAX parse exception.
`e`	SAXParseException!: The error information encoded as an exception.

Exceptions
`org.xml.sax.SAXException`	Any SAX exception, possibly wrapping another exception.

See Also

ignorableWhitespace

Added in API level 1

open fun ignorableWhitespace(
    ch: CharArray!, 
    start: Int, 
    length: Int
): Unit

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`	CharArray!: 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
`org.xml.sax.SAXException`	any SAX exception, possibly wrapping another exception
`org.xml.sax.SAXException`	Any SAX exception, possibly wrapping another exception.

See Also

org.xml.sax.ContentHandler#ignorableWhitespace

notationDecl

Added in API level 1

open fun notationDecl(
    name: String!, 
    publicId: String!, 
    systemId: String!
): Unit

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.

Exceptions
`org.xml.sax.SAXException`	Any SAX exception, possibly wrapping another exception.

See Also

org.xml.sax.DTDHandler#notationDecl

processingInstruction

Added in API level 1

open fun processingInstruction(
    target: String!, 
    data: String!
): Unit

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
`org.xml.sax.SAXException`	any SAX exception, possibly wrapping another exception
`org.xml.sax.SAXException`	Any SAX exception, possibly wrapping another exception.

See Also

org.xml.sax.ContentHandler#processingInstruction

resolveEntity

Added in API level 1

open fun resolveEntity(
    publicId: String!, 
    systemId: String!
): InputSource!

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.

Return
`InputSource!`	The new input source, or null to require the default behaviour.

Exceptions
`java.io.IOException`	If there is an error setting up the new input source.
`org.xml.sax.SAXException`	Any SAX exception, possibly wrapping another exception.

See Also

org.xml.sax.EntityResolver#resolveEntity

setDocumentLocator

Added in API level 1

open fun setDocumentLocator(locator: Locator!): Unit

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

skippedEntity

Added in API level 1

open fun skippedEntity(name: String!): Unit

Receive notification of a skipped entity.

Parameters
`name`	String!: The name of the skipped entity.

Exceptions
`org.xml.sax.SAXException`	any SAX exception, possibly wrapping another exception
`org.xml.sax.SAXException`	Any SAX exception, possibly wrapping another exception.

See Also

org.xml.sax.ContentHandler#processingInstruction

startDocument

Added in API level 1

open fun startDocument(): Unit

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
`org.xml.sax.SAXException`	any SAX exception, possibly wrapping another exception
`org.xml.sax.SAXException`	Any SAX exception, possibly wrapping another exception.

See Also

org.xml.sax.ContentHandler#startDocument

startElement

Added in API level 1

open fun startElement(
    uri: String!, 
    localName: String!, 
    qName: String!, 
    attributes: Attributes!
): Unit

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.
`atts`	the attributes attached to the element. If there are no attributes, it shall be an empty Attributes object. The value of this object after startElement returns is undefined
`attributes`	Attributes!: The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.

Exceptions
`org.xml.sax.SAXException`	any SAX exception, possibly wrapping another exception
`org.xml.sax.SAXException`	Any SAX exception, possibly wrapping another exception.

See Also

org.xml.sax.ContentHandler#startElement

startPrefixMapping

Added in API level 1

open fun startPrefixMapping(
    prefix: String!, 
    uri: String!
): Unit

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.

Exceptions
`org.xml.sax.SAXException`	the client may throw an exception during processing
`org.xml.sax.SAXException`	Any SAX exception, possibly wrapping another exception.

See Also

org.xml.sax.ContentHandler#startPrefixMapping

unparsedEntityDecl

Added in API level 1

open fun unparsedEntityDecl(
    name: String!, 
    publicId: String!, 
    systemId: String!, 
    notationName: String!
): Unit

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.

Exceptions
`org.xml.sax.SAXException`	Any SAX exception, possibly wrapping another exception.

See Also

org.xml.sax.DTDHandler#unparsedEntityDecl

warning

Added in API level 1

open fun warning(e: SAXParseException!): Unit

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
`exception`	The warning information encapsulated in a SAX parse exception.
`e`	SAXParseException!: The warning information encoded as an exception.

Exceptions
`org.xml.sax.SAXException`	Any SAX exception, possibly wrapping another exception.

See Also