org.myire.quill.report

Class XmlReportWriter

java.lang.Object

org.myire.quill.report.ReportWriter

org.myire.quill.report.XmlReportWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class XmlReportWriter
extends ReportWriter

A writer of XML file reports.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XmlReportWriter.FragmentWriter<T> A writer of an XML report fragment.

Constructor Summary

Constructors

Constructor and Description
XmlReportWriter(org.gradle.api.reporting.SingleFileReport pReport, java.nio.file.OpenOption... pOpenOptions) Create a new XmlReportWriter.

Method Summary

Modifier and Type	Method and Description
void	writeAttribute(java.lang.String pName, long pValue) Write a numeric attribute of the current element.
void	writeAttribute(java.lang.String pName, java.lang.String pValue) Write an attribute of the current element.
<T> void	writeElement(java.lang.String pElementName, XmlReportWriter.FragmentWriter<T> pBodyWriter, T pBody) Write an element with a body and no attributes.
<T> void	writeElement(java.lang.String pElementName, XmlReportWriter.FragmentWriter<T> pAttributeWriter, XmlReportWriter.FragmentWriter<T> pBodyWriter, T pElement) Write an element with attributes and a body.
void	writeElementEnd(java.lang.String pElementName) Write the closing tag of an element on a separate line.
void	writeElementStart(java.lang.String pElementName) Write the opening tag of an element without attributes on a separate line.
<T> void	writeElementStart(java.lang.String pElementName, XmlReportWriter.FragmentWriter<T> pAttributeWriter, T pAttributes) Write the opening tag of an element with attributes on a separate line.
void	writeEmptyElement(java.lang.String pElementName) Write an element without attributes and body on a single line.
<T> void	writeEmptyElement(java.lang.String pElementName, XmlReportWriter.FragmentWriter<T> pAttributeWriter, T pAttributes) Write an element with attributes and no body on a single line.
void	writeEscaped(java.lang.String pValue) Write an attribute value, escaping any special XML characters such as '<'.
void	writeProlog() Write the XML prolog to the underlying stream.
<T> void	writeSequence(java.lang.String pRootElementName, java.lang.String pChildElementName, XmlReportWriter.FragmentWriter<T> pChildAttributeWriter, XmlReportWriter.FragmentWriter<T> pChildBodyWriter, java.lang.Iterable<T> pChildren) Write a sequence of elements as child elements to a sequence root element, which in its turn is a child element to the current element.

Methods inherited from class org.myire.quill.report.ReportWriter

close, decreaseIndentationLevel, flush, increaseIndentationLevel, write, write, write, writeIndentation, writeLineBreak

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlReportWriter

public XmlReportWriter(org.gradle.api.reporting.SingleFileReport pReport,
                       java.nio.file.OpenOption... pOpenOptions)
                throws java.io.IOException

Create a new XmlReportWriter.

Parameters:

pReport - The report to write.

pOpenOptions - Any options to specify when opening the report's file.

Throws:

java.io.IOException - if opening the report's destination file fails.

java.lang.NullPointerException - if any of the parameters is null.

Method Detail

writeProlog

public void writeProlog()
                 throws java.io.IOException

Write the XML prolog to the underlying stream.

Throws:

java.io.IOException - if writing to the report file fails.

writeElement

public <T> void writeElement(java.lang.String pElementName,
                             XmlReportWriter.FragmentWriter<T> pAttributeWriter,
                             XmlReportWriter.FragmentWriter<T> pBodyWriter,
                             T pElement)
                      throws java.io.IOException

Write an element with attributes and a body.

Type Parameters:

T - The type holding the element data.

Parameters:

pElementName - The name of the element.

pAttributeWriter - A writer of the element's attributes.

pBodyWriter - A writer of the element's body.

pElement - The element's data.

Throws:

java.io.IOException - if writing to the report file fails.

java.lang.NullPointerException - if pElementName or one of the writers is null.

writeElement

public <T> void writeElement(java.lang.String pElementName,
                             XmlReportWriter.FragmentWriter<T> pBodyWriter,
                             T pBody)
                      throws java.io.IOException

Write an element with a body and no attributes.

Type Parameters:

T - The type holding the body data.

Parameters:

pElementName - The name of the element.

pBodyWriter - A writer of the element's body.

