Added in API level 1

DefaultHandler2

open class DefaultHandler2 : DefaultHandler, DeclHandler, EntityResolver2, LexicalHandler

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

This class extends the SAX2 base handler class to support the SAX2 LexicalHandler, DeclHandler, and EntityResolver2 extensions. Except for overriding the original SAX1 resolveEntity() method the added handler methods just return. Subclassers may override everything on a method-by-method basis. This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY.

Note: this class might yet learn that the ContentHandler.setDocumentLocator() call might be passed a Locator2 object, and that the ContentHandler.startElement() call might be passed a Attributes2 object.

Summary

Public constructors
`DefaultHandler2()` Constructs a handler which ignores all parsing events.

Public methods
open Unit	`attributeDecl(eName: String!, aName: String!, type: String!, mode: String!, value: String!)` Report an attribute type declaration.
open Unit	`comment(ch: CharArray!, start: Int, length: Int)` Report an XML comment anywhere in the document.
open Unit	`elementDecl(name: String!, model: String!)` Report an element type declaration.
open Unit	`endCDATA()` Report the end of a CDATA section.
open Unit	`endDTD()` Report the end of DTD declarations.
open Unit	`endEntity(name: String!)` Report the end of an entity.
open Unit	`externalEntityDecl(name: String!, publicId: String!, systemId: String!)` Report a parsed external entity declaration.
open InputSource!	`getExternalSubset(name: String!, baseURI: String!)` Tells the parser that if no external subset has been declared in the document text, none should be used.
open Unit	`internalEntityDecl(name: String!, value: String!)` Report an internal entity declaration.
open InputSource!	`resolveEntity(publicId: String!, systemId: String!)` Invokes org.
open InputSource!	`resolveEntity(name: String!, publicId: String!, baseURI: String!, systemId: String!)` Tells the parser to resolve the systemId against the baseURI and read the entity text from that resulting absolute URI.
open Unit	`startCDATA()` Report the start of a CDATA section.
open Unit	`startDTD(name: String!, publicId: String!, systemId: String!)` Report the start of DTD declarations, if any.
open Unit	`startEntity(name: String!)` Report the beginning of some internal and external XML entities.

Inherited functions

From class DefaultHandler

`Unit`	`characters(ch: CharArray!, start: Int, length: Int)` 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).
`Unit`	`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).
`Unit`	`endElement(uri: String!, localName: String!, qName: String!)` 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).
`Unit`	`endPrefixMapping(prefix: String!)` 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.
`Unit`	`error(e: SAXParseException!)` 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.
`Unit`	`fatalError(e: SAXParseException!)` 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.
`Unit`	`ignorableWhitespace(ch: CharArray!, start: Int, length: Int)` 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).
`Unit`	`notationDecl(name: String!, publicId: String!, systemId: String!)` 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.
`Unit`	`processingInstruction(target: String!, data: String!)` 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.
`Unit`	`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.
`Unit`	`skippedEntity(name: String!)` 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.
`Unit`	`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).
`Unit`	`startElement(uri: String!, localName: String!, qName: String!, attributes: 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).
`Unit`	`startPrefixMapping(prefix: String!, uri: String!)` 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).
`Unit`	`unparsedEntityDecl(name: String!, publicId: String!, systemId: String!, notationName: String!)` 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.
`Unit`	`warning(e: SAXParseException!)` 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.

Public constructors

DefaultHandler2

Added in API level 1

DefaultHandler2()

Constructs a handler which ignores all parsing events.

Public methods

attributeDecl

Added in API level 1

open fun attributeDecl(
    eName: String!, 
    aName: String!, 
    type: String!, 
    mode: String!, 
    value: String!
): Unit

Report an attribute type declaration.

Only the effective (first) declaration for an attribute will be reported. The type will be one of the strings "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", a parenthesized token group with the separator "|" and all whitespace removed, or the word "NOTATION" followed by a space followed by a parenthesized token group with all whitespace removed.

The value will be the value as reported to applications, appropriately normalized and with entity and character references expanded.

Parameters
`eName`	String!: The name of the associated element.
`aName`	String!: The name of the attribute.
`type`	String!: A string representing the attribute type.
`mode`	String!: A string representing the attribute defaulting mode ("#IMPLIED", "#REQUIRED", or "#FIXED") or null if none of these applies.
`value`	String!: A string representing the attribute's default value, or null if there is none.

