From 74b27b64774a3fef2d2bb53bc48a54776cd71bde Mon Sep 17 00:00:00 2001 From: green Date: Wed, 11 Jul 2001 03:59:16 +0000 Subject: Add some org packages. git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@43922 138bc75d-0d04-0410-961f-82ee72b054a4 --- libjava/org/xml/sax/ext/LexicalHandler.java | 161 ++++++++++++++++++++++++++++ 1 file changed, 161 insertions(+) create mode 100644 libjava/org/xml/sax/ext/LexicalHandler.java (limited to 'libjava/org/xml/sax/ext/LexicalHandler.java') diff --git a/libjava/org/xml/sax/ext/LexicalHandler.java b/libjava/org/xml/sax/ext/LexicalHandler.java new file mode 100644 index 00000000000..4ac1617ca00 --- /dev/null +++ b/libjava/org/xml/sax/ext/LexicalHandler.java @@ -0,0 +1,161 @@ +// LexicalHandler.java - optional handler for lexical parse events. +// Public Domain: no warranty. +// $Id: LexicalHandler.java,v 1.1 2000/10/02 02:43:20 sboag Exp $ + +package org.xml.sax.ext; + +import org.xml.sax.SAXException; + +/** + * SAX2 extension handler for lexical events. + * + *
+ * This module, both source code and documentation, is in the + * Public Domain, and comes with NO WARRANTY. + *
+ * + *

This is an optional extension handler for SAX2 to provide + * lexical information about an XML document, such as comments + * and CDATA section boundaries; XML readers are not required to + * support this handler.

+ * + *

The events in the lexical handler apply to the entire document, + * not just to the document element, and all lexical handler events + * must appear between the content handler's startDocument and + * endDocument events.

+ * + *

To set the LexicalHandler for an XML reader, use the + * {@link org.xml.sax.XMLReader#setProperty setProperty} method + * with the propertyId "http://xml.org/sax/handlers/LexicalHandler". + * If the reader does not support lexical events, it will throw a + * {@link org.xml.sax.SAXNotRecognizedException SAXNotRecognizedException} + * or a + * {@link org.xml.sax.SAXNotSupportedException SAXNotSupportedException} + * when you attempt to register the handler.

+ * + * @since SAX 2.0 + * @author David Megginson, + * sax@megginson.com + * @version 2.0beta + * @see org.xml.sax.XMLReader#setProperty + * @see org.xml.sax.SAXNotRecognizedException + * @see org.xml.sax.SAXNotSupportedException + */ +public interface LexicalHandler +{ + + /** + * Report the start of DTD declarations, if any. + * + *

Any declarations are assumed to be in the internal subset + * unless otherwise indicated by a {@link #startEntity startEntity} + * event.

+ * + *

Note that the start/endDTD events will appear within + * the start/endDocument events from ContentHandler and + * before the first startElement event.

+ * + * @param name The document type name. + * @param publicId The declared public identifier for the + * external DTD subset, or null if none was declared. + * @param systemId The declared system identifier for the + * external DTD subset, or null if none was declared. + * @exception SAXException The application may raise an + * exception. + * @see #endDTD + * @see #startEntity + */ + public abstract void startDTD (String name, String publicId, + String systemId) + throws SAXException; + + + /** + * Report the end of DTD declarations. + * + * @exception SAXException The application may raise an exception. + * @see #startDTD + */ + public abstract void endDTD () + throws SAXException; + + + /** + * Report the beginning of an entity in content. + * + *

NOTE: entity references in attribute + * values -- and the start and end of the document entity -- + * are never reported.

+ * + *

The start and end of the external DTD subset are reported + * using the pseudo-name "[dtd]". All other events must be + * properly nested within start/end entity events.

+ * + *

Note that skipped entities will be reported through the + * {@link org.xml.sax.ContentHandler#skippedEntity skippedEntity} + * event, which is part of the ContentHandler interface.

+ * + * @param name The name of the entity. If it is a parameter + * entity, the name will begin with '%'. + * @exception SAXException The application may raise an exception. + * @see #endEntity + * @see org.xml.sax.ext.DeclHandler#internalEntityDecl + * @see org.xml.sax.ext.DeclHandler#externalEntityDecl + */ + public abstract void startEntity (String name) + throws SAXException; + + + /** + * Report the end of an entity. + * + * @param name The name of the entity that is ending. + * @exception SAXException The application may raise an exception. + * @see #startEntity + */ + public abstract void endEntity (String name) + throws SAXException; + + + /** + * Report the start of a CDATA section. + * + *

The contents of the CDATA section will be reported through + * the regular {@link org.xml.sax.ContentHandler#characters + * characters} event.

+ * + * @exception SAXException The application may raise an exception. + * @see #endCDATA + */ + public abstract void startCDATA () + throws SAXException; + + + /** + * Report the end of a CDATA section. + * + * @exception SAXException The application may raise an exception. + * @see #startCDATA + */ + public abstract void endCDATA () + throws SAXException; + + + /** + * Report an XML comment anywhere in the document. + * + *

This callback will be used for comments inside or outside the + * document element, including comments in the external DTD + * subset (if read).

+ * + * @param ch An array holding the characters in the comment. + * @param start The starting position in the array. + * @param length The number of characters to use from the array. + * @exception SAXException The application may raise an exception. + */ + public abstract void comment (char ch[], int start, int length) + throws SAXException; + +} + +// end of LexicalHandler.java -- cgit v1.2.3