|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | METHOD | DETAIL: FIELD | METHOD |
org.gradle.api.reporting.Report org.gradle.util.Configurable
public interface Report extends Configurable, Serializable
A file based report to be created.
Tasks that produce reports expose instances of this type for configuration via the Reporting interface.
Nested Class Summary | |
---|---|
enum |
Report.OutputType
The type of output the report produces |
Field Summary | |
---|---|
Namer |
NAMER
|
Method Summary | |
---|---|
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()
A file based report to be created. |
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. |
Field Detail |
---|
public Namer NAMER
Method Detail |
---|
public 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.
public String getDisplayName()
public 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
public Report.OutputType getOutputType()
Tasks that produce reports expose instances of this type for configuration via the Reporting interface.
public 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.
public void setEnabled(boolean enabled)
enabled
- Whether or not this report should be generated by whatever generates it.
Gradle API 1.12