Package com.topologi.diffx.xml

Class XMLWriterImpl

java.lang.Object

com.topologi.diffx.xml.XMLWriterBase

com.topologi.diffx.xml.XMLWriterImpl

All Implemented Interfaces:

XMLWriter

public final class XMLWriterImpl
extends XMLWriterBase
implements XMLWriter

A simple writer for XML data that does not support namespaces.

Provides methods to generate well-formed XML data easily, wrapping a writer.

This version only supports utf-8 encoding, if writing to a file make sure that the encoding of the file output stream is "utf-8".

The recommended implementation is to use a BufferedWriter to write.

  Writer writer =
     new BufferedWriter(new OutputStreamWriter(new FileOutputStream("foo.out"),"utf-8"));
 

This class is not synchronised and does not support namespaces, and will therefore throw an unsupported operation exception for each call to a method that uses namespaces.

Version:

6 December 2008

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	XMLWriterImpl.Element	A light object to keep track of the element.

Field Summary

Fields

Modifier and Type	Field	Description
private final List<XMLWriterImpl.Element>	elements	A stack of elements to close the elements automatically.
private static final XMLWriterImpl.Element	ROOT	The root node.

Fields inherited from class com.topologi.diffx.xml.XMLWriterBase

depth, encoding, indent, isNude, writer, writerEscape

Constructor Summary

Constructors

Constructor	Description
XMLWriterImpl(Writer writer)	Creates a new XML writer.
XMLWriterImpl(Writer writer, boolean indent)	Create a new XML writer.

Method Summary

Modifier and Type	Method	Description
void	attribute(String uri, String name, int value)	Not supported.
void	attribute(String uri, String name, String value)	Not supported.
void	close()	Close the writer.
void	closeElement()	Write the end element tag.
(package private) void	deNude()	Writes the angle bracket if the element open tag is not finished.
void	emptyElement(String element)	Same as emptyElement(null, element);.
void	emptyElement(String uri, String element)	Not supported.
void	openElement(String name)	Writes a start element tag correctly indented.
void	openElement(String name, boolean hasChildren)	Writes a start element tag correctly indented.
void	openElement(String uri, String name)	Not supported.
void	openElement(String uri, String name, boolean hasChildren)	Not supported.
private XMLWriterImpl.Element	peekElement()	Returns the last element in the list.
private XMLWriterImpl.Element	popElement()	Removes the last element in the list.
void	setPrefixMapping(String uri, String prefix)	Not supported.

Methods inherited from class com.topologi.diffx.xml.XMLWriterBase

attribute, attribute, doNothing, element, flush, indent, setEncoding, setIndentChars, writeCDATA, writeComment, writePI, writeText, writeText, writeText, writeText, writeXML, writeXML, xmlDecl

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.topologi.diffx.xml.XMLWriter

attribute, attribute, element, flush, setIndentChars, writeCDATA, writeComment, writePI, writeText, writeText, writeText, writeXML, writeXML, xmlDecl

Field Details

ROOT

private static final XMLWriterImpl.Element ROOT

The root node.

elements

private final List<XMLWriterImpl.Element> elements

A stack of elements to close the elements automatically.

Constructor Details

XMLWriterImpl

public XMLWriterImpl(Writer writer)
              throws NullPointerException

Creates a new XML writer.

Sets the depth attribute to 0 and the indentation to true.

Parameters:

writer - Where this writer should write the XML data.

Throws:

NullPointerException - If the writer is null.

XMLWriterImpl

public XMLWriterImpl(Writer writer,
 boolean indent)
              throws NullPointerException

Create a new XML writer.

Parameters:

writer - Where this writer should write the XML data.

indent - Set the indentation flag.

Throws:

NullPointerException - If the writer is null.

Method Details

deNude

void deNude()
     throws IOException

Writes the angle bracket if the element open tag is not finished.

Specified by:

deNude in class XMLWriterBase

