+++ /dev/null
-// SAX parser interface.\r
-// No warranty; no copyright -- use this as you will.\r
-// $Id: Parser.java,v 1.1 2000/10/02 02:43:17 sboag Exp $\r
-\r
-package org.xml.sax;\r
-\r
-import java.io.IOException;\r
-import java.util.Locale;\r
-\r
-\r
-/**\r
- * Basic interface for SAX (Simple API for XML) parsers.\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 supplier interface for SAX1; it has\r
- * been replaced in SAX2 by {@link org.xml.sax.XMLReader XMLReader},\r
- * which includes Namespace support and sophisticated configurability\r
- * and extensibility.</p>\r
- *\r
- * <p>All SAX1 parsers must implement this basic interface: it allows\r
- * applications to register handlers for different types of events\r
- * and to initiate a parse from a URI, or a character stream.</p>\r
- *\r
- * <p>All SAX1 parsers must also implement a zero-argument constructor\r
- * (though other constructors are also allowed).</p>\r
- *\r
- * <p>SAX1 parsers are reusable but not re-entrant: the application\r
- * may reuse a parser object (possibly with a different input source)\r
- * once the first parse has completed successfully, but it may not\r
- * invoke the parse() methods recursively within a parse.</p>\r
- *\r
- * @deprecated This interface has been replaced by the SAX2\r
- * {@link org.xml.sax.XMLReader XMLReader}\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.EntityResolver\r
- * @see org.xml.sax.DTDHandler\r
- * @see org.xml.sax.DocumentHandler\r
- * @see org.xml.sax.ErrorHandler\r
- * @see org.xml.sax.HandlerBase\r
- * @see org.xml.sax.InputSource\r
- */\r
-public interface Parser \r
-{\r
- \r
- /**\r
- * Allow an application to request a locale for errors and warnings.\r
- *\r
- * <p>SAX parsers are not required to provide localisation for errors\r
- * and warnings; if they cannot support the requested locale,\r
- * however, they must throw a SAX exception. Applications may\r
- * not request a locale change in the middle of a parse.</p>\r
- *\r
- * @param locale A Java Locale object.\r
- * @exception org.xml.sax.SAXException Throws an exception\r
- * (using the previous or default locale) if the \r
- * requested locale is not supported.\r
- * @see org.xml.sax.SAXException\r
- * @see org.xml.sax.SAXParseException\r
- */\r
- public abstract void setLocale (Locale locale)\r
- throws SAXException;\r
- \r
- \r
- /**\r
- * Allow an application to register a custom entity resolver.\r
- *\r
- * <p>If the application does not register an entity resolver, the\r
- * SAX parser will resolve system identifiers and open connections\r
- * to entities itself (this is the default behaviour implemented in\r
- * HandlerBase).</p>\r
- *\r
- * <p>Applications may register a new or different entity resolver\r
- * in the middle of a parse, and the SAX parser must begin using\r
- * the new resolver immediately.</p>\r
- *\r
- * @param resolver The object for resolving entities.\r
- * @see EntityResolver\r
- * @see HandlerBase\r
- */\r
- public abstract void setEntityResolver (EntityResolver resolver);\r
- \r
- \r
- /**\r
- * Allow an application to register a DTD event handler.\r
- *\r
- * <p>If the application does not register a DTD handler, all DTD\r
- * events reported by the SAX parser will be silently\r
- * ignored (this is the default behaviour implemented by\r
- * HandlerBase).</p>\r
- *\r
- * <p>Applications may register a new or different\r
- * handler in the middle of a parse, and the SAX parser must\r
- * begin using the new handler immediately.</p>\r
- *\r
- * @param handler The DTD handler.\r
- * @see DTDHandler\r
- * @see HandlerBase\r
- */\r
- public abstract void setDTDHandler (DTDHandler handler);\r
- \r
- \r
- /**\r
- * Allow an application to register a document event handler.\r
- *\r
- * <p>If the application does not register a document handler, all\r
- * document events reported by the SAX parser will be silently\r
- * ignored (this is the default behaviour implemented by\r
- * HandlerBase).</p>\r
- *\r
- * <p>Applications may register a new or different handler in the\r
- * middle of a parse, and the SAX parser must begin using the new\r
- * handler immediately.</p>\r
- *\r
- * @param handler The document handler.\r
- * @see DocumentHandler\r
- * @see HandlerBase\r
- */\r
- public abstract void setDocumentHandler (DocumentHandler handler);\r
- \r
- \r
- /**\r
- * Allow an application to register an error event handler.\r
- *\r
- * <p>If the application does not register an error event handler,\r
- * all error events reported by the SAX parser will be silently\r
- * ignored, except for fatalError, which will throw a SAXException\r
- * (this is the default behaviour implemented by HandlerBase).</p>\r
- *\r
- * <p>Applications may register a new or different handler in the\r
- * middle of a parse, and the SAX parser must begin using the new\r
- * handler immediately.</p>\r
- *\r
- * @param handler The error handler.\r
- * @see ErrorHandler\r
- * @see SAXException\r
- * @see HandlerBase\r
- */\r
- public abstract void setErrorHandler (ErrorHandler handler);\r
- \r
- \r
- /**\r
- * Parse an XML document.\r
- *\r
- * <p>The application can use this method to instruct the SAX parser\r
- * to begin parsing an XML document from any valid input\r
- * source (a character stream, a byte stream, or a URI).</p>\r
- *\r
- * <p>Applications may not invoke this method while a parse is in\r
- * progress (they should create a new Parser instead for each\r
- * additional XML document). Once a parse is complete, an\r
- * application may reuse the same Parser object, possibly with a\r
- * different input source.</p>\r
- *\r
- * @param source The input source for the top-level of the\r
- * XML document.\r
- * @exception org.xml.sax.SAXException Any SAX exception, possibly\r
- * wrapping another exception.\r
- * @exception java.io.IOException An IO exception from the parser,\r
- * possibly from a byte stream or character stream\r
- * supplied by the application.\r
- * @see org.xml.sax.InputSource\r
- * @see #parse(java.lang.String)\r
- * @see #setEntityResolver\r
- * @see #setDTDHandler\r
- * @see #setDocumentHandler\r
- * @see #setErrorHandler\r
- */\r
- public abstract void parse (InputSource source)\r
- throws SAXException, IOException;\r
- \r
- \r
- /**\r
- * Parse an XML document from a system identifier (URI).\r
- *\r
- * <p>This method is a shortcut for the common case of reading a\r
- * document from a system identifier. It is the exact\r
- * equivalent of the following:</p>\r
- *\r
- * <pre>\r
- * parse(new InputSource(systemId));\r
- * </pre>\r
- *\r
- * <p>If the system identifier is a URL, it must be fully resolved\r
- * by the application before it is passed to the parser.</p>\r
- *\r
- * @param systemId The system identifier (URI).\r
- * @exception org.xml.sax.SAXException Any SAX exception, possibly\r
- * wrapping another exception.\r
- * @exception java.io.IOException An IO exception from the parser,\r
- * possibly from a byte stream or character stream\r
- * supplied by the application.\r
- * @see #parse(org.xml.sax.InputSource)\r
- */\r
- public abstract void parse (String systemId)\r
- throws SAXException, IOException;\r
- \r
-}\r
-\r
-// end of Parser.java\r
projects / msp430-gcc.git / blobdiff