-// DeclHandler.java - Optional handler for DTD declaration events.\r
-// Public Domain: no warranty.\r
-// $Id: DeclHandler.java,v 1.1 2000/10/02 02:43:19 sboag Exp $\r
-\r
-package org.xml.sax.ext;\r
-\r
-import org.xml.sax.SAXException;\r
-\r
-\r
-/**\r
- * SAX2 extension handler for DTD declaration events.\r
- *\r
- * <blockquote>\r
- * <em>This module, both source code and documentation, is in the\r
- * Public Domain, and comes with <strong>NO WARRANTY</strong>.</em>\r
- * </blockquote>\r
- *\r
- * <p>This is an optional extension handler for SAX2 to provide\r
- * information about DTD declarations in an XML document. XML\r
- * readers are not required to support this handler.</p>\r
- *\r
- * <p>Note that data-related DTD declarations (unparsed entities and\r
- * notations) are already reported through the {@link\r
- * org.xml.sax.DTDHandler DTDHandler} interface.</p>\r
- *\r
- * <p>If you are using the declaration handler together with a lexical\r
- * handler, all of the events will occur between the\r
- * {@link org.xml.sax.ext.LexicalHandler#startDTD startDTD} and the\r
- * {@link org.xml.sax.ext.LexicalHandler#endDTD endDTD} events.</p>\r
- *\r
- * <p>To set the DeclHandler for an XML reader, use the\r
- * {@link org.xml.sax.XMLReader#setProperty setProperty} method\r
- * with the propertyId "http://xml.org/sax/handlers/DeclHandler".\r
- * If the reader does not support declaration events, it will throw a\r
- * {@link org.xml.sax.SAXNotRecognizedException SAXNotRecognizedException}\r
- * or a\r
- * {@link org.xml.sax.SAXNotSupportedException SAXNotSupportedException}\r
- * when you attempt to register the handler.</p>\r
- *\r
- * @since SAX 2.0\r
- * @author David Megginson, \r
- * <a href="mailto:sax@megginson.com">sax@megginson.com</a>\r
- * @version 2.0beta\r
- * @see org.xml.sax.XMLReader\r
- */\r
-public interface DeclHandler\r
-{\r
-\r
- /**\r
- * Report an element type declaration.\r
- *\r
- * <p>The content model will consist of the string "EMPTY", the\r
- * string "ANY", or a parenthesised group, optionally followed\r
- * by an occurrence indicator. The model will be normalized so\r
- * that all whitespace is removed,and will include the enclosing\r
- * parentheses.</p>\r
- *\r
- * @param name The element type name.\r
- * @param model The content model as a normalized string.\r
- * @exception SAXException The application may raise an exception.\r
- */\r
- public abstract void elementDecl (String name, String model)\r
- throws SAXException;\r
-\r
-\r
- /**\r
- * Report an attribute type declaration.\r
- *\r
- * <p>Only the effective (first) declaration for an attribute will\r
- * be reported. The type will be one of the strings "CDATA",\r
- * "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY",\r
- * "ENTITIES", or "NOTATION", or a parenthesized token group with \r
- * the separator "|" and all whitespace removed.</p>\r
- *\r
- * @param eName The name of the associated element.\r
- * @param aName The name of the attribute.\r
- * @param type A string representing the attribute type.\r
- * @param valueDefault A string representing the attribute default\r
- * ("#IMPLIED", "#REQUIRED", or "#FIXED") or null if\r
- * none of these applies.\r
- * @param value A string representing the attribute's default value,\r
- * or null if there is none.\r
- * @exception SAXException The application may raise an exception.\r
- */\r
- public abstract void attributeDecl (String eName,\r
- String aName,\r
- String type,\r
- String valueDefault,\r
- String value)\r
- throws SAXException;\r
-\r
-\r
- /**\r
- * Report an internal entity declaration.\r
- *\r
- * <p>Only the effective (first) declaration for each entity\r
- * will be reported.</p>\r
- *\r
- * @param name The name of the entity. If it is a parameter\r
- * entity, the name will begin with '%'.\r
- * @param value The replacement text of the entity.\r
- * @exception SAXException The application may raise an exception.\r
- * @see #externalEntityDecl\r
- * @see org.xml.sax.DTDHandler#unparsedEntityDecl\r
- */\r
- public abstract void internalEntityDecl (String name, String value)\r
- throws SAXException;\r
-\r
-\r
- /**\r
- * Report a parsed external entity declaration.\r
- *\r
- * <p>Only the effective (first) declaration for each entity\r
- * will be reported.</p>\r
- *\r
- * @param name The name of the entity. If it is a parameter\r
- * entity, the name will begin with '%'.\r
- * @param publicId The declared public identifier of the entity, or\r
- * null if none was declared.\r
- * @param systemId The declared system identifier of the entity.\r
- * @exception SAXException The application may raise an exception.\r
- * @see #internalEntityDecl\r
- * @see org.xml.sax.DTDHandler#unparsedEntityDecl\r
- */\r
- public abstract void externalEntityDecl (String name, String publicId,\r
- String systemId)\r
- throws SAXException;\r
-\r
-}\r
-\r
-// end of DeclHandler.java\r
+// DeclHandler.java - Optional handler for DTD declaration events.
+// http://www.saxproject.org
+// Public Domain: no warranty.
+// $Id: DeclHandler.java,v 1.2.2.5 2002/01/29 21:34:14 dbrownell Exp $
+
+package org.xml.sax.ext;
+
+import org.xml.sax.SAXException;
+
+
+/**
+ * SAX2 extension handler for DTD declaration events.
+ *
+ * <blockquote>
+ * <em>This module, both source code and documentation, is in the
+ * Public Domain, and comes with <strong>NO WARRANTY</strong>.</em>
+ * See <a href='http://www.saxproject.org'>http://www.saxproject.org</a>
+ * for further information.
+ * </blockquote>
+ *
+ * <p>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.</p>
+ *
+ * <p>Note that data-related DTD declarations (unparsed entities and
+ * notations) are already reported through the {@link
+ * org.xml.sax.DTDHandler DTDHandler} interface.</p>
+ *
+ * <p>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.</p>
+ *
+ * <p>To set the DeclHandler for an XML reader, use the
+ * {@link org.xml.sax.XMLReader#setProperty setProperty} method
+ * with the property name
+ * <code>http://xml.org/sax/properties/declaration-handler</code>
+ * 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.</p>
+ *
+ * @since SAX 2.0 (extensions 1.0)
+ * @author David Megginson
+ * @version 2.0.1 (sax2r2)
+ */
+public interface DeclHandler
+{
+
+ /**
+ * Report an element type declaration.
+ *
+ * <p>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.</p>
+ *
+ * @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 elementDecl (String name, String model)
+ throws SAXException;
+
+
+ /**
+ * Report an attribute type declaration.
+ *
+ * <p>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.</p>
+ *
+ * <p>The value will be the value as reported to applications,
+ * appropriately normalized and with entity and character
+ * references expanded. </p>
+ *
+ * @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 attributeDecl (String eName,
+ String aName,
+ String type,
+ String mode,
+ String value)
+ throws SAXException;
+
+
+ /**
+ * Report an internal entity declaration.
+ *
+ * <p>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.</p>
+ *
+ * @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
+ */
+ public abstract void internalEntityDecl (String name, String value)
+ throws SAXException;
+
+
+ /**
+ * Report a parsed external entity declaration.
+ *
+ * <p>Only the effective (first) declaration for each entity
+ * will be reported.</p>
+ *
+ * @param name The name of the entity. If it is a parameter
+ * entity, the name will begin with '%'.
+ * @param publicId The declared public identifier of the entity, or
+ * null if none was declared.
+ * @param systemId The declared system identifier of the entity.
+ * @exception SAXException The application may raise an exception.
+ * @see #internalEntityDecl
+ * @see org.xml.sax.DTDHandler#unparsedEntityDecl
+ */
+ public abstract void externalEntityDecl (String name, String publicId,
+ String systemId)
+ throws SAXException;
+
+}
+
+// end of DeclHandler.java
OSDN Git Service
