XmlWriter
interface, which writes a
- * WebRowSet
object to an output stream as an XML document.
+ * An implementation of the {@code XmlWriter} interface, which writes a
+ * {@code WebRowSet} object to an output stream as an XML document.
*/
public class WebRowSetXmlWriter implements XmlWriter, Serializable {
/**
- * The java.io.Writer
object to which this WebRowSetXmlWriter
- * object will write when its writeXML
method is called. The value
- * for this field is set with the java.io.Writer
object given
- * as the second argument to the writeXML
method.
+ * The {@code java.io.Writer} object to which this {@code WebRowSetXmlWriter}
+ * object will write when its {@code writeXML} method is called. The value
+ * for this field is set with the {@code java.io.Writer} object given
+ * as the second argument to the {@code writeXML} method.
*/
private transient java.io.Writer writer;
/**
- * The java.util.Stack
object that this WebRowSetXmlWriter
+ * The {@code java.util.Stack} object that this {@code WebRowSetXmlWriter}
* object will use for storing the tags to be used for writing the calling
- * WebRowSet
object as an XML document.
+ * {@code WebRowSet} object as an XML document.
*/
private java.util.StackWebRowSet
object as an XML document
- * using the given java.io.Writer
object. The XML document
- * will include the WebRowSet
object's data, metadata, and
+ * Writes the given {@code WebRowSet} object as an XML document
+ * using the given {@code java.io.Writer} object. The XML document
+ * will include the {@code WebRowSet} object's data, metadata, and
* properties. If a data value has been updated, that information is also
* included.
*
- * This method is called by the XmlWriter
object that is
- * referenced in the calling WebRowSet
object's
- * xmlWriter
field. The XmlWriter.writeXML
+ * This method is called by the {@code XmlWriter} object that is
+ * referenced in the calling {@code WebRowSet} object's
+ * {@code xmlWriter} field. The {@code XmlWriter.writeXML}
* method passes to this method the arguments that were supplied to it.
*
- * @param caller the WebRowSet
object to be written; must
- * be a rowset for which this WebRowSetXmlWriter
object
+ * @param caller the {@code WebRowSet} object to be written; must
+ * be a rowset for which this {@code WebRowSetXmlWriter} object
* is the writer
- * @param wrt the java.io.Writer
object to which
- * caller
will be written
+ * @param wrt the {@code java.io.Writer} object to which
+ * {@code caller} will be written
* @exception SQLException if a database access error occurs or
- * this WebRowSetXmlWriter
object is not the writer
+ * this {@code WebRowSetXmlWriter} object is not the writer
* for the given rowset
* @see XmlWriter#writeXML
*/
@@ -100,26 +100,26 @@
}
/**
- * Writes the given WebRowSet
object as an XML document
- * using the given java.io.OutputStream
object. The XML document
- * will include the WebRowSet
object's data, metadata, and
+ * Writes the given {@code WebRowSet} object as an XML document
+ * using the given {@code java.io.OutputStream} object. The XML document
+ * will include the {@code WebRowSet} object's data, metadata, and
* properties. If a data value has been updated, that information is also
* included.
*
- * Using stream is a faster way than using java.io.Writer
+ * Using stream is a faster way than using {@code java.io.Writer}
*
- * This method is called by the
XmlWriter
object that is
- * referenced in the calling WebRowSet
object's
- * xmlWriter
field. The XmlWriter.writeXML
+ * This method is called by the {@code XmlWriter} object that is
+ * referenced in the calling {@code WebRowSet} object's
+ * {@code xmlWriter} field. The {@code XmlWriter.writeXML}
* method passes to this method the arguments that were supplied to it.
*
- * @param caller the WebRowSet
object to be written; must
- * be a rowset for which this WebRowSetXmlWriter
object
+ * @param caller the {@code WebRowSet} object to be written; must
+ * be a rowset for which this {@code WebRowSetXmlWriter} object
* is the writer
- * @param oStream the java.io.OutputStream
object to which
- * caller
will be written
+ * @param oStream the {@code java.io.OutputStream} object to which
+ * {@code caller} will be written
* @throws SQLException if a database access error occurs or
- * this WebRowSetXmlWriter
object is not the writer
+ * this {@code WebRowSetXmlWriter} object is not the writer
* for the given rowset
* @see XmlWriter#writeXML
*/