+++ /dev/null
-// SAX default handler base class.\r
-// No warranty; no copyright -- use this as you will.\r
-// $Id: HandlerBase.java,v 1.1 2000/10/02 02:43:17 sboag Exp $\r
-\r
-package org.xml.sax;\r
-\r
-/**\r
- * Default base class for handlers.\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 class implements the default behaviour for four SAX1\r
- * interfaces: EntityResolver, DTDHandler, DocumentHandler,\r
- * and ErrorHandler. It is now obsolete, but is included in SAX2 to\r
- * support legacy SAX1 applications. SAX2 applications should use\r
- * the {@link org.xml.sax.helpers.DefaultHandler DefaultHandler}\r
- * class instead.</p>\r
- *\r
- * <p>Application writers can extend this class when they need to\r
- * implement only part of an interface; parser writers can\r
- * instantiate this class to provide default handlers when the\r
- * application has not supplied its own.</p>\r
- *\r
- * <p>Note that the use of this class is optional.</p>\r
- *\r
- * @deprecated This class works with the deprecated\r
- * {@link org.xml.sax.DocumentHandler DocumentHandler}\r
- * interface. It has been replaced by the SAX2\r
- * {@link org.xml.sax.helpers.DefaultHandler DefaultHandler}\r
- * class.\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
- */\r
-public class HandlerBase\r
- implements EntityResolver, DTDHandler, DocumentHandler, ErrorHandler\r
-{\r
- \r
-\f\r
- ////////////////////////////////////////////////////////////////////\r
- // Default implementation of the EntityResolver interface.\r
- ////////////////////////////////////////////////////////////////////\r
- \r
- /**\r
- * Resolve an external entity.\r
- *\r
- * <p>Always return null, so that the parser will use the system\r
- * identifier provided in the XML document. This method implements\r
- * the SAX default behaviour: application writers can override it\r
- * in a subclass to do special translations such as catalog lookups\r
- * or URI redirection.</p>\r
- *\r
- * @param publicId The public identifier, or null if none is\r
- * available.\r
- * @param systemId The system identifier provided in the XML \r
- * document.\r
- * @return The new input source, or null to require the\r
- * default behaviour.\r
- * @exception org.xml.sax.SAXException Any SAX exception, possibly\r
- * wrapping another exception.\r
- * @see org.xml.sax.EntityResolver#resolveEntity\r
- */\r
- public InputSource resolveEntity (String publicId, String systemId)\r
- throws SAXException\r
- {\r
- return null;\r
- }\r
- \r
- \r
-\f\r
- ////////////////////////////////////////////////////////////////////\r
- // Default implementation of DTDHandler interface.\r
- ////////////////////////////////////////////////////////////////////\r
- \r
- \r
- /**\r
- * Receive notification of a notation declaration.\r
- *\r
- * <p>By default, do nothing. Application writers may override this\r
- * method in a subclass if they wish to keep track of the notations\r
- * declared in a document.</p>\r
- *\r
- * @param name The notation name.\r
- * @param publicId The notation public identifier, or null if not\r
- * available.\r
- * @param systemId The notation system identifier.\r
- * @see org.xml.sax.DTDHandler#notationDecl\r
- */\r
- public void notationDecl (String name, String publicId, String systemId)\r
- {\r
- // no op\r
- }\r
- \r
- \r
- /**\r
- * Receive notification of an unparsed entity declaration.\r
- *\r
- * <p>By default, do nothing. Application writers may override this\r
- * method in a subclass to keep track of the unparsed entities\r
- * declared in a document.</p>\r
- *\r
- * @param name The entity name.\r
- * @param publicId The entity public identifier, or null if not\r
- * available.\r
- * @param systemId The entity system identifier.\r
- * @param notationName The name of the associated notation.\r
- * @see org.xml.sax.DTDHandler#unparsedEntityDecl\r
- */\r
- public void unparsedEntityDecl (String name, String publicId,\r
- String systemId, String notationName)\r
- {\r
- // no op\r
- }\r
- \r
- \r
-\f\r
- ////////////////////////////////////////////////////////////////////\r
- // Default implementation of DocumentHandler interface.\r
- ////////////////////////////////////////////////////////////////////\r
- \r
- \r
- /**\r
- * Receive a Locator object for document events.\r
- *\r
- * <p>By default, do nothing. Application writers may override this\r
- * method in a subclass if they wish to store the locator for use\r
- * with other document events.</p>\r
- *\r
- * @param locator A locator for all SAX document events.\r
- * @see org.xml.sax.DocumentHandler#setDocumentLocator\r
- * @see org.xml.sax.Locator\r
- */\r
- public void setDocumentLocator (Locator locator)\r
- {\r
- // no op\r
- }\r
- \r
- \r
- /**\r
- * Receive notification of the beginning of the document.\r
- *\r
- * <p>By default, do nothing. Application writers may override this\r
- * method in a subclass to take specific actions at the beginning\r
- * of a document (such as allocating the root node of a tree or\r
- * creating an output file).</p>\r
- *\r
- * @exception org.xml.sax.SAXException Any SAX exception, possibly\r
- * wrapping another exception.\r
- * @see org.xml.sax.DocumentHandler#startDocument\r
- */\r
- public void startDocument ()\r
- throws SAXException\r
- {\r
- // no op\r
- }\r
- \r
- \r
- /**\r
- * Receive notification of the end of the document.\r
- *\r
- * <p>By default, do nothing. Application writers may override this\r
- * method in a subclass to take specific actions at the beginning\r
- * of a document (such as finalising a tree or closing an output\r
- * file).</p>\r
- *\r
- * @exception org.xml.sax.SAXException Any SAX exception, possibly\r
- * wrapping another exception.\r
- * @see org.xml.sax.DocumentHandler#endDocument\r
- */\r
- public void endDocument ()\r
- throws SAXException\r
- {\r
- // no op\r
- }\r
- \r
- \r
- /**\r
- * Receive notification of the start of an element.\r
- *\r
- * <p>By default, do nothing. Application writers may override this\r
- * method in a subclass to take specific actions at the start of\r
- * each element (such as allocating a new tree node or writing\r
- * output to a file).</p>\r
- *\r
- * @param name The element type name.\r
- * @param attributes The specified or defaulted attributes.\r
- * @exception org.xml.sax.SAXException Any SAX exception, possibly\r
- * wrapping another exception.\r
- * @see org.xml.sax.DocumentHandler#startElement\r
- */\r
- public void startElement (String name, AttributeList attributes)\r
- throws SAXException\r
- {\r
- // no op\r
- }\r
- \r
- \r
- /**\r
- * Receive notification of the end of an element.\r
- *\r
- * <p>By default, do nothing. Application writers may override this\r
- * method in a subclass to take specific actions at the end of\r
- * each element (such as finalising a tree node or writing\r
- * output to a file).</p>\r
- *\r
- * @param name The element type name.\r
- * @param attributes The specified or defaulted attributes.\r
- * @exception org.xml.sax.SAXException Any SAX exception, possibly\r
- * wrapping another exception.\r
- * @see org.xml.sax.DocumentHandler#endElement\r
- */\r
- public void endElement (String name)\r
- throws SAXException\r
- {\r
- // no op\r
- }\r
- \r
- \r
- /**\r
- * Receive notification of character data inside an element.\r
- *\r
- * <p>By default, do nothing. Application writers may override this\r
- * method to take specific actions for each chunk of character data\r
- * (such as adding the data to a node or buffer, or printing it to\r
- * a file).</p>\r
- *\r
- * @param ch The characters.\r
- * @param start The start position in the character array.\r
- * @param length The number of characters to use from the\r
- * character array.\r
- * @exception org.xml.sax.SAXException Any SAX exception, possibly\r
- * wrapping another exception.\r
- * @see org.xml.sax.DocumentHandler#characters\r
- */\r
- public void characters (char ch[], int start, int length)\r
- throws SAXException\r
- {\r
- // no op\r
- }\r
- \r
- \r
- /**\r
- * Receive notification of ignorable whitespace in element content.\r
- *\r
- * <p>By default, do nothing. Application writers may override this\r
- * method to take specific actions for each chunk of ignorable\r
- * whitespace (such as adding data to a node or buffer, or printing\r
- * it to a file).</p>\r
- *\r
- * @param ch The whitespace characters.\r
- * @param start The start position in the character array.\r
- * @param length The number of characters to use from the\r
- * character array.\r
- * @exception org.xml.sax.SAXException Any SAX exception, possibly\r
- * wrapping another exception.\r
- * @see org.xml.sax.DocumentHandler#ignorableWhitespace\r
- */\r
- public void ignorableWhitespace (char ch[], int start, int length)\r
- throws SAXException\r
- {\r
- // no op\r
- }\r
- \r
- \r
- /**\r
- * Receive notification of a processing instruction.\r
- *\r
- * <p>By default, do nothing. Application writers may override this\r
- * method in a subclass to take specific actions for each\r
- * processing instruction, such as setting status variables or\r
- * invoking other methods.</p>\r
- *\r
- * @param target The processing instruction target.\r
- * @param data The processing instruction data, or null if\r
- * none is supplied.\r
- * @exception org.xml.sax.SAXException Any SAX exception, possibly\r
- * wrapping another exception.\r
- * @see org.xml.sax.DocumentHandler#processingInstruction\r
- */\r
- public void processingInstruction (String target, String data)\r
- throws SAXException\r
- {\r
- // no op\r
- }\r
- \r
- \r
-\f\r
- ////////////////////////////////////////////////////////////////////\r
- // Default implementation of the ErrorHandler interface.\r
- ////////////////////////////////////////////////////////////////////\r
- \r
- \r
- /**\r
- * Receive notification of a parser warning.\r
- *\r
- * <p>The default implementation does nothing. Application writers\r
- * may override this method in a subclass to take specific actions\r
- * for each warning, such as inserting the message in a log file or\r
- * printing it to the console.</p>\r
- *\r
- * @param e The warning information encoded as an exception.\r
- * @exception org.xml.sax.SAXException Any SAX exception, possibly\r
- * wrapping another exception.\r
- * @see org.xml.sax.ErrorHandler#warning\r
- * @see org.xml.sax.SAXParseException\r
- */\r
- public void warning (SAXParseException e)\r
- throws SAXException\r
- {\r
- // no op\r
- }\r
- \r
- \r
- /**\r
- * Receive notification of a recoverable parser error.\r
- *\r
- * <p>The default implementation does nothing. Application writers\r
- * may override this method in a subclass to take specific actions\r
- * for each error, such as inserting the message in a log file or\r
- * printing it to the console.</p>\r
- *\r
- * @param e The warning information encoded as an exception.\r
- * @exception org.xml.sax.SAXException Any SAX exception, possibly\r
- * wrapping another exception.\r
- * @see org.xml.sax.ErrorHandler#warning\r
- * @see org.xml.sax.SAXParseException\r
- */\r
- public void error (SAXParseException e)\r
- throws SAXException\r
- {\r
- // no op\r
- }\r
- \r
- \r
- /**\r
- * Report a fatal XML parsing error.\r
- *\r
- * <p>The default implementation throws a SAXParseException.\r
- * Application writers may override this method in a subclass if\r
- * they need to take specific actions for each fatal error (such as\r
- * collecting all of the errors into a single report): in any case,\r
- * the application must stop all regular processing when this\r
- * method is invoked, since the document is no longer reliable, and\r
- * the parser may no longer report parsing events.</p>\r
- *\r
- * @param e The error information encoded as an exception.\r
- * @exception org.xml.sax.SAXException Any SAX exception, possibly\r
- * wrapping another exception.\r
- * @see org.xml.sax.ErrorHandler#fatalError\r
- * @see org.xml.sax.SAXParseException\r
- */\r
- public void fatalError (SAXParseException e)\r
- throws SAXException\r
- {\r
- throw e;\r
- }\r
- \r
-}\r
-\r
-// end of HandlerBase.java\r
projects / msp430-gcc.git / blobdiff