Configurable<Report>ConfigurableReport, CustomizableHtmlReport, DirectoryReport, JUnitXmlReport, SingleFileReportpublic 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.io.File |
getDestination() |
Deprecated.
Use
getOutputLocation() instead. |
java.lang.String |
getDisplayName() |
A more descriptive name of this report.
|
java.lang.String |
getName() |
The symbolic name of this report.
|
Provider<? 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.
|
boolean |
isEnabled() |
Deprecated.
Use
getRequired() instead. |
void |
setEnabled(boolean enabled) |
Deprecated.
Use
getRequired().set() instead. |
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()
@Deprecated @ReplacedBy("required") boolean isEnabled()
getRequired() instead. This method will be removed in Gradle 8.0.
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.
@Deprecated void setEnabled(boolean enabled)
getRequired().set() instead. This method will be removed in Gradle 8.0.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") Provider<? extends FileSystemLocation> getOutputLocation()
@Deprecated @ReplacedBy("outputLocation") java.io.File getDestination()
getOutputLocation() instead. This method will be removed in Gradle 8.0.
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()