Throws:

IOException - If thrown by the wrapped writer.

openElement

public void openElement(String name)
                 throws IOException

Writes a start element tag correctly indented.

It is the same as openElement(null, name, false)

Specified by:

openElement in interface XMLWriter

Parameters:

name - The name of the element

Throws:

IOException - If thrown by the wrapped writer.

See Also:

• openElement(java.lang.String, java.lang.String, boolean)

openElement

public void openElement(String name,
 boolean hasChildren)
                 throws IOException

Writes a start element tag correctly indented.

Use the hasChildren parameter to specify whether this element is terminal node or not, which affects the indenting.

The name can contain attributes and should be a valid xml name.

Specified by:

openElement in interface XMLWriter

Parameters:

name - The name of the element.

hasChildren - true if this element has children.

Throws:

IOException - If thrown by the wrapped writer.

closeElement

public void closeElement()
                  throws IOException,
IllegalCloseElementException

Write the end element tag.

Specified by:

closeElement in interface XMLWriter

Throws:

IOException - If thrown by the wrapped writer.

IllegalCloseElementException - If there is no element to close

emptyElement

public void emptyElement(String element)
                  throws IOException

Same as emptyElement(null, element);.

It is possible for the element to contain attributes, however, since there is no character escaping, great care must be taken not to introduce invalid characters. For example:

    <example test="yes"/>
 

Specified by:

emptyElement in interface XMLWriter

Parameters:

element - the name of the element

Throws:

IOException - If thrown by the wrapped writer.

peekElement

private XMLWriterImpl.Element peekElement()

Returns the last element in the list.

Returns:

The current element.

popElement

private XMLWriterImpl.Element popElement()

Removes the last element in the list.

Returns:

The current element.

openElement

public void openElement(String uri,
 String name)
                 throws UnsupportedOperationException

Not supported.

Parameters:

uri - This parameter is ignored.

name - This parameter is ignored.

Throws:

UnsupportedOperationException - This class does not handle namespaces.

openElement

public void openElement(String uri,
 String name,
 boolean hasChildren)
                 throws UnsupportedOperationException

Not supported.

Specified by:

openElement in interface XMLWriter

Parameters:

uri - This parameter is ignored.

name - This parameter is ignored.

hasChildren - This parameter is ignored.

Throws:

UnsupportedOperationException - This class does not handle namespaces.

emptyElement

public void emptyElement(String uri,
 String element)
                  throws UnsupportedOperationException

Not supported.

Specified by:

emptyElement in interface XMLWriter

Parameters:

uri - This parameter is ignored.

element - This parameter is ignored.

Throws:

UnsupportedOperationException - This class does not handle namespaces.

setPrefixMapping

public void setPrefixMapping(String uri,
 String prefix)
                      throws UnsupportedOperationException

Not supported.

Specified by:

setPrefixMapping in interface XMLWriter

Parameters:

uri - This parameter is ignored.

prefix - This parameter is ignored.

Throws:

UnsupportedOperationException - This class does not handle namespaces.

attribute

public void attribute(String uri,
 String name,
 String value)
               throws UnsupportedOperationException

Not supported.

Specified by:

attribute in interface XMLWriter

Parameters:

uri - This parameter is ignored.

name - The name of the attribute.

value - The value of the attribute.

Throws:

UnsupportedOperationException - This class does not handle namespaces.

attribute

public void attribute(String uri,
 String name,
 int value)
               throws UnsupportedOperationException

Not supported.

Specified by:

attribute in interface XMLWriter

Parameters:

uri - This parameter is ignored.

name - The name of the attribute.

value - The value of the attribute.

Throws:

UnsupportedOperationException - This class does not handle namespaces.

close

public void close()
           throws IOException,
UnclosedElementException

Close the writer.

Specified by:

close in interface XMLWriter

Throws:

IOException - If thrown by the wrapped writer.

UnclosedElementException - If an element has been left open.