API Documentation: | Reporting |
---|
Known Subtypes: |
|
---|
An object that provides reporting options.
Tasks that produce reports as part of their execution expose configuration options of those reports via these methods.TheReporting
interface is parameterized, where the parameter denotes the specific type of reporting containerthat is exposed. The specific type of the reporting container denotes the different types of reports available.
For example, given a task such as:
class MyTaskimplements Reporting<MyReportContainer> {// implementation}interface MyReportContainerextends ReportContainer<Report> { Report getHtml(); Report getCsv();}
The reporting aspects of such a task can be configured as such:
task my(type: MyTask) { reports { html.enabled = true csv.enabled = false }}
See the documentation for the specificReportContainer
type for the task for information on report types and options.
Property | Description |
reports | A |
Method | Description |
reports(configureAction) | Allow configuration of the report container by closure. |
Block | Description |
reports | Allow configuration of the report container by closure. |
AReportContainer
instance.
Implementers specify a specific implementation ofReportContainer
that describes the types of reports thatare available.
T
reports
(Action
<? superT
>
configureAction)
Action
<? superT
>Allow configuration of the report container by closure.
reports { html { enabled false } xml.destination"build/reports/myReport.xml"}
Allow configuration of the report container by closure.
reports { html { enabled false } xml.destination"build/reports/myReport.xml"}
- Delegates to:
T
fromreports