Report

API Documentation:Report

A file based report to be created.

Tasks that produce reports expose instances of this type for configuration via the Reporting interface.

Properties

PropertyDescription
destination
Deprecated
Replaced

The location on the filesystem of the report when it is generated.

displayName

A more descriptive name of this report. Used when the report is referenced for end users.

enabled
Deprecated
Replaced

Whether or not this report should be generated by whatever generates it.

name

The symbolic name of this report.

outputLocation

The location on the filesystem to generate the report to.

outputType

The type of output that the report generates.

required

A flag that determines whether this report should be generated or not.

Methods

No methods

Script blocks

No script blocks

Property details

File destination (read-only)

Note: This property is deprecated and will be removed in the next major version of Gradle.

Note: This property has been replaced by outputLocation.

The location on the filesystem of the report when it is generated.

Depending on the Report.getOutputType() of the report, this may point to a file or a directory.

Subtypes may implement setters for the destination.

String displayName (read-only)

A more descriptive name of this report. Used when the report is referenced for end users.

boolean enabled

Note: This property is deprecated and will be removed in the next major version of Gradle.

Note: This property has been replaced by required.

Whether or not this report should be generated by whatever generates it.

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.

String name (read-only)

The symbolic name of this report.

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

Provider<? extends FileSystemLocation> outputLocation

The location on the filesystem to generate the report to.

OutputType outputType (read-only)

The type of output that the report generates.

Property<Boolean> required

A flag that determines whether this report should be generated or not.