gradle/org.gradle.api.reporting/Report

Report

interface Report : Configurable<T> (source)

A file based report to be created.

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

Inheritors

Types

Link copied to clipboard
enum OutputType
The type of output the report produces

Properties

Link copied to clipboard
val NAMER: Namer<Report>

Functions

Link copied to clipboard
abstract fun configure(cl: Closure): T
Link copied to clipboard
@Input
abstract fun getDisplayName(): String
A more descriptive name of this report.
Link copied to clipboard
@Input
abstract fun getName(): String
The symbolic name of this report.
Link copied to clipboard
@Internal(value = "Implementations need to add the correct annotation, @OutputDirectory or @OutputFile")
abstract fun getOutputLocation(): Property<out FileSystemLocation>
The location on the filesystem to generate the report to.
Link copied to clipboard
@Input
abstract fun getOutputType(): Report.OutputType
The type of output that the report generates.
Link copied to clipboard
@Input
abstract fun getRequired(): Property<Boolean>
A flag that determines whether this report should be generated or not.