Class XmlWriter

java.lang.Object

org.apache.rat.report.xml.writer.XmlWriter

All Implemented Interfaces:

AutoCloseable

public final class XmlWriter
extends Object
implements AutoCloseable

Requires a wrapper to be used safely in a multithreaded environment.

Not intended to be subclassed. Please copy and hack!

Constructor Summary

Constructors

Constructor	Description
XmlWriter(Appendable writer)	Constructs an XmlWriter with the specified writer for output.

Method Summary

Modifier and Type	Method	Description
XmlWriter	append(Document document)
XmlWriter	attribute(CharSequence name, CharSequence value)	Writes an attribute of an element.
XmlWriter	cdata(CharSequence content)	Writes CDATA content.
void	close()
XmlWriter	closeDocument()	Closes all pending elements.
XmlWriter	closeElement()	Closes the last element written.
XmlWriter	closeElement(CharSequence name)	Closes back to and including the last instance of the specified element name.
XmlWriter	comment(CharSequence text)	Writes a comment.
XmlWriter	content(CharSequence content)	Writes content.
XmlWriter	startDocument()	Starts a document by writing a prolog.
XmlWriter	startElement(CharSequence elementName)	Writes the start of an element.

Methods inherited from class Object

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

Constructor Details

XmlWriter

public XmlWriter(Appendable writer)

Constructs an XmlWriter with the specified writer for output.

Parameters:

writer - the writer to write to.

Method Details

startDocument

public XmlWriter startDocument()
                        throws IOException

Starts a document by writing a prolog. Calling this method is optional. When writing a document fragment, it should not be called.

Returns:

this object

Throws:

OperationNotAllowedException - if called after the first element has been written or once a prolog has already been written

IOException

startElement

public XmlWriter startElement(CharSequence elementName)
                       throws IOException

Writes the start of an element.

Parameters:

elementName - the name of the element, not null

Returns:

this object

Throws:

InvalidXmlException - if the name is not valid for an xml element

OperationNotAllowedException - if called after the first element has been closed

IOException

comment

public XmlWriter comment(CharSequence text)
                  throws IOException

Writes a comment.

Parameters:

text - the comment text

Returns:

this object

Throws:

OperationNotAllowedException - if called after the first element has been closed

IOException

attribute

public XmlWriter attribute(CharSequence name,
 CharSequence value)
                    throws IOException

Writes an attribute of an element. Note that this is only allowed directly after startElement(CharSequence) or a previous attribute call.

Parameters:

name - the attribute name, not null

value - the attribute value, not null

Returns:

this object

Throws:

InvalidXmlException - if the name is not valid for an xml attribute or if a value for the attribute has already been written

OperationNotAllowedException - if called after content(CharSequence) or closeElement() or before any call to startElement(CharSequence)

IOException

content

public XmlWriter content(CharSequence content)
                  throws IOException

Writes content. Note that this method does not support CDATA. This method automatically escapes characters.

Parameters:

content - the content to write

Returns:

this object

Throws:

OperationNotAllowedException - if called before any call to startElement(CharSequence) or after the first element has been closed

IOException

cdata

public XmlWriter cdata(CharSequence content)
                throws IOException

Writes CDATA content. This method DOES NOT automatically escape characters. It will remove enclosed CDATA closing strings (e.g. ]]>)

Parameters:

content - the content to write

Returns:

this object

Throws:

OperationNotAllowedException - if called before any call to startElement(CharSequence) or after the first element has been closed

IOException

closeElement

public XmlWriter closeElement()
                       throws IOException

Closes the last element written.

Returns:

this object

Throws:

OperationNotAllowedException - if called before any call to startElement(CharSequence) or after the first element has been closed

IOException

closeElement

public XmlWriter closeElement(CharSequence name)
                       throws IOException

Closes back to and including the last instance of the specified element name.

Parameters:

name - The name of the element to close. Must not be null.

Returns:

this object

Throws:

OperationNotAllowedException - if called before any call to startElement(CharSequence) or after the first element has been closed

IOException

closeDocument

public XmlWriter closeDocument()
                        throws IOException

Closes all pending elements. When appropriate, resources are also flushed and closed. No exception is raised when called upon a document whose root element has already been closed.

Returns:

this object

Throws:

OperationNotAllowedException - if called before any call to startElement(CharSequence)

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException

append

public XmlWriter append(Document document)
                 throws IOException

Throws:

IOException