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

Interface IXmlWriter

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

XmlWriter

public interface IXmlWriter
extends AutoCloseable

Simple interface for creating basic XML documents. Performs basic validation and escaping. Not namespace aware.

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.
IXmlWriter	closeDocument()	Closes all pending elements.
IXmlWriter	closeElement()	Closes the last element written.
IXmlWriter	closeElement(CharSequence name)	Closes all open elements back to and including the named element.
IXmlWriter	comment(CharSequence text)	Writes a comment
IXmlWriter	content(CharSequence content)	Writes content.
IXmlWriter	openElement(CharSequence elementName)	Writes the start of an element.
default IXmlWriter	openElement(XmlElements.Elements element)	Writes the start of an element.
IXmlWriter	startDocument()	Starts a document by writing a prolog.

Methods inherited from interface java.lang.AutoCloseable

close

Method Details

startDocument

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.

Returns:

this object

Throws:

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

IOException

openElement

IXmlWriter openElement(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 a xml element

OperationNotAllowedException - if called after the first element has been closed

IOException

openElement

default IXmlWriter openElement(XmlElements.Elements element)
                        throws IOException

Writes the start of an element.

Parameters:

element - 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

IXmlWriter 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

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 attribute(java.lang.CharSequence, java.lang.CharSequence).

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 a 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

IXmlWriter 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 openElement(java.lang.CharSequence) or after the first element has been closed

IOException

cdata

IXmlWriter 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 openElement(java.lang.CharSequence) or after the first element has been closed

IOException

closeElement

IXmlWriter closeElement()
                 throws IOException

Closes the last element written.

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

IXmlWriter closeElement(CharSequence name)
                 throws IOException

Closes all open elements back to and including the named element.

Parameters:

name - the last element to close

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

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.

Returns:

this object

Throws:

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

IOException