Package org.apache.rat.report.xml.writer

Class XmlWriter

java.lang.Object

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

All Implemented Interfaces:

AutoCloseable, IXmlWriter

public final class XmlWriter
extends Object
implements IXmlWriter

Lightweight IXmlWriter implementation.

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(Writer writer)	Constructs an XmlWriter with the specified writer for output.

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.rat.report.xml.writer.IXmlWriter

openElement

Constructor Details

XmlWriter

public XmlWriter(Writer writer)

Constructs an XmlWriter with the specified writer for output.

Parameters:

writer - the writer to write to.

Method Details

startDocument

public IXmlWriter 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.

Specified by:

startDocument in interface IXmlWriter

Returns:

this object

Throws:

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

IOException

openElement

public IXmlWriter openElement(CharSequence elementName)
                       throws IOException

Writes the start of an element.

Specified by:

openElement in interface IXmlWriter

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 IXmlWriter comment(CharSequence text)
                   throws IOException

Description copied from interface: IXmlWriter

Writes a comment

Specified by:

comment in interface IXmlWriter

Parameters:

text - the comment text

Returns:

this object

Throws:

IOException

attribute

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

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

Specified by:

attribute in interface IXmlWriter

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 openElement(CharSequence)

IOException

content

public IXmlWriter content(CharSequence content)
                   throws IOException

Description copied from interface: IXmlWriter

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

Specified by:

content in interface IXmlWriter

Parameters:

content - the content to write

Returns:

this object

Throws:

IOException

cdata

public IXmlWriter cdata(CharSequence content)
                 throws IOException

Description copied from interface: IXmlWriter

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

Specified by:

cdata in interface IXmlWriter

Parameters:

content - the content to write

Returns:

this object

Throws:

IOException

closeElement

public IXmlWriter closeElement()
                        throws IOException

Closes the last element written.

Specified by:

closeElement in interface IXmlWriter

Returns:

this object

Throws:

OperationNotAllowedException - if called before any call to openElement(java.lang.CharSequence) or after the first element has been closed

IOException

closeElement

public IXmlWriter closeElement(CharSequence name)
                        throws IOException

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

Specified by:

closeElement in interface IXmlWriter

Parameters:

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

Returns:

this object

Throws:

OperationNotAllowedException - if called before any call to openElement(java.lang.CharSequence) or after the first element has been closed

IOException

closeDocument

public IXmlWriter 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.

Specified by:

closeDocument in interface IXmlWriter

Returns:

this object

Throws:

OperationNotAllowedException - if called before any call to openElement(java.lang.CharSequence)

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException