net.shredzone.jshred.io

Class XMLWriter

java.lang.Object

java.io.Writer

java.io.BufferedWriter

net.shredzone.jshred.io.XMLWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class XMLWriter
extends BufferedWriter

A very simple writer for cleanly formatted XML output.

This writer will do for creating simple XML files, but please note that it is not perfect at all. It does not support namespace, DTDs and it is unable to read DOM structures as in the org.w3c.dom package. And last but not least it does not validate your XML against a DTD.

What it does is indention of the text, proper escaping of XML special chars and correct charset encoding.

Author:

Richard "Shred" Körber

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
XMLWriter(OutputStream out) Creates a new XMLWriter basing on an OutputStream.
XMLWriter(Writer out) Creates a new XMLWriter basing on a Writer.

Method Summary

Modifier and Type	Method and Description
void	endDocument() Finishes an XML document.
void	endElement() Closes the most recent XML element.
static String	escape(String text) Escapes a String so it can be used in XML context.
protected void	flushTag() Flushes the tag buffer, which is used to write empty containers in their short form.
void	setEncoding(String encoding) Sets the encoding used by this writer.
void	setIndent(String indent) Sets the indention string.
void	startDocument() Starts an XML document.
void	startElement(String element) Starts a new XML element.
void	startElement(String element, Attributes attr) Starts a new XML element with attributes.
void	startElement(String element, Map<String,String> attrs) Starts a new XML element with attributes.
void	startElement(String element, String... attr) Starts a new XML element with attributes.
void	writeComment(String comment) Writes a comment.
void	writeContent(String content) Writes the content of an XML container.
protected void	writeIndent() Indents by one level

Methods inherited from class java.io.BufferedWriter

close, flush, newLine, write, write, write

Methods inherited from class java.io.Writer

append, append, append, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLWriter

public XMLWriter(Writer out)

Creates a new XMLWriter basing on a Writer.

Parameters:

out - Writer to send the XML data to

XMLWriter

public XMLWriter(OutputStream out)
          throws UnsupportedEncodingException

Creates a new XMLWriter basing on an OutputStream. The OutputStream will receive UTF-8 encoded data.

Parameters:

out - OutputStream to send the XML data to

Throws:

UnsupportedEncodingException - if this VM does not support UTF-8, which should never happen...

Method Detail

setIndent

public void setIndent(String indent)

Sets the indention string. This string is used to indent lines according to their nesting. Defaults to two spaces, but you can also set several spaces, tabs or an empty string.

If you want to change the indention string, you must do so before invoking startDocument().

Parameters:

indent - New Indention String

setEncoding

public void setEncoding(String encoding)

Sets the encoding used by this writer. The XMLWriter tries to find out the proper encoding itself. If an @{link OutputStream} is used, encoding will always be UTF-8. If an @{link OutputStreamWriter} was passed in, its current encoding will be used. In any other case UTF-8 is assumed for encoding, which can be changed by using this method.

If you want to change the encoding string, you must do so before invoking startDocument().

Parameters:

encoding - New encoding

writeIndent

protected void writeIndent()
                    throws IOException

Indents by one level

Throws:

IOException

startDocument

public void startDocument()
                   throws IOException

Starts an XML document. The XML header will be written.

Throws:

IOException

endDocument

public void endDocument()
                 throws IOException

Finishes an XML document.

Throws:

IOException

startElement

public void startElement(String element)
                  throws IOException

Starts a new XML element. There are no attributes added to this element.

Parameters:

element - Element name

Throws:

IOException

startElement

public void startElement(String element,
                         String... attr)
                  throws IOException

Starts a new XML element with attributes. This method will take proper care for excaping all chars within the attribute values.

Parameters:

element - Element name

attr - Attribute name/value pairs

Throws:

IOException

Since:

R6

startElement

public void startElement(String element,
                         Map<String,String> attrs)
                  throws IOException

Starts a new XML element with attributes. This method will take proper care for excaping all chars within the attribute values.

Note that since R15, the map is required to have String keys and values.

Parameters:

element - Element name

attrs - Map with attributes and corresponding values

Throws:

IOException

Since:

R6

startElement

public void startElement(String element,
                         Attributes attr)
                  throws IOException

Starts a new XML element with attributes. This method will take proper care for excaping all chars within the attribute values.

Parameters:

element - Element name

attr - Attributes

Throws:

IOException

endElement

public void endElement()
                throws IOException

Closes the most recent XML element. The XMLWriter recognizes empty elements and will send a shortcut to the output.

Throws:

IOException

writeContent

public void writeContent(String content)
                  throws IOException

Writes the content of an XML container. Leading and trailing spaces will be trimmed. Empty contents will be ignored. You can invoke this method several times for a container. Each content will then be written into a separate line. Special chars will automatically be escaped.

Parameters:

content - Content of the current XML container

Throws:

IOException

writeComment

public void writeComment(String comment)
                  throws IOException

Writes a comment. Content will be escaped properly.

Parameters:

comment - The comment's content.

Throws:

IOException

escape

public static String escape(String text)

Escapes a String so it can be used in XML context. All &, <, > and " will be converted into their respective entity.

Parameters:

text - Text to be escaped

Returns:

Escapted text

flushTag

protected void flushTag()
                 throws IOException

Flushes the tag buffer, which is used to write empty containers in their short form.

Throws:

IOException