org.xml.sax.ext
public interface DeclHandler
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)
Version: 2.0.1 (sax2r2)
Method Summary | |
---|---|
abstract void | attributeDecl(String eName, String aName, String type, String mode, String value)
Report an attribute type declaration.
|
abstract void | elementDecl(String name, String model)
Report an element type declaration.
|
abstract void | externalEntityDecl(String name, String publicId, String systemId)
Report a parsed external entity declaration.
|
abstract void | internalEntityDecl(String name, String value)
Report an internal entity 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 The name of the associated element. aName The name of the attribute. type A string representing the attribute type. mode A string representing the attribute defaulting mode ("#IMPLIED", "#REQUIRED", or "#FIXED") or null if none of these applies. value A string representing the attribute's default value, or null if there is none.
Throws: SAXException The application may raise an exception.
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 The element type name. model The content model as a normalized string.
Throws: SAXException The application may raise an exception.
Only the effective (first) declaration for each entity will be reported.
Parameters: name The name of the entity. If it is a parameter entity, the name will begin with '%'. publicId The declared public identifier of the entity, or null if none was declared. systemId The declared system identifier of the entity.
Throws: SAXException The application may raise an exception.
See Also: DeclHandler DTDHandler
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 The name of the entity. If it is a parameter entity, the name will begin with '%'. value The replacement text of the entity.
Throws: SAXException The application may raise an exception.
See Also: DeclHandler DTDHandler