Exceptions
`org.xml.sax.SAXException`	The application may raise an exception.

comment

Added in API level 1

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

Report an XML comment anywhere in the document.

This callback will be used for comments inside or outside the document element, including comments in the external DTD subset (if read). Comments in the DTD must be properly nested inside start/endDTD and start/endEntity events (if used).

Parameters
`ch`	CharArray!: An array holding the characters in the comment.
`start`	Int: The starting position in the array.
`length`	Int: The number of characters to use from the array.

Exceptions
`org.xml.sax.SAXException`	The application may raise an exception.

elementDecl

Added in API level 1

open fun elementDecl(
    name: String!, 
    model: String!
): Unit

Report an element type declaration.

The content model will consist of the string "EMPTY", the string "ANY", or a parenthesised group, optionally followed by an occurrence indicator. The model will be normalized so that all parameter entities are fully resolved and all whitespace is removed,and will include the enclosing parentheses. Other normalization (such as removing redundant parentheses or simplifying occurrence indicators) is at the discretion of the parser.

Parameters
`name`	String!: The element type name.
`model`	String!: The content model as a normalized string.

Exceptions
`org.xml.sax.SAXException`	The application may raise an exception.

endCDATA

Added in API level 1

open fun endCDATA(): Unit

Report the end of a CDATA section.

Exceptions
`org.xml.sax.SAXException`	The application may raise an exception.

endDTD

Added in API level 1

open fun endDTD(): Unit

Report the end of DTD declarations.

This method is intended to report the end of the DOCTYPE declaration; if the document has no DOCTYPE declaration, this method will not be invoked.

Exceptions
`org.xml.sax.SAXException`	The application may raise an exception.

endEntity

Added in API level 1

open fun endEntity(name: String!): Unit

Report the end of an entity.

Parameters
`name`	String!: The name of the entity that is ending.

Exceptions
`org.xml.sax.SAXException`	The application may raise an exception.

externalEntityDecl

Added in API level 1

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

Report a parsed external entity declaration.

Only the effective (first) declaration for each entity will be reported.

If the system identifier is a URL, the parser must resolve it fully before passing it to the application.

Parameters
`name`	String!: The name of the entity. If it is a parameter entity, the name will begin with '%'.
`publicId`	String!: The entity's public identifier, or null if none was given.
`systemId`	String!: The entity's system identifier.

Exceptions
`org.xml.sax.SAXException`	The application may raise an exception.

getExternalSubset

Added in API level 1

open fun getExternalSubset(
    name: String!, 
    baseURI: String!
): InputSource!

Tells the parser that if no external subset has been declared in the document text, none should be used.

Parameters
`name`	String!: Identifies the document root element. This name comes from a DOCTYPE declaration (where available) or from the actual root element. The parameter is ignored.
`baseURI`	String!: The document's base URI, serving as an additional hint for selecting the external subset. This is always an absolute URI, unless it is null because the XMLReader was given an InputSource without one. The parameter is ignored.

Return
`InputSource!`	null (always).

Exceptions
`java.io.IOException`	Probably indicating a failure to create a new InputStream or Reader, or an illegal URL.
`org.xml.sax.SAXException`	Any SAX exception, possibly wrapping another exception.

internalEntityDecl

Added in API level 1

open fun internalEntityDecl(
    name: String!, 
    value: String!
): Unit

Report an internal entity declaration.

Only the effective (first) declaration for each entity will be reported. All parameter entities in the value will be expanded, but general entities will not.

Parameters
`name`	String!: The name of the entity. If it is a parameter entity, the name will begin with '%'.
`value`	String!: The replacement text of the entity.

Exceptions
`org.xml.sax.SAXException`	The application may raise an exception.

resolveEntity

Added in API level 1

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

Invokes org.xml.sax.ext.EntityResolver2#resolveEntity with null entity name and base URI. You only need to override that method to use this class.

Parameters
`publicId`	String!: The public identifier of the external entity being referenced (normalized as required by the XML specification), or null if none was supplied.
`systemId`	String!: The system identifier of the external entity being referenced; either a relative or absolute URI. This is never null when invoked by a SAX2 parser; only declared entities, and any external subset, are resolved by such parsers.

