+++ /dev/null
-// LexicalHandler.java - optional handler for lexical parse events.\r
-// Public Domain: no warranty.\r
-// $Id: LexicalHandler.java,v 1.1 2000/10/02 02:43:20 sboag Exp $\r
-\r
-package org.xml.sax.ext;\r
-\r
-import org.xml.sax.SAXException;\r
-\r
-/**\r
- * SAX2 extension handler for lexical 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
- * lexical information about an XML document, such as comments\r
- * and CDATA section boundaries; XML readers are not required to \r
- * support this handler.</p>\r
- *\r
- * <p>The events in the lexical handler apply to the entire document,\r
- * not just to the document element, and all lexical handler events\r
- * must appear between the content handler's startDocument and\r
- * endDocument events.</p>\r
- *\r
- * <p>To set the LexicalHandler for an XML reader, use the\r
- * {@link org.xml.sax.XMLReader#setProperty setProperty} method\r
- * with the propertyId "http://xml.org/sax/handlers/LexicalHandler".\r
- * If the reader does not support lexical 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#setProperty\r
- * @see org.xml.sax.SAXNotRecognizedException\r
- * @see org.xml.sax.SAXNotSupportedException\r
- */\r
-public interface LexicalHandler\r
-{\r
-\r
- /**\r
- * Report the start of DTD declarations, if any.\r
- *\r
- * <p>Any declarations are assumed to be in the internal subset\r
- * unless otherwise indicated by a {@link #startEntity startEntity}\r
- * event.</p>\r
- *\r
- * <p>Note that the start/endDTD events will appear within\r
- * the start/endDocument events from ContentHandler and\r
- * before the first startElement event.</p>\r
- *\r
- * @param name The document type name.\r
- * @param publicId The declared public identifier for the\r
- * external DTD subset, or null if none was declared.\r
- * @param systemId The declared system identifier for the\r
- * external DTD subset, or null if none was declared.\r
- * @exception SAXException The application may raise an\r
- * exception.\r
- * @see #endDTD\r
- * @see #startEntity\r
- */\r
- public abstract void startDTD (String name, String publicId,\r
- String systemId)\r
- throws SAXException;\r
-\r
-\r
- /**\r
- * Report the end of DTD declarations.\r
- *\r
- * @exception SAXException The application may raise an exception.\r
- * @see #startDTD\r
- */\r
- public abstract void endDTD ()\r
- throws SAXException;\r
-\r
-\r
- /**\r
- * Report the beginning of an entity in content.\r
- *\r
- * <p><strong>NOTE:</entity> entity references in attribute\r
- * values -- and the start and end of the document entity --\r
- * are never reported.</p>\r
- *\r
- * <p>The start and end of the external DTD subset are reported\r
- * using the pseudo-name "[dtd]". All other events must be\r
- * properly nested within start/end entity events.</p>\r
- *\r
- * <p>Note that skipped entities will be reported through the\r
- * {@link org.xml.sax.ContentHandler#skippedEntity skippedEntity}\r
- * event, which is part of the ContentHandler interface.</p>\r
- *\r
- * @param name The name of the entity. If it is a parameter\r
- * entity, the name will begin with '%'.\r
- * @exception SAXException The application may raise an exception.\r
- * @see #endEntity\r
- * @see org.xml.sax.ext.DeclHandler#internalEntityDecl\r
- * @see org.xml.sax.ext.DeclHandler#externalEntityDecl\r
- */\r
- public abstract void startEntity (String name)\r
- throws SAXException;\r
-\r
-\r
- /**\r
- * Report the end of an entity.\r
- *\r
- * @param name The name of the entity that is ending.\r
- * @exception SAXException The application may raise an exception.\r
- * @see #startEntity\r
- */\r
- public abstract void endEntity (String name)\r
- throws SAXException;\r
-\r
-\r
- /**\r
- * Report the start of a CDATA section.\r
- *\r
- * <p>The contents of the CDATA section will be reported through\r
- * the regular {@link org.xml.sax.ContentHandler#characters\r
- * characters} event.</p>\r
- *\r
- * @exception SAXException The application may raise an exception.\r
- * @see #endCDATA\r
- */\r
- public abstract void startCDATA ()\r
- throws SAXException;\r
-\r
-\r
- /**\r
- * Report the end of a CDATA section.\r
- *\r
- * @exception SAXException The application may raise an exception.\r
- * @see #startCDATA\r
- */\r
- public abstract void endCDATA ()\r
- throws SAXException;\r
-\r
-\r
- /**\r
- * Report an XML comment anywhere in the document.\r
- *\r
- * <p>This callback will be used for comments inside or outside the\r
- * document element, including comments in the external DTD\r
- * subset (if read).</p>\r
- *\r
- * @param ch An array holding the characters in the comment.\r
- * @param start The starting position in the array.\r
- * @param length The number of characters to use from the array.\r
- * @exception SAXException The application may raise an exception.\r
- */\r
- public abstract void comment (char ch[], int start, int length)\r
- throws SAXException;\r
-\r
-}\r
-\r
-// end of LexicalHandler.java\r
projects / msp430-gcc.git / blobdiff