Added in API level 1

DeclHandler

interface DeclHandler
org.xml.sax.ext.DeclHandler

SAX2 extension handler for DTD declaration events. 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 is an optional extension handler for SAX2 to provide more complete information about DTD declarations in an XML document. XML readers are not required to recognize this handler, and it is not part of core-only SAX2 distributions.

Note that data-related DTD declarations (unparsed entities and notations) are already reported through the interface.

If you are using the declaration handler together with a lexical handler, all of the events will occur between the startDTD and the endDTD events.

To set the DeclHandler for an XML reader, use the setProperty method with the property name http://xml.org/sax/properties/declaration-handler and an object implementing this interface (or null) as the value. If the reader does not report declaration events, it will throw a SAXNotRecognizedException when you attempt to register the handler.

Summary

Public methods
abstract Unit
attributeDecl(eName: String!, aName: String!, type: String!, mode: String!, value: String!)

Report an attribute type declaration.
abstract Unit
elementDecl(name: String!, model: String!)

Report an element type declaration.
abstract Unit
externalEntityDecl(name: String!, publicId: String!, systemId: String!)

Report a parsed external entity declaration.
abstract Unit
internalEntityDecl(name: String!, value: String!)

Report an internal entity declaration.

Public methods

attributeDecl

Added in API level 1
abstract 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.

elementDecl

Added in API level 1
abstract 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.

externalEntityDecl

Added in API level 1
abstract 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.

internalEntityDecl

Added in API level 1
abstract 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.