Configurable<Report>
ConfigurableReport
, CustomizableHtmlReport
, DirectoryReport
, JUnitXmlReport
, SingleFileReport
public interface Report extends Configurable<Report>
Tasks that produce reports expose instances of this type for configuration via the Reporting
interface.
Modifier and Type | Interface | Description |
---|---|---|
static class |
Report.OutputType |
The type of output the report produces
|
Modifier and Type | Method | Description |
---|---|---|
java.lang.String |
getDisplayName() |
A more descriptive name of this report.
|
java.lang.String |
getName() |
The symbolic name of this report.
|
Property<? extends FileSystemLocation> |
getOutputLocation() |
The location on the filesystem to generate the report to.
|
Report.OutputType |
getOutputType() |
The type of output that the report generates.
|
Property<java.lang.Boolean> |
getRequired() |
A flag that determines whether this report should be generated or not.
|
configure
@Input java.lang.String getName()
The name of the report usually indicates the format (e.g. XML, HTML etc.) but can be anything.
When part of a ReportContainer
, reports are accessed via their name. That is, given a report container variable
named reports
containing a report who's getName()
returns "html"
, the report could be accessed
via:
reports.html
@Input java.lang.String getDisplayName()
@Input Property<java.lang.Boolean> getRequired()
@Internal("Implementations need to add the correct annotation, @OutputDirectory or @OutputFile") Property<? extends FileSystemLocation> getOutputLocation()
@Input Report.OutputType getOutputType()