org.myire.quill.report

Interface TransformingReport

All Superinterfaces:

org.gradle.util.Configurable<org.gradle.api.reporting.Report>, org.gradle.api.reporting.ConfigurableReport, org.gradle.api.reporting.Report, org.gradle.api.reporting.SingleFileReport

All Known Implementing Classes:

FileTransformingReport, FormatChoiceReportTransformingReport, ReportTransformingReport

public interface TransformingReport
extends org.gradle.api.reporting.SingleFileReport

A single file report that is created by applying an XSL transformation to some XML input. The result of the transformation will be written to the report's destination.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.reporting.Report

org.gradle.api.reporting.Report.OutputType

Field Summary

Fields inherited from interface org.gradle.api.reporting.Report

NAMER

Method Summary

Modifier and Type	Method and Description
static <T> T	applyProjectRootXslParameter(org.gradle.api.Project pProject, java.util.function.BiFunction<java.lang.String,java.lang.Object,T> pFunction) Pass the XSL parameter for the project root directory path to a function.
boolean	checkUpToDate() Check if the report is up to date with respect to its XML input.
java.io.File	getXslFile() Get the XSL file that will be used to transform the XML input.
void	setXslFile(java.lang.Object pFile) Set the file containing the style sheet to use when transforming the XML input.
void	transform() Transform the report's XML input using the XSL style sheet specified for this report and write the result to this report's destination.

Methods inherited from interface org.gradle.api.reporting.SingleFileReport

getOutputLocation, getOutputType

Methods inherited from interface org.gradle.api.reporting.ConfigurableReport

setDestination, setDestination, setEnabled, setEnabled

Methods inherited from interface org.gradle.api.reporting.Report

getDestination, getDisplayName, getName, getRequired, isEnabled

Methods inherited from interface org.gradle.util.Configurable

configure

Method Detail

getXslFile

@InputFile
 @Optional
java.io.File getXslFile()

Get the XSL file that will be used to transform the XML input.

Returns:

The XSL file. If this file is null the implementation may use a default style sheet to perform the transformation.

setXslFile

void setXslFile(java.lang.Object pFile)

Set the file containing the style sheet to use when transforming the XML input.

Parameters:

pFile - The file specification, will be resolved using Project.file().

checkUpToDate

boolean checkUpToDate()

Check if the report is up to date with respect to its XML input.

Returns:

True if this report is up to date, false if not.

transform

void transform()

Transform the report's XML input using the XSL style sheet specified for this report and write the result to this report's destination.

applyProjectRootXslParameter

static <T> T applyProjectRootXslParameter(org.gradle.api.Project pProject,
                                          java.util.function.BiFunction<java.lang.String,java.lang.Object,T> pFunction)

Pass the XSL parameter for the project root directory path to a function.

Type Parameters:

T - The return type of the function.

Parameters:

pProject - The project to get the root directory path from.

pFunction - The function to pass the XSL parameter name and root directory path to.

Returns:

The result of the function.