File Doc Category Size Date Package
DeclHandler.java API Doc Java SE 5 API 5663 Fri Aug 26 14:58:42 BST 2005 org.xml.sax.ext

DeclHandler

public interface 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 {@link org.xml.sax.DTDHandler DTDHandler} interface.

If you are using the declaration handler together with a lexical handler, all of the events will occur between the {@link org.xml.sax.ext.LexicalHandler#startDTD startDTD} and the {@link org.xml.sax.ext.LexicalHandler#endDTD endDTD} events.

To set the DeclHandler for an XML reader, use the {@link org.xml.sax.XMLReader#setProperty 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 {@link org.xml.sax.SAXNotRecognizedException SAXNotRecognizedException} when you attempt to register the handler.

since: SAX 2.0 (extensions 1.0)
author: David Megginson
version: 2.0.1 (sax2r2)

Fields Summary
Constructors Summary
Methods Summary
public abstract void attributeDecl(java.lang.String eName, java.lang.String aName, java.lang.String type, java.lang.String mode, java.lang.String value)
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.
param
eName The name of the associated element.
param
aName The name of the attribute.
param
type A string representing the attribute type.
param
mode A string representing the attribute defaulting mode ("#IMPLIED", "#REQUIRED", or "#FIXED") or null if none of these applies.
param
value A string representing the attribute's default value, or null if there is none.
exception
SAXException The application may raise an exception.
public abstract void elementDecl(java.lang.String name, java.lang.String model)
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.
param
name The element type name.
param
model The content model as a normalized string.
exception
SAXException The application may raise an exception.
public abstract void externalEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
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.
param
name The name of the entity. If it is a parameter entity, the name will begin with '%'.
param
publicId The entity's public identifier, or null if none was given.
param
systemId The entity's system identifier.
exception
SAXException The application may raise an exception.
see
#internalEntityDecl
see
org.xml.sax.DTDHandler#unparsedEntityDecl
public abstract void internalEntityDecl(java.lang.String name, java.lang.String value)
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.
param
name The name of the entity. If it is a parameter entity, the name will begin with '%'.
param
value The replacement text of the entity.
exception
SAXException The application may raise an exception.
see
#externalEntityDecl
see
org.xml.sax.DTDHandler#unparsedEntityDecl