ContentHandler patch
Elliotte Harold <[email protected]> Sun, 25 Apr 2004 10:48:22 -0400
| Newsgroups | gmane.text.xml.sax.devel |
|---|---|
| Message-ID | <[email protected]> |
This patch to one file (ContentHandler) fixes a broken @link to java.net.ContentHandler by removing it. For various obscure reasons it doesn't seem possible for this to be referenced without importing java.net.ContentHandler -- Elliotte Rusty Harold
ContentHandler.patch
(text/plain, 9.7 KB)
Index: src/org/xml/sax/ContentHandler.java
===================================================================
RCS file: /cvsroot/sax/sax2/src/org/xml/sax/ContentHandler.java,v
retrieving revision 1.12
diff -u -r1.12 ContentHandler.java
--- src/org/xml/sax/ContentHandler.java 19 Mar 2004 16:33:05 -0000 1.12
+++ src/org/xml/sax/ContentHandler.java 25 Apr 2004 14:33:19 -0000
@@ -36,14 +36,13 @@
* and for reporting skipped entities (in non-validating XML
* processors).</p>
*
- * <p>Implementors should note that there is also a Java class
- * {@link java.net.ContentHandler ContentHandler} in the java.net
+ * <p>Implementors should note that there is also a
+ * <code>ContentHandler</code> class in the <code>java.net</code>
* package; that means that it's probably a bad idea to do</p>
*
- * <blockquote>
- * import java.net.*;
+ * <pre>import java.net.*;
* import org.xml.sax.*;
- * </blockquote>
+ * </pre>
*
* <p>In fact, "import ...*" is usually a sign of sloppy programming
* anyway, so the user should consider this a feature rather than a
@@ -82,8 +81,8 @@
* {@link #endDocument endDocument} is called. The
* application should not attempt to use it at any other time.</p>
*
- * @param locator An object that can return the location of
- * any SAX document event.
+ * @param locator an object that can return the location of
+ * any SAX document event
* @see org.xml.sax.Locator
*/
public void setDocumentLocator (Locator locator);
@@ -96,8 +95,8 @@
* other event callbacks (except for {@link #setDocumentLocator
* setDocumentLocator}).</p>
*
- * @exception org.xml.sax.SAXException Any SAX exception, possibly
- * wrapping another exception.
+ * @throws org.xml.sax.SAXException any SAX exception, possibly
+ * wrapping another exception
* @see #endDocument
*/
public void startDocument ()
@@ -121,8 +120,8 @@
* (because of an unrecoverable error) or reached the end of
* input.</p>
*
- * @exception org.xml.sax.SAXException Any SAX exception, possibly
- * wrapping another exception.
+ * @throws org.xml.sax.SAXException any SAX exception, possibly
+ * wrapping another exception
* @see #startDocument
*/
public void endDocument()
@@ -158,12 +157,12 @@
* <p>There should never be start/endPrefixMapping events for the
* "xml" prefix, since it is predeclared and immutable.</p>
*
- * @param prefix The Namespace prefix being declared.
+ * @param prefix the Namespace prefix being declared.
* An empty string is used for the default element namespace,
* which has no prefix.
- * @param uri The Namespace URI the prefix is mapped to.
- * @exception org.xml.sax.SAXException The client may throw
- * an exception during processing.
+ * @param uri the Namespace URI the prefix is mapped to
+ * @throws org.xml.sax.SAXException the client may throw
+ * an exception during processing
* @see #endPrefixMapping
* @see #startElement
*/
@@ -180,10 +179,10 @@
* {@link #endPrefixMapping endPrefixMapping} events is not otherwise
* guaranteed.</p>
*
- * @param prefix The prefix that was being mapped.
+ * @param prefix the prefix that was being mapped.
* This is the empty string when a default mapping scope ends.
- * @exception org.xml.sax.SAXException The client may throw
- * an exception during processing.
+ * @throws org.xml.sax.SAXException the client may throw
+ * an exception during processing
* @see #startPrefixMapping
* @see #endElement
*/
@@ -237,20 +236,20 @@
* <p>Like {@link #characters characters()}, attribute values may have
* characters that need more than one <code>char</code> value. </p>
*
- * @param uri The Namespace URI, or the empty string if the
+ * @param uri the Namespace URI, or the empty string if the
* element has no Namespace URI or if Namespace
- * processing is not being performed.
- * @param localName The local name (without prefix), or the
+ * processing is not being performed
+ * @param localName the local name (without prefix), or the
* empty string if Namespace processing is not being
- * performed.
- * @param qName The qualified name (with prefix), or the
- * empty string if qualified names are not available.
- * @param atts The attributes attached to the element. If
+ * performed
+ * @param qName the qualified name (with prefix), or the
+ * empty string if qualified names are not available
+ * @param atts the attributes attached to the element. If
* there are no attributes, it shall be an empty
* Attributes object. The value of this object after
- * startElement returns is undefined.
- * @exception org.xml.sax.SAXException Any SAX exception, possibly
- * wrapping another exception.
+ * startElement returns is undefined
+ * @throws org.xml.sax.SAXException any SAX exception, possibly
+ * wrapping another exception
* @see #endElement
* @see org.xml.sax.Attributes
* @see org.xml.sax.helpers.AttributesImpl
@@ -270,16 +269,16 @@
*
* <p>For information on the names, see startElement.</p>
*
- * @param uri The Namespace URI, or the empty string if the
+ * @param uri the Namespace URI, or the empty string if the
* element has no Namespace URI or if Namespace
- * processing is not being performed.
- * @param localName The local name (without prefix), or the
+ * processing is not being performed
+ * @param localName the local name (without prefix), or the
* empty string if Namespace processing is not being
- * performed.
- * @param qName The qualified XML name (with prefix), or the
- * empty string if qualified names are not available.
- * @exception org.xml.sax.SAXException Any SAX exception, possibly
- * wrapping another exception.
+ * performed
+ * @param qName the qualified XML name (with prefix), or the
+ * empty string if qualified names are not available
+ * @throws org.xml.sax.SAXException any SAX exception, possibly
+ * wrapping another exception
*/
public void endElement (String uri, String localName,
String qName)
@@ -321,11 +320,11 @@
* method rather than this one (validating parsers <em>must</em>
* do so).</p>
*
- * @param ch The characters from the XML document.
- * @param start The start position in the array.
- * @param length The number of characters to read from the array.
- * @exception org.xml.sax.SAXException Any SAX exception, possibly
- * wrapping another exception.
+ * @param ch the characters from the XML document
+ * @param start the start position in the array
+ * @param length the number of characters to read from the array
+ * @throws org.xml.sax.SAXException any SAX exception, possibly
+ * wrapping another exception
* @see #ignorableWhitespace
* @see org.xml.sax.Locator
*/
@@ -351,11 +350,11 @@
* <p>The application must not attempt to read from the array
* outside of the specified range.</p>
*
- * @param ch The characters from the XML document.
- * @param start The start position in the array.
- * @param length The number of characters to read from the array.
- * @exception org.xml.sax.SAXException Any SAX exception, possibly
- * wrapping another exception.
+ * @param ch the characters from the XML document
+ * @param start the start position in the array
+ * @param length the number of characters to read from the array
+ * @throws org.xml.sax.SAXException any SAX exception, possibly
+ * wrapping another exception
* @see #characters
*/
public void ignorableWhitespace (char ch[], int start, int length)
@@ -377,12 +376,12 @@
* data may have characters that need more than one <code>char</code>
* value. </p>
*
- * @param target The processing instruction target.
- * @param data The processing instruction data, or null if
+ * @param target the processing instruction target
+ * @param data the processing instruction data, or null if
* none was supplied. The data does not include any
- * whitespace separating it from the target.
- * @exception org.xml.sax.SAXException Any SAX exception, possibly
- * wrapping another exception.
+ * whitespace separating it from the target
+ * @throws org.xml.sax.SAXException any SAX exception, possibly
+ * wrapping another exception
*/
public void processingInstruction (String target, String data)
throws SAXException;
@@ -406,12 +405,12 @@
* <code>http://xml.org/sax/features/external-parameter-entities</code>
* properties.</p>
*
- * @param name The name of the skipped entity. If it is a
+ * @param name the name of the skipped entity. If it is a
* parameter entity, the name will begin with '%', and if
* it is the external DTD subset, it will be the string
- * "[dtd]".
- * @exception org.xml.sax.SAXException Any SAX exception, possibly
- * wrapping another exception.
+ * "[dtd]"
+ * @throws org.xml.sax.SAXException any SAX exception, possibly
+ * wrapping another exception
*/
public void skippedEntity (String name)
throws SAXException;