+++ /dev/null
-// SAX document handler.\r
-// No warranty; no copyright -- use this as you will.\r
-// $Id: DocumentHandler.java,v 1.1 2000/10/02 02:43:17 sboag Exp $\r
-\r
-package org.xml.sax;\r
-\r
-/**\r
- * Receive notification of general document 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 was the main event-handling interface for SAX1; in\r
- * SAX2, it has been replaced by {@link org.xml.sax.ContentHandler\r
- * ContentHandler}, which provides Namespace support and reporting\r
- * of skipped entities. This interface is included in SAX2 only\r
- * to support legacy SAX1 applications.</p>\r
- *\r
- * <p>The order of events in this interface is very important, and\r
- * mirrors the order of information in the document itself. For\r
- * example, all of an element's content (character data, processing\r
- * instructions, and/or subelements) will appear, in order, between\r
- * the startElement event and the corresponding endElement event.</p>\r
- *\r
- * <p>Application writers who do not want to implement the entire\r
- * interface can derive a class from HandlerBase, which implements\r
- * the default functionality; parser writers can instantiate\r
- * HandlerBase to obtain a default handler. The application can find\r
- * the location of any document event using the Locator interface\r
- * supplied by the Parser through the setDocumentLocator method.</p>\r
- *\r
- * @deprecated This interface has been replaced by the SAX2\r
- * {@link org.xml.sax.ContentHandler ContentHandler}\r
- * interface, which includes Namespace support.\r
- * @since SAX 1.0\r
- * @author David Megginson, \r
- * <a href="mailto:sax@megginson.com">sax@megginson.com</a>\r
- * @version 2.0\r
- * @see org.xml.sax.Parser#setDocumentHandler\r
- * @see org.xml.sax.Locator\r
- * @see org.xml.sax.HandlerBase\r
- */\r
-public interface DocumentHandler {\r
- \r
- \r
- /**\r
- * Receive an object for locating the origin of SAX document events.\r
- *\r
- * <p>SAX parsers are strongly encouraged (though not absolutely\r
- * required) to supply a locator: if it does so, it must supply\r
- * the locator to the application by invoking this method before\r
- * invoking any of the other methods in the DocumentHandler\r
- * interface.</p>\r
- *\r
- * <p>The locator allows the application to determine the end\r
- * position of any document-related event, even if the parser is\r
- * not reporting an error. Typically, the application will\r
- * use this information for reporting its own errors (such as\r
- * character content that does not match an application's\r
- * business rules). The information returned by the locator\r
- * is probably not sufficient for use with a search engine.</p>\r
- *\r
- * <p>Note that the locator will return correct information only\r
- * during the invocation of the events in this interface. The\r
- * application should not attempt to use it at any other time.</p>\r
- *\r
- * @param locator An object that can return the location of\r
- * any SAX document event.\r
- * @see org.xml.sax.Locator\r
- */\r
- public abstract void setDocumentLocator (Locator locator);\r
- \r
- \r
- /**\r
- * Receive notification of the beginning of a document.\r
- *\r
- * <p>The SAX parser will invoke this method only once, before any\r
- * other methods in this interface or in DTDHandler (except for\r
- * setDocumentLocator).</p>\r
- *\r
- * @exception org.xml.sax.SAXException Any SAX exception, possibly\r
- * wrapping another exception.\r
- */\r
- public abstract void startDocument ()\r
- throws SAXException;\r
- \r
- \r
- /**\r
- * Receive notification of the end of a document.\r
- *\r
- * <p>The SAX parser will invoke this method only once, and it will\r
- * be the last method invoked during the parse. The parser shall\r
- * not invoke this method until it has either abandoned parsing\r
- * (because of an unrecoverable error) or reached the end of\r
- * input.</p>\r
- *\r
- * @exception org.xml.sax.SAXException Any SAX exception, possibly\r
- * wrapping another exception.\r
- */\r
- public abstract void endDocument ()\r
- throws SAXException;\r
- \r
- \r
- /**\r
- * Receive notification of the beginning of an element.\r
- *\r
- * <p>The Parser will invoke this method at the beginning of every\r
- * element in the XML document; there will be a corresponding\r
- * endElement() event for every startElement() event (even when the\r
- * element is empty). All of the element's content will be\r
- * reported, in order, before the corresponding endElement()\r
- * event.</p>\r
- *\r
- * <p>If the element name has a namespace prefix, the prefix will\r
- * still be attached. Note that the attribute list provided will\r
- * contain only attributes with explicit values (specified or\r
- * defaulted): #IMPLIED attributes will be omitted.</p>\r
- *\r
- * @param name The element type name.\r
- * @param atts The attributes attached to the element, if any.\r
- * @exception org.xml.sax.SAXException Any SAX exception, possibly\r
- * wrapping another exception.\r
- * @see #endElement\r
- * @see org.xml.sax.AttributeList \r
- */\r
- public abstract void startElement (String name, AttributeList atts)\r
- throws SAXException;\r
- \r
- \r
- /**\r
- * Receive notification of the end of an element.\r
- *\r
- * <p>The SAX parser will invoke this method at the end of every\r
- * element in the XML document; there will be a corresponding\r
- * startElement() event for every endElement() event (even when the\r
- * element is empty).</p>\r
- *\r
- * <p>If the element name has a namespace prefix, the prefix will\r
- * still be attached to the name.</p>\r
- *\r
- * @param name The element type name\r
- * @exception org.xml.sax.SAXException Any SAX exception, possibly\r
- * wrapping another exception.\r
- */\r
- public abstract void endElement (String name)\r
- throws SAXException;\r
- \r
- \r
- /**\r
- * Receive notification of character data.\r
- *\r
- * <p>The Parser will call this method to report each chunk of\r
- * character data. SAX parsers may return all contiguous character\r
- * data in a single chunk, or they may split it into several\r
- * chunks; however, all of the characters in any single event\r
- * must come from the same external entity, so that the Locator\r
- * provides useful information.</p>\r
- *\r
- * <p>The application must not attempt to read from the array\r
- * outside of the specified range.</p>\r
- *\r
- * <p>Note that some parsers will report whitespace using the\r
- * ignorableWhitespace() method rather than this one (validating\r
- * parsers must do so).</p>\r
- *\r
- * @param ch The characters from the XML document.\r
- * @param start The start position in the array.\r
- * @param length The number of characters to read from the array.\r
- * @exception org.xml.sax.SAXException Any SAX exception, possibly\r
- * wrapping another exception.\r
- * @see #ignorableWhitespace \r
- * @see org.xml.sax.Locator\r
- */\r
- public abstract void characters (char ch[], int start, int length)\r
- throws SAXException;\r
- \r
- \r
- /**\r
- * Receive notification of ignorable whitespace in element content.\r
- *\r
- * <p>Validating Parsers must use this method to report each chunk\r
- * of ignorable whitespace (see the W3C XML 1.0 recommendation,\r
- * section 2.10): non-validating parsers may also use this method\r
- * if they are capable of parsing and using content models.</p>\r
- *\r
- * <p>SAX parsers may return all contiguous whitespace in a single\r
- * chunk, or they may split it into several chunks; however, all of\r
- * the characters in any single event must come from the same\r
- * external entity, so that the Locator provides useful\r
- * information.</p>\r
- *\r
- * <p>The application must not attempt to read from the array\r
- * outside of the specified range.</p>\r
- *\r
- * @param ch The characters from the XML document.\r
- * @param start The start position in the array.\r
- * @param length The number of characters to read from the array.\r
- * @exception org.xml.sax.SAXException Any SAX exception, possibly\r
- * wrapping another exception.\r
- * @see #characters\r
- */\r
- public abstract void ignorableWhitespace (char ch[], int start, int length)\r
- throws SAXException;\r
- \r
- \r
- /**\r
- * Receive notification of a processing instruction.\r
- *\r
- * <p>The Parser will invoke this method once for each processing\r
- * instruction found: note that processing instructions may occur\r
- * before or after the main document element.</p>\r
- *\r
- * <p>A SAX parser should never report an XML declaration (XML 1.0,\r
- * section 2.8) or a text declaration (XML 1.0, section 4.3.1)\r
- * using this method.</p>\r
- *\r
- * @param target The processing instruction target.\r
- * @param data The processing instruction data, or null if\r
- * none was supplied.\r
- * @exception org.xml.sax.SAXException Any SAX exception, possibly\r
- * wrapping another exception.\r
- */\r
- public abstract void processingInstruction (String target, String data)\r
- throws SAXException;\r
- \r
-}\r
-\r
-// end of DocumentHandler.java\r
projects / msp430-gcc.git / blobdiff