Return
`InputSource!`	An InputSource object describing the new input source.

Exceptions
`java.io.IOException`	Probably indicating a failure to create a new InputStream or Reader, or an illegal URL.
`org.xml.sax.SAXException`	Any SAX exception, possibly wrapping another exception.

resolveEntity

Added in API level 1

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

Tells the parser to resolve the systemId against the baseURI and read the entity text from that resulting absolute URI. Note that because the older DefaultHandler.resolveEntity(), method is overridden to call this one, this method may sometimes be invoked with null name and baseURI, and with the systemId already absolutized.

Parameters
`name`	String!: Identifies the external entity being resolved. Either "[dtd]" for the external subset, or a name starting with "%" to indicate a parameter entity, or else the name of a general entity. This is never null when invoked by a SAX2 parser.
`publicId`	String!: The public identifier of the external entity being referenced (normalized as required by the XML specification), or null if none was supplied.
`baseURI`	String!: The URI with respect to which relative systemIDs are interpreted. This is always an absolute URI, unless it is null (likely because the XMLReader was given an InputSource without one). This URI is defined by the XML specification to be the one associated with the "<" starting the relevant declaration.
`systemId`	String!: The system identifier of the external entity being referenced; either a relative or absolute URI. This is never null when invoked by a SAX2 parser; only declared entities, and any external subset, are resolved by such parsers.

Return
`InputSource!`	An InputSource object describing the new input source.

Exceptions
`java.io.IOException`	Probably indicating a failure to create a new InputStream or Reader, or an illegal URL.
`org.xml.sax.SAXException`	Any SAX exception, possibly wrapping another exception.

startCDATA

Added in API level 1

open fun startCDATA(): Unit

Report the start of a CDATA section.

The contents of the CDATA section will be reported through the regular characters event; this event is intended only to report the boundary.

Exceptions
`org.xml.sax.SAXException`	The application may raise an exception.

startDTD

Added in API level 1

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

Report the start of DTD declarations, if any.

This method is intended to report the beginning of the DOCTYPE declaration; if the document has no DOCTYPE declaration, this method will not be invoked.

All declarations reported through DTDHandler or DeclHandler events must appear between the startDTD and endDTD events. Declarations are assumed to belong to the internal DTD subset unless they appear between startEntity and endEntity events. Comments and processing instructions from the DTD should also be reported between the startDTD and endDTD events, in their original order of (logical) occurrence; they are not required to appear in their correct locations relative to DTDHandler or DeclHandler events, however.

Note that the start/endDTD events will appear within the start/endDocument events from ContentHandler and before the first startElement event.

Parameters
`name`	String!: The document type name.
`publicId`	String!: The declared public identifier for the external DTD subset, or null if none was declared.
`systemId`	String!: The declared system identifier for the external DTD subset, or null if none was declared. (Note that this is not resolved against the document base URI.)

Exceptions
`org.xml.sax.SAXException`	The application may raise an exception.

startEntity

Added in API level 1

open fun startEntity(name: String!): Unit

Report the beginning of some internal and external XML entities.

The reporting of parameter entities (including the external DTD subset) is optional, and SAX2 drivers that report LexicalHandler events may not implement it; you can use the http://xml.org/sax/features/lexical-handler/parameter-entities feature to query or control the reporting of parameter entities.

General entities are reported with their regular names, parameter entities have '%' prepended to their names, and the external DTD subset has the pseudo-entity name "[dtd]".

When a SAX2 driver is providing these events, all other events must be properly nested within start/end entity events. There is no additional requirement that events from DeclHandler or DTDHandler be properly ordered.

Note that skipped entities will be reported through the skippedEntity event, which is part of the ContentHandler interface.

Because of the streaming event model that SAX uses, some entity boundaries cannot be reported under any circumstances:

general entities within attribute values
parameter entities within declarations

These will be silently expanded, with no indication of where the original entity boundaries were.

Note also that the boundaries of character references (which are not really entities anyway) are not reported.

All start/endEntity events must be properly nested.

Parameters
`name`	String!: The name of the entity. If it is a parameter entity, the name will begin with '%', and if it is the external DTD subset, it will be "[dtd]".

Exceptions
`org.xml.sax.SAXException`	The application may raise an exception.