org.gradle.util.Configurable<Report>
, Serializable
ConfigurableReport
, CustomizableHtmlReport
, DirectoryReport
, FindBugsXmlReport
, JUnitXmlReport
, SingleFileReport
public interface Report extends Serializable, org.gradle.util.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 |
---|---|---|
File |
getDestination() |
The location on the filesystem of the report when it is generated.
|
String |
getDisplayName() |
A more descriptive name of this report.
|
String |
getName() |
The symbolic name of this report.
|
Report.OutputType |
getOutputType() |
The type of output that the report generates.
|
boolean |
isEnabled() |
Whether or not this report should be generated by whatever generates it.
|
void |
setEnabled(boolean enabled) |
Whether or not this report should be generated by whatever generates it.
|
@Input 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 String getDisplayName()
@Input boolean isEnabled()
If true
, the generator of this report will generate it at the appropriate time.
If false
, the generator of this report will not generate this report.
void setEnabled(boolean enabled)
enabled
- Whether or not this report should be generated by whatever generates it.isEnabled()
@Internal("Implementations need to add the correct annotation, @OutputDirectory or @OutputFile") File getDestination()
Depending on the output type
of the report, this may point to
a file or a directory.
Subtypes may implement setters for the destination.
@Input Report.OutputType getOutputType()