api / org.gradle.api.reporting / Report

Report

interface Report : Serializable, Configurable

A file based report to be created.

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

Types

OutputType

class OutputType

The type of output the report produces

Properties

NAMER

static val NAMER: Namer<Report>

Functions

getDestination

abstract fun getDestination(): File

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

Depending on the output type of the report, this may point to a file or a directory.

Subtypes may implement setters for the destination.

getDisplayName

abstract fun getDisplayName(): String

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

getName

abstract fun getName(): String

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 

getOutputType

abstract fun getOutputType(): OutputType

The type of output that the report generates.

isEnabled

abstract fun isEnabled(): Boolean

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.

setEnabled

abstract fun setEnabled(enabled: Boolean): Unit

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

Inheritors

ConfigurableReport

interface ConfigurableReport : Report

A file based report to be created with a configurable destination.