org.myire.quill.report

Class AbstractXmlHtmlReportSet<T extends XmlHtmlReportSet<T>>

java.lang.Object

org.myire.quill.report.AbstractXmlHtmlReportSet<T>

All Implemented Interfaces:

org.gradle.util.Configurable<T>, ReportSet, XmlHtmlReportSet<T>

Direct Known Subclasses:

JolReportsImpl

public abstract class AbstractXmlHtmlReportSet<T extends XmlHtmlReportSet<T>>
extends java.lang.Object
implements XmlHtmlReportSet<T>

Base class for implementations of XmlHtmlReportSet.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractXmlHtmlReportSet(org.gradle.api.Task pTask, java.lang.String pReportSetName, java.lang.String pXslResourcePath) Create a new AbstractXmlHtmlReports.

Method Summary

Modifier and Type	Method and Description
T	configure(groovy.lang.Closure pClosure)
TransformingReport	getHtml() Get the HTML report.
org.gradle.api.reporting.Report	getReportByName(java.lang.String pReportName) Get a report by its name.
org.gradle.api.reporting.SingleFileReport	getXml() Get the XML report.
protected abstract T	self() Return this instance with the correct type.
void	setInputsAndOutputs(org.gradle.api.Task pTask) Add the enabled flags of the reports to a task's input properties and the destination files of teh reports to the task's output files.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractXmlHtmlReportSet

protected AbstractXmlHtmlReportSet(org.gradle.api.Task pTask,
                                   java.lang.String pReportSetName,
                                   java.lang.String pXslResourcePath)

Create a new AbstractXmlHtmlReports.

Parameters:

pTask - The task that owns this report set.

pReportSetName - The name of the report set, used for report names and file base names.

pXslResourcePath - The path to the built-in XSL resource to use by default when transforming the XML report to the HTML report.

Throws:

java.lang.NullPointerException - if pTask or pReportSetName is null.

Method Detail

getXml

public org.gradle.api.reporting.SingleFileReport getXml()

Get the XML report. Default is a file called "<report-set-name>.xml" located in a directory called "<report-set-name>" in the project's report directory or, if no project report directory is defined, in a subdirectory called "<report-set-name>" in the project's build directory.

Specified by:

getXml in interface XmlHtmlReportSet<T extends XmlHtmlReportSet<T>>

Returns:

The XML report, never null.

getHtml

public TransformingReport getHtml()

Get the HTML report. Default is a transforming report located next to the XML report.

Specified by:

getHtml in interface XmlHtmlReportSet<T extends XmlHtmlReportSet<T>>

Returns:

The HTML report, never null.

getReportByName

public org.gradle.api.reporting.Report getReportByName(java.lang.String pReportName)

Description copied from interface: ReportSet

Get a report by its name.

Specified by:

getReportByName in interface ReportSet

Parameters:

pReportName - The report's name.

Returns:

The report with the specified name, or null if the set contains no report with that name.

configure

public T configure(groovy.lang.Closure pClosure)

Specified by:

configure in interface org.gradle.util.Configurable<T extends XmlHtmlReportSet<T>>

setInputsAndOutputs

public void setInputsAndOutputs(org.gradle.api.Task pTask)

Add the enabled flags of the reports to a task's input properties and the destination files of teh reports to the task's output files.

Parameters:

pTask - The task.

Throws:

java.lang.NullPointerException - if pTask is null.

self

protected abstract T self()

Return this instance with the correct type.

Returns:

This instance.