org.jfree.xml.writer

Class XMLWriter

public class XMLWriter extends XMLWriterSupport

A class for writing XML to a character stream.
Constructor Summary
XMLWriter(Writer writer)
Creates a new XML writer for the specified character stream.
XMLWriter(Writer writer, String indentString)
Creates a new XML writer for the specified character stream.
Method Summary
voidclose()
Closes the underlying character stream.
voidwriteCloseTag(String tag)
Writes a closing XML tag.
voidwriteTag(String name, boolean close)
Writes an opening XML tag that has no attributes.
voidwriteTag(String name, String attributeName, String attributeValue, boolean close)
Writes an opening XML tag with an attribute/value pair.
voidwriteTag(String name, AttributeList attributes, boolean close)
Writes an opening XML tag along with a list of attribute/value pairs.
voidwriteTag(String name, Properties attributes, boolean close)
Writes an opening XML tag along with a list of attribute/value pairs.
voidwriteText(String text)
Writes some text to the character stream.
voidwriteXmlDeclaration()
Writes the XML declaration that usually appears at the top of every XML file.

Constructor Detail

XMLWriter

public XMLWriter(Writer writer)
Creates a new XML writer for the specified character stream. By default, four spaces are used for indentation.

Parameters: writer the character stream.

XMLWriter

public XMLWriter(Writer writer, String indentString)
Creates a new XML writer for the specified character stream.

Parameters: writer the character stream. indentString the string used for indentation (should contain white space, for example four spaces).

Method Detail

close

public void close()
Closes the underlying character stream.

Throws: IOException if there is a problem closing the character stream.

writeCloseTag

public void writeCloseTag(String tag)
Writes a closing XML tag.

Parameters: tag the tag name.

Throws: java.io.IOException if there is an I/O problem.

writeTag

public void writeTag(String name, boolean close)
Writes an opening XML tag that has no attributes.

Parameters: name the tag name. close a flag that controls whether or not the tag is closed immediately.

Throws: java.io.IOException if there is an I/O problem.

writeTag

public void writeTag(String name, String attributeName, String attributeValue, boolean close)
Writes an opening XML tag with an attribute/value pair.

Parameters: name the tag name. attributeName the attribute name. attributeValue the attribute value. close controls whether the tag is closed.

Throws: java.io.IOException if there is an I/O problem.

writeTag

public void writeTag(String name, AttributeList attributes, boolean close)
Writes an opening XML tag along with a list of attribute/value pairs.

Parameters: name the tag name. attributes the attributes. close controls whether the tag is closed.

Throws: java.io.IOException if there is an I/O problem.

writeTag

public void writeTag(String name, Properties attributes, boolean close)

Deprecated: use the attribute list instead ...

Writes an opening XML tag along with a list of attribute/value pairs.

Parameters: name the tag name. attributes the attributes. close controls whether the tag is closed.

Throws: java.io.IOException if there is an I/O problem.

writeText

public void writeText(String text)
Writes some text to the character stream.

Parameters: text the text.

Throws: IOException if there is a problem writing to the character stream.

writeXmlDeclaration

public void writeXmlDeclaration()
Writes the XML declaration that usually appears at the top of every XML file.

Throws: IOException if there is a problem writing to the character stream.