svnno****@sourc*****
svnno****@sourc*****
2008年 10月 29日 (水) 00:49:30 JST
Revision: 2058
http://svn.sourceforge.jp/cgi-bin/viewcvs.cgi?root=jiemamy&view=rev&rev=2058
Author: daisuke_m
Date: 2008-10-29 00:49:30 +0900 (Wed, 29 Oct 2008)
Log Message:
-----------
javadocのフォーマッティング。
Modified Paths:
--------------
artemis/trunk/org.jiemamy.serializer/src/main/java/com/megginson/sax/XMLWriter.java
-------------- next part --------------
Modified: artemis/trunk/org.jiemamy.serializer/src/main/java/com/megginson/sax/XMLWriter.java
===================================================================
--- artemis/trunk/org.jiemamy.serializer/src/main/java/com/megginson/sax/XMLWriter.java 2008-10-27 16:03:03 UTC (rev 2057)
+++ artemis/trunk/org.jiemamy.serializer/src/main/java/com/megginson/sax/XMLWriter.java 2008-10-28 15:49:30 UTC (rev 2058)
@@ -21,217 +21,224 @@
/**
* Filter to write an XML document from a SAX event stream.
- *
- * <p>This class can be used by itself or as part of a SAX event
- * stream: it takes as input a series of SAX2 ContentHandler
- * events and uses the information in those events to write
- * an XML document. Since this class is a filter, it can also
- * pass the events on down a filter chain for further processing
- * (you can use the XMLWriter to take a snapshot of the current
- * state at any point in a filter chain), and it can be
- * used directly as a ContentHandler for a SAX2 XMLReader.</p>
- *
- * <p>The client creates a document by invoking the methods for
- * standard SAX2 events, always beginning with the
- * {@link #startDocument startDocument} method and ending with
- * the {@link #endDocument endDocument} method. There are convenience
- * methods provided so that clients to not have to create empty
- * attribute lists or provide empty strings as parameters; for
- * example, the method invocation</p>
- *
+ *
+ * <p>
+ * This class can be used by itself or as part of a SAX event stream: it takes as input a series of SAX2 ContentHandler
+ * events and uses the information in those events to write an XML document. Since this class is a filter, it can also
+ * pass the events on down a filter chain for further processing (you can use the XMLWriter to take a snapshot of the
+ * current state at any point in a filter chain), and it can be used directly as a ContentHandler for a SAX2 XMLReader.
+ * </p>
+ *
+ * <p>
+ * The client creates a document by invoking the methods for standard SAX2 events, always beginning with the
+ * {@link #startDocument startDocument} method and ending with the {@link #endDocument endDocument} method. There are
+ * convenience methods provided so that clients to not have to create empty attribute lists or provide empty strings as
+ * parameters; for example, the method invocation
+ * </p>
+ *
* <pre>
- * w.startElement("foo");
+ * w.startElement("foo");
* </pre>
- *
- * <p>is equivalent to the regular SAX2 ContentHandler method</p>
- *
+ *
+ * <p>
+ * is equivalent to the regular SAX2 ContentHandler method
+ * </p>
+ *
* <pre>
- * w.startElement("", "foo", "", new AttributesImpl());
+ * w.startElement("", "foo", "", new AttributesImpl());
* </pre>
- *
- * <p>Except that it is more efficient because it does not allocate
- * a new empty attribute list each time. The following code will send
- * a simple XML document to standard output:</p>
- *
+ *
+ * <p>
+ * Except that it is more efficient because it does not allocate a new empty attribute list each time. The following
+ * code will send a simple XML document to standard output:
+ * </p>
+ *
* <pre>
* XMLWriter w = new XMLWriter();
- *
* w.startDocument();
- * w.startElement("greeting");
- * w.characters("Hello, world!");
- * w.endElement("greeting");
+ * w.startElement("greeting");
+ * w.characters("Hello, world!");
+ * w.endElement("greeting");
* w.endDocument();
* </pre>
- *
- * <p>The resulting document will look like this:</p>
- *
+ *
+ * <p>
+ * The resulting document will look like this:
+ * </p>
+ *
* <pre>
- * <?xml version="1.0" standalone="yes"?>
- *
- * <greeting>Hello, world!</greeting>
+ * <?xml version="1.0" standalone="yes"?>
+ * <greeting>Hello, world!</greeting>
* </pre>
- *
- * <p>In fact, there is an even simpler convenience method,
- * <var>dataElement</var>, designed for writing elements that
- * contain only character data, so the code to generate the
- * document could be shortened to</p>
- *
+ *
+ * <p>
+ * In fact, there is an even simpler convenience method, <var>dataElement</var>, designed for writing elements that
+ * contain only character data, so the code to generate the document could be shortened to
+ * </p>
+ *
* <pre>
* XMLWriter w = new XMLWriter();
- *
* w.startDocument();
- * w.dataElement("greeting", "Hello, world!");
+ * w.dataElement("greeting", "Hello, world!");
* w.endDocument();
* </pre>
- *
+ *
* <h2>Whitespace</h2>
- *
- * <p>According to the XML Recommendation, <em>all</em> whitespace
- * in an XML document is potentially significant to an application,
- * so this class never adds newlines or indentation. If you
- * insert three elements in a row, as in</p>
- *
+ *
+ * <p>
+ * According to the XML Recommendation, <em>all</em> whitespace in an XML document is potentially significant to an
+ * application, so this class never adds newlines or indentation. If you insert three elements in a row, as in
+ * </p>
+ *
* <pre>
- * w.dataElement("item", "1");
- * w.dataElement("item", "2");
- * w.dataElement("item", "3");
+ * w.dataElement("item", "1");
+ * w.dataElement("item", "2");
+ * w.dataElement("item", "3");
* </pre>
- *
- * <p>you will end up with</p>
- *
+ *
+ * <p>
+ * you will end up with
+ * </p>
+ *
* <pre>
- * <item>1</item><item>3</item><item>3</item>
+ * <item>1</item><item>3</item><item>3</item>
* </pre>
- *
- * <p>You need to invoke one of the <var>characters</var> methods
- * explicitly to add newlines or indentation. Alternatively, you
- * can use {@link com.megginson.sax.DataWriter DataWriter}, which
- * is derived from this class -- it is optimized for writing
- * purely data-oriented (or field-oriented) XML, and does automatic
- * linebreaks and indentation (but does not support mixed content
- * properly).</p>
- *
- *
+ *
+ * <p>
+ * You need to invoke one of the <var>characters</var> methods explicitly to add newlines or indentation.
+ * Alternatively, you can use {@link com.megginson.sax.DataWriter DataWriter}, which is derived from this class -- it
+ * is optimized for writing purely data-oriented (or field-oriented) XML, and does automatic linebreaks and indentation
+ * (but does not support mixed content properly).
+ * </p>
+ *
+ *
* <h2>Namespace Support</h2>
- *
- * <p>The writer contains extensive support for XML Namespaces, so that
- * a client application does not have to keep track of prefixes and
- * supply <var>xmlns</var> attributes. By default, the XML writer will
- * generate Namespace declarations in the form _NS1, _NS2, etc., wherever
- * they are needed, as in the following example:</p>
- *
+ *
+ * <p>
+ * The writer contains extensive support for XML Namespaces, so that a client application does not have to keep track of
+ * prefixes and supply <var>xmlns</var> attributes. By default, the XML writer will generate Namespace declarations in
+ * the form _NS1, _NS2, etc., wherever they are needed, as in the following example:
+ * </p>
+ *
* <pre>
* w.startDocument();
- * w.emptyElement("http://www.foo.com/ns/", "foo");
+ * w.emptyElement("http://www.foo.com/ns/", "foo");
* w.endDocument();
* </pre>
- *
- * <p>The resulting document will look like this:</p>
- *
+ *
+ * <p>
+ * The resulting document will look like this:
+ * </p>
+ *
* <pre>
- * <?xml version="1.0" standalone="yes"?>
- *
- * <_NS1:foo xmlns:_NS1="http://www.foo.com/ns/"/>
+ * <?xml version="1.0" standalone="yes"?>
+ * <_NS1:foo xmlns:_NS1="http://www.foo.com/ns/"/>
* </pre>
- *
- * <p>In many cases, document authors will prefer to choose their
- * own prefixes rather than using the (ugly) default names. The
- * XML writer allows two methods for selecting prefixes:</p>
- *
+ *
+ * <p>
+ * In many cases, document authors will prefer to choose their own prefixes rather than using the (ugly) default names.
+ * The XML writer allows two methods for selecting prefixes:
+ * </p>
+ *
* <ol>
* <li>the qualified name</li>
* <li>the {@link #setPrefix setPrefix} method.</li>
* </ol>
- *
- * <p>Whenever the XML writer finds a new Namespace URI, it checks
- * to see if a qualified (prefixed) name is also available; if so
- * it attempts to use the name's prefix (as long as the prefix is
- * not already in use for another Namespace URI).</p>
- *
- * <p>Before writing a document, the client can also pre-map a prefix
- * to a Namespace URI with the setPrefix method:</p>
- *
+ *
+ * <p>
+ * Whenever the XML writer finds a new Namespace URI, it checks to see if a qualified (prefixed) name is also available;
+ * if so it attempts to use the name's prefix (as long as the prefix is not already in use for another Namespace URI).
+ * </p>
+ *
+ * <p>
+ * Before writing a document, the client can also pre-map a prefix to a Namespace URI with the setPrefix method:
+ * </p>
+ *
* <pre>
- * w.setPrefix("http://www.foo.com/ns/", "foo");
+ * w.setPrefix("http://www.foo.com/ns/", "foo");
* w.startDocument();
- * w.emptyElement("http://www.foo.com/ns/", "foo");
+ * w.emptyElement("http://www.foo.com/ns/", "foo");
* w.endDocument();
* </pre>
- *
- * <p>The resulting document will look like this:</p>
- *
+ *
+ * <p>
+ * The resulting document will look like this:
+ * </p>
+ *
* <pre>
- * <?xml version="1.0" standalone="yes"?>
- *
- * <foo:foo xmlns:foo="http://www.foo.com/ns/"/>
+ * <?xml version="1.0" standalone="yes"?>
+ * <foo:foo xmlns:foo="http://www.foo.com/ns/"/>
* </pre>
- *
- * <p>The default Namespace simply uses an empty string as the prefix:</p>
- *
+ *
+ * <p>
+ * The default Namespace simply uses an empty string as the prefix:
+ * </p>
+ *
* <pre>
- * w.setPrefix("http://www.foo.com/ns/", "");
+ * w.setPrefix("http://www.foo.com/ns/", "");
* w.startDocument();
- * w.emptyElement("http://www.foo.com/ns/", "foo");
+ * w.emptyElement("http://www.foo.com/ns/", "foo");
* w.endDocument();
* </pre>
- *
- * <p>The resulting document will look like this:</p>
- *
+ *
+ * <p>
+ * The resulting document will look like this:
+ * </p>
+ *
* <pre>
- * <?xml version="1.0" standalone="yes"?>
- *
- * <foo xmlns="http://www.foo.com/ns/"/>
+ * <?xml version="1.0" standalone="yes"?>
+ * <foo xmlns="http://www.foo.com/ns/"/>
* </pre>
- *
- * <p>By default, the XML writer will not declare a Namespace until
- * it is actually used. Sometimes, this approach will create
- * a large number of Namespace declarations, as in the following
- * example:</p>
- *
+ *
+ * <p>
+ * By default, the XML writer will not declare a Namespace until it is actually used. Sometimes, this approach will
+ * create a large number of Namespace declarations, as in the following example:
+ * </p>
+ *
* <pre>
- * <xml version="1.0" standalone="yes"?>
- *
- * <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
- * <rdf:Description about="http://www.foo.com/ids/books/12345">
- * <dc:title xmlns:dc="http://www.purl.org/dc/">A Dark Night</dc:title>
- * <dc:creator xmlns:dc="http://www.purl.org/dc/">Jane Smith</dc:title>
- * <dc:date xmlns:dc="http://www.purl.org/dc/">2000-09-09</dc:title>
- * </rdf:Description>
- * </rdf:RDF>
+ * <xml version="1.0" standalone="yes"?>
+ * <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+ * <rdf:Description about="http://www.foo.com/ids/books/12345">
+ * <dc:title xmlns:dc="http://www.purl.org/dc/">A Dark Night</dc:title>
+ * <dc:creator xmlns:dc="http://www.purl.org/dc/">Jane Smith</dc:title>
+ * <dc:date xmlns:dc="http://www.purl.org/dc/">2000-09-09</dc:title>
+ * </rdf:Description>
+ * </rdf:RDF>
* </pre>
- *
- * <p>The "rdf" prefix is declared only once, because the RDF Namespace
- * is used by the root element and can be inherited by all of its
- * descendants; the "dc" prefix, on the other hand, is declared three
- * times, because no higher element uses the Namespace. To solve this
- * problem, you can instruct the XML writer to predeclare Namespaces
- * on the root element even if they are not used there:</p>
- *
+ *
+ * <p>
+ * The "rdf" prefix is declared only once, because the RDF Namespace is used by the root element and can be inherited by
+ * all of its descendants; the "dc" prefix, on the other hand, is declared three times, because no higher element uses
+ * the Namespace. To solve this problem, you can instruct the XML writer to predeclare Namespaces on the root element
+ * even if they are not used there:
+ * </p>
+ *
* <pre>
- * w.forceNSDecl("http://www.purl.org/dc/");
+ * w.forceNSDecl("http://www.purl.org/dc/");
* </pre>
- *
- * <p>Now, the "dc" prefix will be declared on the root element even
- * though it's not needed there, and can be inherited by its
- * descendants:</p>
- *
+ *
+ * <p>
+ * Now, the "dc" prefix will be declared on the root element even though it's not needed there, and can be inherited by
+ * its descendants:
+ * </p>
+ *
* <pre>
- * <xml version="1.0" standalone="yes"?>
- *
- * <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
- * xmlns:dc="http://www.purl.org/dc/">
- * <rdf:Description about="http://www.foo.com/ids/books/12345">
- * <dc:title>A Dark Night</dc:title>
- * <dc:creator>Jane Smith</dc:title>
- * <dc:date>2000-09-09</dc:title>
- * </rdf:Description>
- * </rdf:RDF>
+ * <xml version="1.0" standalone="yes"?>
+ * <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+ * xmlns:dc="http://www.purl.org/dc/">
+ * <rdf:Description about="http://www.foo.com/ids/books/12345">
+ * <dc:title>A Dark Night</dc:title>
+ * <dc:creator>Jane Smith</dc:title>
+ * <dc:date>2000-09-09</dc:title>
+ * </rdf:Description>
+ * </rdf:RDF>
* </pre>
- *
- * <p>This approach is also useful for declaring Namespace prefixes
- * that be used by qualified names appearing in attribute values or
- * character data.</p>
- *
+ *
+ * <p>
+ * This approach is also useful for declaring Namespace prefixes that be used by qualified names appearing in attribute
+ * values or character data.
+ * </p>
+ *
* @author David Megginson, david****@meggi*****
* @version 0.2
* @see org.xml.sax.XMLFilter
@@ -256,16 +263,17 @@
private int prefixCounter = 0;
/**
- * 出力時に使用する改行コード。
- * デフォルトでシステムプロパティに設定されている値を使用する。
+ * 出力時に使用する改行コード。 デフォルトでシステムプロパティに設定されている値を使用する。
*/
private String lineSeparator = System.getProperty("line.separator");
/**
* Create a new XML writer.
- *
- * <p>Write to standard output.</p>
+ *
+ * <p>
+ * Write to standard output.
+ * </p>
*/
public XMLWriter() {
init(null);
@@ -273,11 +281,12 @@
/**
* Create a new XML writer.
- *
- * <p>Write to the writer provided.</p>
- *
- * @param writer The output destination, or null to use standard
- * output.
+ *
+ * <p>
+ * Write to the writer provided.
+ * </p>
+ *
+ * @param writer The output destination, or null to use standard output.
*/
public XMLWriter(Writer writer) {
init(writer);
@@ -285,11 +294,12 @@
/**
* Create a new XML writer.
- *
- * <p>Use the specified XML reader as the parent.</p>
- *
- * @param xmlreader The parent in the filter chain, or null
- * for no parent.
+ *
+ * <p>
+ * Use the specified XML reader as the parent.
+ * </p>
+ *
+ * @param xmlreader The parent in the filter chain, or null for no parent.
*/
public XMLWriter(XMLReader xmlreader) {
super(xmlreader);
@@ -298,14 +308,13 @@
/**
* Create a new XML writer.
- *
- * <p>Use the specified XML reader as the parent, and write
- * to the specified writer.</p>
- *
- * @param xmlreader The parent in the filter chain, or null
- * for no parent.
- * @param writer The output destination, or null to use standard
- * output.
+ *
+ * <p>
+ * Use the specified XML reader as the parent, and write to the specified writer.
+ * </p>
+ *
+ * @param xmlreader The parent in the filter chain, or null for no parent.
+ * @param writer The output destination, or null to use standard output.
*/
public XMLWriter(XMLReader xmlreader, Writer writer) {
super(xmlreader);
@@ -314,15 +323,14 @@
/**
* Write character data.
- *
+ *
* Pass the event on down the filter chain for further processing.
- *
+ *
* @param ch The array of characters to write.
* @param start The starting position in the array.
* @param len The number of characters to write.
- * @exception org.xml.sax.SAXException If there is an error
- * writing the characters, or if a handler further down
- * the filter chain raises an exception.
+ * @exception org.xml.sax.SAXException If there is an error writing the characters, or if a handler further down the
+ * filter chain raises an exception.
* @see org.xml.sax.ContentHandler#characters
*/
@Override
@@ -333,15 +341,15 @@
/**
* Write a string of character data, with XML escaping.
- *
- * <p>This is a convenience method that takes an XML
- * String, converts it to a character array, then invokes
- * {@link #characters(char[], int, int)}.</p>
- *
+ *
+ * <p>
+ * This is a convenience method that takes an XML String, converts it to a character array, then invokes
+ * {@link #characters(char[], int, int)}.
+ * </p>
+ *
* @param data The character data.
- * @exception org.xml.sax.SAXException If there is an error
- * writing the string, or if a handler further down
- * the filter chain raises an exception.
+ * @exception org.xml.sax.SAXException If there is an error writing the string, or if a handler further down the
+ * filter chain raises an exception.
* @see #characters(char[], int, int)
*/
public void characters(String data) throws SAXException {
@@ -351,24 +359,22 @@
/**
* Write an element with character data content but no attributes or Namespace URI.
- *
- * <p>This is a convenience method to write a complete element
- * with character data content, including the start tag
- * and end tag. The method provides an empty string for the
- * Namespace URI, and empty string for the qualified name,
- * and an empty attribute list.</p>
- *
- * <p>This method invokes
- * {@link #startElement(String, String, String, Attributes)},
- * followed by
- * {@link #characters(String)}, followed by
- * {@link #endElement(String, String, String)}.</p>
- *
+ *
+ * <p>
+ * This is a convenience method to write a complete element with character data content, including the start tag and
+ * end tag. The method provides an empty string for the Namespace URI, and empty string for the qualified name, and
+ * an empty attribute list.
+ * </p>
+ *
+ * <p>
+ * This method invokes {@link #startElement(String, String, String, Attributes)}, followed by
+ * {@link #characters(String)}, followed by {@link #endElement(String, String, String)}.
+ * </p>
+ *
* @param localName The element's local name.
* @param content The character data content.
- * @exception org.xml.sax.SAXException If there is an error
- * writing the empty tag, or if a handler further down
- * the filter chain raises an exception.
+ * @exception org.xml.sax.SAXException If there is an error writing the empty tag, or if a handler further down the
+ * filter chain raises an exception.
* @see #startElement(String, String, String, Attributes)
* @see #characters(String)
* @see #endElement(String, String, String)
@@ -379,24 +385,22 @@
/**
* Write an element with character data content but no attributes.
- *
- * <p>This is a convenience method to write a complete element
- * with character data content, including the start tag
- * and end tag. This method provides an empty string
- * for the qname and an empty attribute list.</p>
- *
- * <p>This method invokes
- * {@link #startElement(String, String, String, Attributes)},
- * followed by
- * {@link #characters(String)}, followed by
- * {@link #endElement(String, String, String)}.</p>
- *
+ *
+ * <p>
+ * This is a convenience method to write a complete element with character data content, including the start tag and
+ * end tag. This method provides an empty string for the qname and an empty attribute list.
+ * </p>
+ *
+ * <p>
+ * This method invokes {@link #startElement(String, String, String, Attributes)}, followed by
+ * {@link #characters(String)}, followed by {@link #endElement(String, String, String)}.
+ * </p>
+ *
* @param uri The element's Namespace URI.
* @param localName The element's local name.
* @param content The character data content.
- * @exception org.xml.sax.SAXException If there is an error
- * writing the empty tag, or if a handler further down
- * the filter chain raises an exception.
+ * @exception org.xml.sax.SAXException If there is an error writing the empty tag, or if a handler further down the
+ * filter chain raises an exception.
* @see #startElement(String, String, String, Attributes)
* @see #characters(String)
* @see #endElement(String, String, String)
@@ -407,25 +411,24 @@
/**
* Write an element with character data content.
- *
- * <p>This is a convenience method to write a complete element
- * with character data content, including the start tag
- * and end tag.</p>
- *
- * <p>This method invokes
- * {@link #startElement(String, String, String, Attributes)},
- * followed by
- * {@link #characters(String)}, followed by
- * {@link #endElement(String, String, String)}.</p>
- *
+ *
+ * <p>
+ * This is a convenience method to write a complete element with character data content, including the start tag and
+ * end tag.
+ * </p>
+ *
+ * <p>
+ * This method invokes {@link #startElement(String, String, String, Attributes)}, followed by
+ * {@link #characters(String)}, followed by {@link #endElement(String, String, String)}.
+ * </p>
+ *
* @param uri The element's Namespace URI.
* @param localName The element's local name.
* @param qName The element's default qualified name.
* @param atts The element's attributes.
* @param content The character data content.
- * @exception org.xml.sax.SAXException If there is an error
- * writing the empty tag, or if a handler further down
- * the filter chain raises an exception.
+ * @exception org.xml.sax.SAXException If there is an error writing the empty tag, or if a handler further down the
+ * filter chain raises an exception.
* @see #startElement(String, String, String, Attributes)
* @see #characters(String)
* @see #endElement(String, String, String)
@@ -439,17 +442,15 @@
/**
* Add an empty element without a Namespace URI, qname or attributes.
- *
- * <p>This method will supply an empty string for the qname,
- * and empty string for the Namespace URI, and an empty
- * attribute list. It invokes
- * {@link #emptyElement(String, String, String, Attributes)}
- * directly.</p>
- *
+ *
+ * <p>
+ * This method will supply an empty string for the qname, and empty string for the Namespace URI, and an empty
+ * attribute list. It invokes {@link #emptyElement(String, String, String, Attributes)} directly.
+ * </p>
+ *
* @param localName The element's local name.
- * @exception org.xml.sax.SAXException If there is an error
- * writing the empty tag, or if a handler further down
- * the filter chain raises an exception.
+ * @exception org.xml.sax.SAXException If there is an error writing the empty tag, or if a handler further down the
+ * filter chain raises an exception.
* @see #emptyElement(String, String, String, Attributes)
*/
public void emptyElement(String localName) throws SAXException {
@@ -458,17 +459,16 @@
/**
* Add an empty element without a qname or attributes.
- *
- * <p>This method will supply an empty string for the qname
- * and an empty attribute list. It invokes
- * {@link #emptyElement(String, String, String, Attributes)}
- * directly.</p>
- *
+ *
+ * <p>
+ * This method will supply an empty string for the qname and an empty attribute list. It invokes
+ * {@link #emptyElement(String, String, String, Attributes)} directly.
+ * </p>
+ *
* @param uri The element's Namespace URI.
* @param localName The element's local name.
- * @exception org.xml.sax.SAXException If there is an error
- * writing the empty tag, or if a handler further down
- * the filter chain raises an exception.
+ * @exception org.xml.sax.SAXException If there is an error writing the empty tag, or if a handler further down the
+ * filter chain raises an exception.
* @see #emptyElement(String, String, String, Attributes)
*/
public void emptyElement(String uri, String localName) throws SAXException {
@@ -477,25 +477,19 @@
/**
* Write an empty element.
- *
- * This method writes an empty element tag rather than a start tag
- * followed by an end tag. Both a {@link #startElement(String, String, String, Attributes)
- * startElement} and an {@link #endElement(String, String, String) endElement} event will
- * be passed on down the filter chain.
- *
- * @param uri The element's Namespace URI, or the empty string
- * if the element has no Namespace or if Namespace
- * processing is not being performed.
- * @param localName The element's local name (without prefix). This
- * parameter must be provided.
- * @param qName The element's qualified name (with prefix), or
- * the empty string if none is available. This parameter
- * is strictly advisory: the writer may or may not use
- * the prefix attached.
+ *
+ * This method writes an empty element tag rather than a start tag followed by an end tag. Both a
+ * {@link #startElement(String, String, String, Attributes) startElement} and an
+ * {@link #endElement(String, String, String) endElement} event will be passed on down the filter chain.
+ *
+ * @param uri The element's Namespace URI, or the empty string if the element has no Namespace or if Namespace
+ * processing is not being performed.
+ * @param localName The element's local name (without prefix). This parameter must be provided.
+ * @param qName The element's qualified name (with prefix), or the empty string if none is available. This parameter
+ * is strictly advisory: the writer may or may not use the prefix attached.
* @param atts The element's attribute list.
- * @exception org.xml.sax.SAXException If there is an error
- * writing the empty tag, or if a handler further down
- * the filter chain raises an exception.
+ * @exception org.xml.sax.SAXException If there is an error writing the empty tag, or if a handler further down the
+ * filter chain raises an exception.
* @see #startElement(String, String, String, Attributes)
* @see #endElement(String, String, String)
*/
@@ -516,12 +510,11 @@
/**
* Write a newline at the end of the document.
- *
+ *
* Pass the event on down the filter chain for further processing.
- *
- * @exception org.xml.sax.SAXException If there is an error
- * writing the newline, or if a handler further down
- * the filter chain raises an exception.
+ *
+ * @exception org.xml.sax.SAXException If there is an error writing the newline, or if a handler further down the
+ * filter chain raises an exception.
* @see org.xml.sax.ContentHandler#endDocument
*/
@Override
@@ -536,9 +529,15 @@
}
/**
- * End an element without a Namespace URI or qname. <p>This method will supply an empty string for the qName and an empty string for the Namespace URI. It invokes {@link #endElement(String,String,String)} directly.</p>
- * @param localName The element's local name.
- * @exception org.xml.sax.SAXException If there is an error writing the end tag, or if a handler further down the filter chain raises an exception.
+ * End an element without a Namespace URI or qname.
+ * <p>
+ * This method will supply an empty string for the qName and an empty string for the Namespace URI. It invokes
+ * {@link #endElement(String,String,String)} directly.
+ * </p>
+ *
+ * @param localName The element's local name.
+ * @exception org.xml.sax.SAXException If there is an error writing the end tag, or if a handler further down the
+ * filter chain raises an exception.
* @see #endElement(String,String,String)
*/
public void endElement(String localName) throws SAXException {
@@ -546,10 +545,16 @@
}
/**
- * End an element without a qname. <p>This method will supply an empty string for the qName. It invokes {@link #endElement(String,String,String)} directly.</p>
- * @param uri The element's Namespace URI.
- * @param localName The element's local name.
- * @exception org.xml.sax.SAXException If there is an error writing the end tag, or if a handler further down the filter chain raises an exception.
+ * End an element without a qname.
+ * <p>
+ * This method will supply an empty string for the qName. It invokes {@link #endElement(String,String,String)}
+ * directly.
+ * </p>
+ *
+ * @param uri The element's Namespace URI.
+ * @param localName The element's local name.
+ * @exception org.xml.sax.SAXException If there is an error writing the end tag, or if a handler further down the
+ * filter chain raises an exception.
* @see #endElement(String,String,String)
*/
public void endElement(String uri, String localName) throws SAXException {
@@ -558,10 +563,14 @@
/**
* Write an end tag. Pass the event on down the filter chain for further processing.
- * @param uri The Namespace URI, or the empty string if none is available.
- * @param localName The element's local (unprefixed) name (required).
- * @param qName The element's qualified (prefixed) name, or the empty string is none is available. This method will use the qName as a template for generating a prefix if necessary, but it is not guaranteed to use the same qName.
- * @exception org.xml.sax.SAXException If there is an error writing the end tag, or if a handler further down the filter chain raises an exception.
+ *
+ * @param uri The Namespace URI, or the empty string if none is available.
+ * @param localName The element's local (unprefixed) name (required).
+ * @param qName The element's qualified (prefixed) name, or the empty string is none is available. This method will
+ * use the qName as a template for generating a prefix if necessary, but it is not guaranteed to use the
+ * same qName.
+ * @exception org.xml.sax.SAXException If there is an error writing the end tag, or if a handler further down the
+ * filter chain raises an exception.
* @see org.xml.sax.ContentHandler#endElement
*/
@Override
@@ -578,8 +587,16 @@
}
/**
- * Flush the output. <p>This method flushes the output stream. It is especially useful when you need to make certain that the entire document has been written to output but do not want to close the output stream.</p> <p>This method is invoked automatically by the {@link #endDocument endDocument} method after writing a document.</p>
- * @throws IOException
+ * Flush the output.
+ * <p>
+ * This method flushes the output stream. It is especially useful when you need to make certain that the entire
+ * document has been written to output but do not want to close the output stream.
+ * </p>
+ * <p>
+ * This method is invoked automatically by the {@link #endDocument endDocument} method after writing a document.
+ * </p>
+ *
+ * @throws IOException
* @see #reset
*/
public void flush() throws IOException {
@@ -587,8 +604,17 @@
}
/**
- * Force a Namespace to be declared on the root element. <p>By default, the XMLWriter will declare only the Namespaces needed for an element; as a result, a Namespace may be declared many places in a document if it is not used on the root element.</p> <p>This method forces a Namespace to be declared on the root element even if it is not used there, and reduces the number of xmlns attributes in the document.</p>
- * @param uri The Namespace URI to declare.
+ * Force a Namespace to be declared on the root element.
+ * <p>
+ * By default, the XMLWriter will declare only the Namespaces needed for an element; as a result, a Namespace may be
+ * declared many places in a document if it is not used on the root element.
+ * </p>
+ * <p>
+ * This method forces a Namespace to be declared on the root element even if it is not used there, and reduces the
+ * number of xmlns attributes in the document.
+ * </p>
+ *
+ * @param uri The Namespace URI to declare.
* @see #forceNSDecl(java.lang.String,java.lang.String)
* @see #setPrefix
*/
@@ -597,9 +623,14 @@
}
/**
- * Force a Namespace declaration with a preferred prefix. <p>This is a convenience method that invokes {@link #setPrefix setPrefix} then {@link #forceNSDecl(java.lang.String) forceNSDecl} .</p>
- * @param uri The Namespace URI to declare on the root element.
- * @param prefix The preferred prefix for the Namespace, or "" for the default Namespace.
+ * Force a Namespace declaration with a preferred prefix.
+ * <p>
+ * This is a convenience method that invokes {@link #setPrefix setPrefix} then
+ * {@link #forceNSDecl(java.lang.String) forceNSDecl} .
+ * </p>
+ *
+ * @param uri The Namespace URI to declare on the root element.
+ * @param prefix The preferred prefix for the Namespace, or "" for the default Namespace.
* @see #setPrefix
* @see #forceNSDecl(java.lang.String)
*/
@@ -610,7 +641,8 @@
/**
* 使用している改行コードを取得する。
- * @return 現在設定されている改行コード。
+ *
+ * @return 現在設定されている改行コード。
*/
public String getLineSeparator() {
return lineSeparator;
@@ -618,8 +650,9 @@
/**
* Get the current or preferred prefix for a Namespace URI.
- * @param uri The Namespace URI.
- * @return The preferred prefix, or "" for the default Namespace.
+ *
+ * @param uri The Namespace URI.
+ * @return The preferred prefix, or "" for the default Namespace.
* @see #setPrefix
*/
public String getPrefix(String uri) {
@@ -628,23 +661,27 @@
/**
* Write ignorable whitespace. Pass the event on down the filter chain for further processing.
- * @param ch The array of characters to write.
- * @param start The starting position in the array.
- * @param length The number of characters to write.
- * @exception org.xml.sax.SAXException If there is an error writing the whitespace, or if a handler further down the filter chain raises an exception.
+ *
+ * @param ch The array of characters to write.
+ * @param start The starting position in the array.
+ * @param length The number of characters to write.
+ * @exception org.xml.sax.SAXException If there is an error writing the whitespace, or if a handler further down the
+ * filter chain raises an exception.
* @see org.xml.sax.ContentHandler#ignorableWhitespace
*/
@Override
- public void ignorableWhitespace(char ch[], int start, int length) throws SAXException {
+ public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException {
writeEsc(ch, start, length, false);
super.ignorableWhitespace(ch, start, length);
}
/**
* Write a processing instruction. Pass the event on down the filter chain for further processing.
- * @param target The PI target.
- * @param data The PI data.
- * @exception org.xml.sax.SAXException If there is an error writing the PI, or if a handler further down the filter chain raises an exception.
+ *
+ * @param target The PI target.
+ * @param data The PI data.
+ * @exception org.xml.sax.SAXException If there is an error writing the PI, or if a handler further down the filter
+ * chain raises an exception.
* @see org.xml.sax.ContentHandler#processingInstruction
*/
@Override
@@ -661,7 +698,21 @@
}
/**
- * Reset the writer. <p>This method is especially useful if the writer throws an exception before it is finished, and you want to reuse the writer for a new document. It is usually a good idea to invoke {@link #flush flush} before resetting the writer, to make sure that no output is lost.</p> <p>This method is invoked automatically by the {@link #startDocument startDocument} method before writing a new document.</p> <p><strong>Note:</strong> this method will <em>not</em> clear the prefix or URI information in the writer or the selected output writer.</p>
+ * Reset the writer.
+ * <p>
+ * This method is especially useful if the writer throws an exception before it is finished, and you want to reuse
+ * the writer for a new document. It is usually a good idea to invoke {@link #flush flush} before resetting the
+ * writer, to make sure that no output is lost.
+ * </p>
+ * <p>
+ * This method is invoked automatically by the {@link #startDocument startDocument} method before writing a new
+ * document.
+ * </p>
+ * <p>
+ * <strong>Note:</strong> this method will <em>not</em> clear the prefix or URI information in the writer or the
+ * selected output writer.
+ * </p>
+ *
* @see #flush
*/
public void reset() {
@@ -672,7 +723,8 @@
/**
* 使用する改行コードを設定する。
- * @param lineSeparator 設定する改行コード。
+ *
+ * @param lineSeparator 設定する改行コード。
*/
public void setLineSeparator(String lineSeparator) {
this.lineSeparator = lineSeparator;
@@ -680,7 +732,8 @@
/**
* Set a new output destination for the document.
- * @param writer The output destination, or null to use standard output.
+ *
+ * @param writer The output destination, or null to use standard output.
* @see #flush
*/
public void setOutput(Writer writer) {
@@ -692,9 +745,14 @@
}
/**
- * Specify a preferred prefix for a Namespace URI. <p>Note that this method does not actually force the Namespace to be declared; to do that, use the {@link #forceNSDecl(java.lang.String) forceNSDecl} method as well.</p>
- * @param uri The Namespace URI.
- * @param prefix The preferred prefix, or "" to select the default Namespace.
+ * Specify a preferred prefix for a Namespace URI.
+ * <p>
+ * Note that this method does not actually force the Namespace to be declared; to do that, use the
+ * {@link #forceNSDecl(java.lang.String) forceNSDecl} method as well.
+ * </p>
+ *
+ * @param uri The Namespace URI.
+ * @param prefix The preferred prefix, or "" to select the default Namespace.
* @see #getPrefix
* @see #forceNSDecl(java.lang.String)
* @see #forceNSDecl(java.lang.String,java.lang.String)
@@ -704,8 +762,11 @@
}
/**
- * Write the XML declaration at the beginning of the document. Pass the event on down the filter chain for further processing.
- * @exception org.xml.sax.SAXException If there is an error writing the XML declaration, or if a handler further down the filter chain raises an exception.
+ * Write the XML declaration at the beginning of the document. Pass the event on down the filter chain for further
+ * processing.
+ *
+ * @exception org.xml.sax.SAXException If there is an error writing the XML declaration, or if a handler further
+ * down the filter chain raises an exception.
* @see org.xml.sax.ContentHandler#startDocument
*/
@Override
@@ -716,9 +777,15 @@
}
/**
- * Start a new element without a qname, attributes or a Namespace URI. <p>This method will provide an empty string for the Namespace URI, and empty string for the qualified name, and a default empty attribute list. It invokes #startElement(String, String, String, Attributes)} directly.</p>
- * @param localName The element's local name.
- * @exception org.xml.sax.SAXException If there is an error writing the start tag, or if a handler further down the filter chain raises an exception.
+ * Start a new element without a qname, attributes or a Namespace URI.
+ * <p>
+ * This method will provide an empty string for the Namespace URI, and empty string for the qualified name, and a
+ * default empty attribute list. It invokes #startElement(String, String, String, Attributes)} directly.
+ * </p>
+ *
+ * @param localName The element's local name.
+ * @exception org.xml.sax.SAXException If there is an error writing the start tag, or if a handler further down the
+ * filter chain raises an exception.
* @see #startElement(String,String,String,Attributes)
*/
public void startElement(String localName) throws SAXException {
@@ -726,10 +793,16 @@
}
/**
- * Start a new element without a qname or attributes. <p>This method will provide a default empty attribute list and an empty string for the qualified name. It invokes {@link #startElement(String,String,String,Attributes)} directly.</p>
- * @param uri The element's Namespace URI.
- * @param localName The element's local name.
- * @exception org.xml.sax.SAXException If there is an error writing the start tag, or if a handler further down the filter chain raises an exception.
+ * Start a new element without a qname or attributes.
+ * <p>
+ * This method will provide a default empty attribute list and an empty string for the qualified name. It invokes
+ * {@link #startElement(String,String,String,Attributes)} directly.
+ * </p>
+ *
+ * @param uri The element's Namespace URI.
+ * @param localName The element's local name.
+ * @exception org.xml.sax.SAXException If there is an error writing the start tag, or if a handler further down the
+ * filter chain raises an exception.
* @see #startElement(String,String,String,Attributes)
*/
public void startElement(String uri, String localName) throws SAXException {
@@ -738,11 +811,15 @@
/**
* Write a start tag. Pass the event on down the filter chain for further processing.
- * @param uri The Namespace URI, or the empty string if none is available.
- * @param localName The element's local (unprefixed) name (required).
- * @param qName The element's qualified (prefixed) name, or the empty string is none is available. This method will use the qName as a template for generating a prefix if necessary, but it is not guaranteed to use the same qName.
- * @param atts The element's attribute list (must not be null).
- * @exception org.xml.sax.SAXException If there is an error writing the start tag, or if a handler further down the filter chain raises an exception.
+ *
+ * @param uri The Namespace URI, or the empty string if none is available.
+ * @param localName The element's local (unprefixed) name (required).
+ * @param qName The element's qualified (prefixed) name, or the empty string is none is available. This method will
+ * use the qName as a template for generating a prefix if necessary, but it is not guaranteed to use the
+ * same qName.
+ * @param atts The element's attribute list (must not be null).
+ * @exception org.xml.sax.SAXException If there is an error writing the start tag, or if a handler further down the
+ * filter chain raises an exception.
* @see org.xml.sax.ContentHandler#startElement
*/
@Override
@@ -762,10 +839,13 @@
/**
* Determine the prefix for an element or attribute name. TODO: this method probably needs some cleanup.
- * @param uri The Namespace URI.
- * @param qName The qualified name (optional); this will be used to indicate the preferred prefix if none is currently bound.
- * @param isElement true if this is an element name, false if it is an attribute name (which cannot use the default Namespace).
- * @return
+ *
+ * @param uri The Namespace URI.
+ * @param qName The qualified name (optional); this will be used to indicate the preferred prefix if none is
+ * currently bound.
+ * @param isElement true if this is an element name, false if it is an attribute name (which cannot use the default
+ * Namespace).
+ * @return
*/
private String doPrefix(String uri, String qName, boolean isElement) {
String defaultNS = nsSupport.getURI("");
@@ -814,7 +894,8 @@
}
/**
- * Force all Namespaces to be declared. This method is used on the root element to ensure that the predeclared Namespaces all appear.
+ * Force all Namespaces to be declared. This method is used on the root element to ensure that the predeclared
+ * Namespaces all appear.
*/
private void forceNSDecls() {
Enumeration<String> prefixes = forcedDeclTable.keys();
@@ -825,8 +906,11 @@
}
/**
- * Internal initialization method. <p>All of the public constructors invoke this method.
- * @param writer The output destination, or null to use standard output.
+ * Internal initialization method.
+ * <p>
+ * All of the public constructors invoke this method.
+ *
+ * @param writer The output destination, or null to use standard output.
*/
private void init(Writer writer) {
setOutput(writer);
@@ -838,8 +922,10 @@
/**
* Write a raw character.
- * @param c The character to write.
- * @exception org.xml.sax.SAXException If there is an error writing the character, this method will throw an IOException wrapped in a SAXException.
+ *
+ * @param c The character to write.
+ * @exception org.xml.sax.SAXException If there is an error writing the character, this method will throw an
+ * IOException wrapped in a SAXException.
*/
private void write(char c) throws SAXException {
try {
@@ -851,8 +937,10 @@
/**
* Write a raw string.
+ *
* @param s
- * @exception org.xml.sax.SAXException If there is an error writing the string, this method will throw an IOException wrapped in a SAXException
+ * @exception org.xml.sax.SAXException If there is an error writing the string, this method will throw an
+ * IOException wrapped in a SAXException
*/
private void write(String s) throws SAXException {
try {
@@ -864,8 +952,10 @@
/**
* Write out an attribute list, escaping values. The names will have prefixes added to them.
- * @param atts The attribute list to write.
- * @throws SAXException If there is an error writing the attribute list, this method will throw an IOException wrapped in a SAXException.
+ *
+ * @param atts The attribute list to write.
+ * @throws SAXException If there is an error writing the attribute list, this method will throw an IOException
+ * wrapped in a SAXException.
*/
private void writeAttributes(Attributes atts) throws SAXException {
int len = atts.getLength();
@@ -881,11 +971,13 @@
/**
* Write an array of data characters with escaping.
- * @param ch The array of characters.
- * @param start The starting position.
- * @param length The number of characters to use.
- * @param isAttVal true if this is an attribute value literal.
- * @throws SAXException If there is an error writing the characters, this method will throw an IOException wrapped in a SAXException.
+ *
+ * @param ch The array of characters.
+ * @param start The starting position.
+ * @param length The number of characters to use.
+ * @param isAttVal true if this is an attribute value literal.
+ * @throws SAXException If there is an error writing the characters, this method will throw an IOException wrapped
+ * in a SAXException.
*/
private void writeEsc(char[] ch, int start, int length, boolean isAttVal) throws SAXException {
for (int i = start; i < start + length; i++) {
@@ -920,11 +1012,13 @@
/**
* Write an element or attribute name.
- * @param uri The Namespace URI.
- * @param localName The local name.
- * @param qName The prefixed name, if available, or the empty string.
- * @param isElement true if this is an element name, false if it is an attribute name.
- * @exception org.xml.sax.SAXException This method will throw an IOException wrapped in a SAXException if there is an error writing the name.
+ *
+ * @param uri The Namespace URI.
+ * @param localName The local name.
+ * @param qName The prefixed name, if available, or the empty string.
+ * @param isElement true if this is an element name, false if it is an attribute name.
+ * @exception org.xml.sax.SAXException This method will throw an IOException wrapped in a SAXException if there is
+ * an error writing the name.
*/
private void writeName(String uri, String localName, String qName, boolean isElement) throws SAXException {
String prefix = doPrefix(uri, qName, isElement);
@@ -937,7 +1031,9 @@
/**
* Write out the list of Namespace declarations.
- * @exception org.xml.sax.SAXException This method will throw an IOException wrapped in a SAXException if there is an error writing the Namespace declarations.
+ *
+ * @exception org.xml.sax.SAXException This method will throw an IOException wrapped in a SAXException if there is
+ * an error writing the Namespace declarations.
*/
@SuppressWarnings("unchecked")
private void writeNSDecls() throws SAXException {