+++ /dev/null
-// SAX locator interface for document events.\r
-// No warranty; no copyright -- use this as you will.\r
-// $Id: Locator.java,v 1.1 2000/10/02 02:43:17 sboag Exp $\r
-\r
-package org.xml.sax;\r
-\r
-\r
-/**\r
- * Interface for associating a SAX event with a document location.\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>If a SAX parser provides location information to the SAX\r
- * application, it does so by implementing this interface and then\r
- * passing an instance to the application using the content\r
- * handler's {@link org.xml.sax.ContentHandler#setDocumentLocator\r
- * setDocumentLocator} method. The application can use the\r
- * object to obtain the location of any other content handler event\r
- * in the XML source document.</p>\r
- *\r
- * <p>Note that the results returned by the object will be valid only\r
- * during the scope of each content handler method: the application\r
- * will receive unpredictable results if it attempts to use the\r
- * locator at any other time.</p>\r
- *\r
- * <p>SAX parsers are not required to supply a locator, but they are\r
- * very strongly encouraged to do so. If the parser supplies a\r
- * locator, it must do so before reporting any other document events.\r
- * If no locator has been set by the time the application receives\r
- * the {@link org.xml.sax.ContentHandler#startDocument startDocument}\r
- * event, the application should assume that a locator is not \r
- * available.</p>\r
- *\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.ContentHandler#setDocumentLocator \r
- */\r
-public interface Locator {\r
- \r
- \r
- /**\r
- * Return the public identifier for the current document event.\r
- *\r
- * <p>The return value is the public identifier of the document\r
- * entity or of the external parsed entity in which the markup\r
- * triggering the event appears.</p>\r
- *\r
- * @return A string containing the public identifier, or\r
- * null if none is available.\r
- * @see #getSystemId\r
- */\r
- public abstract String getPublicId ();\r
- \r
- \r
- /**\r
- * Return the system identifier for the current document event.\r
- *\r
- * <p>The return value is the system identifier of the document\r
- * entity or of the external parsed entity in which the markup\r
- * triggering the event appears.</p>\r
- *\r
- * <p>If the system identifier is a URL, the parser must resolve it\r
- * fully before passing it to the application.</p>\r
- *\r
- * @return A string containing the system identifier, or null\r
- * if none is available.\r
- * @see #getPublicId\r
- */\r
- public abstract String getSystemId ();\r
- \r
- \r
- /**\r
- * Return the line number where the current document event ends.\r
- *\r
- * <p><strong>Warning:</strong> The return value from the method\r
- * is intended only as an approximation for the sake of error\r
- * reporting; it is not intended to provide sufficient information\r
- * to edit the character content of the original XML document.</p>\r
- *\r
- * <p>The return value is an approximation of the line number\r
- * in the document entity or external parsed entity where the\r
- * markup triggering the event appears.</p>\r
- *\r
- * <p>If possible, the SAX driver should provide the line position \r
- * of the first character after the text associated with the document \r
- * event. The first line in the document is line 1.</p>\r
- *\r
- * @return The line number, or -1 if none is available.\r
- * @see #getColumnNumber\r
- */\r
- public abstract int getLineNumber ();\r
- \r
- \r
- /**\r
- * Return the column number where the current document event ends.\r
- *\r
- * <p><strong>Warning:</strong> The return value from the method\r
- * is intended only as an approximation for the sake of error\r
- * reporting; it is not intended to provide sufficient information\r
- * to edit the character content of the original XML document.</p>\r
- *\r
- * <p>The return value is an approximation of the column number\r
- * in the document entity or external parsed entity where the\r
- * markup triggering the event appears.</p>\r
- *\r
- * <p>If possible, the SAX driver should provide the line position \r
- * of the first character after the text associated with the document \r
- * event.</p>\r
- *\r
- * <p>If possible, the SAX driver should provide the line position \r
- * of the first character after the text associated with the document \r
- * event. The first column in each line is column 1.</p>\r
- *\r
- * @return The column number, or -1 if none is available.\r
- * @see #getLineNumber\r
- */\r
- public abstract int getColumnNumber ();\r
- \r
-}\r
-\r
-// end of Locator.java\r
projects / msp430-gcc.git / blobdiff