pBody - The body's data.

Throws:

java.io.IOException - if writing to the report file fails.

java.lang.NullPointerException - if pElementName or pBodyWriter is null.

writeEmptyElement

public <T> void writeEmptyElement(java.lang.String pElementName,
                                  XmlReportWriter.FragmentWriter<T> pAttributeWriter,
                                  T pAttributes)
                           throws java.io.IOException

Write an element with attributes and no body on a single line.

Type Parameters:

T - The type holding the attribute data.

Parameters:

pElementName - The name of the element.

pAttributeWriter - A writer of the element's attributes.

pAttributes - The attributes' data.

Throws:

java.io.IOException - if writing to the report file fails.

java.lang.NullPointerException - if pElementName or pAttributeWriter is null.

writeEmptyElement

public void writeEmptyElement(java.lang.String pElementName)
                       throws java.io.IOException

Write an element without attributes and body on a single line.

Parameters:

pElementName - The name of the element.

Throws:

java.io.IOException - if writing to the report file fails.

java.lang.NullPointerException - if pElementName is null.

writeElementStart

public void writeElementStart(java.lang.String pElementName)
                       throws java.io.IOException

Write the opening tag of an element without attributes on a separate line.

Parameters:

pElementName - The name of the element.

Throws:

java.io.IOException - if writing to the report file fails.

java.lang.NullPointerException - if any of the parameters is null.

writeElementStart

public <T> void writeElementStart(java.lang.String pElementName,
                                  XmlReportWriter.FragmentWriter<T> pAttributeWriter,
                                  T pAttributes)
                           throws java.io.IOException

Write the opening tag of an element with attributes on a separate line.

Type Parameters:

T - The type holding the attribute data.

Parameters:

pElementName - The name of the element.

pAttributeWriter - A writer of the element's attributes.

pAttributes - The attributes' data.

Throws:

java.io.IOException - if writing to the report file fails.

java.lang.NullPointerException - if pElementName or pAttributeWriter is null.

writeElementEnd

public void writeElementEnd(java.lang.String pElementName)
                     throws java.io.IOException

Write the closing tag of an element on a separate line.

Parameters:

pElementName - The name of the element.

Throws:

java.io.IOException - if writing to the report file fails.

java.lang.NullPointerException - if pName is null.

writeSequence

public <T> void writeSequence(java.lang.String pRootElementName,
                              java.lang.String pChildElementName,
                              XmlReportWriter.FragmentWriter<T> pChildAttributeWriter,
                              XmlReportWriter.FragmentWriter<T> pChildBodyWriter,
                              java.lang.Iterable<T> pChildren)
                       throws java.io.IOException

Write a sequence of elements as child elements to a sequence root element, which in its turn is a child element to the current element.

Example:

 <sequence-root>
   <sequence-child/>
   <sequence-child/>
 </sequence-root>

Type Parameters:

T - The type containing child element data.

Parameters:

pRootElementName - The name of the sequence root element.

pChildElementName - The name of the sequence child elements.

pChildAttributeWriter - A writer of the attributes of each child element.

pChildBodyWriter - A writer of the body of each child element.

pChildren - The instances with the values for the child elements.

Throws:

java.io.IOException - if writing to the report file fails.

java.lang.NullPointerException - if any of the reference parameters is null.

writeAttribute

public void writeAttribute(java.lang.String pName,
                           java.lang.String pValue)
                    throws java.io.IOException

Write an attribute of the current element.

Parameters:

pName - The attribute's name.

pValue - The attribute's value.

Throws:

java.io.IOException - if writing to the report file fails.

java.lang.NullPointerException - if any of the parameters is null.

writeAttribute

public void writeAttribute(java.lang.String pName,
                           long pValue)
                    throws java.io.IOException

Write a numeric attribute of the current element.

Parameters:

pName - The attribute's name.

pValue - The attribute's value.

Throws:

java.io.IOException - if writing to the report file fails.

java.lang.NullPointerException - if pName is null.

writeEscaped

public void writeEscaped(java.lang.String pValue)
                  throws java.io.IOException

Write an attribute value, escaping any special XML characters such as '<'.

Parameters:

pValue - The attribute value.

Throws:

java.io.IOException - if writing to the report file fails.

java.lang.NullPointerException - if pValue is null.