@Incubating interface ConfigurableReport : Report
A file based report to be created with a configurable destination.
static val NAMER: Namer<Report> |
abstract fun setDestination(file: Any): Unit
Sets the destination for the report. The file parameter is evaluated as per abstract fun setDestination(file: File): Unit abstract fun setDestination(provider: Provider<File>): Unit
Sets the destination for the report. |
|
abstract fun setEnabled(enabled: Boolean): Unit abstract fun setEnabled(enabled: Provider<Boolean>): Unit
Whether or not this report should be generated by whatever generates it. |
abstract fun getDestination(): File
The location on the filesystem of the report when it is generated. Depending on the Subtypes may implement setters for the destination. |
|
abstract fun getDisplayName(): String
A more descriptive name of this report. Used when the report is referenced for end users. |
|
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
|
|
abstract fun getOutputType(): OutputType
The type of output that the report generates. |
|
abstract fun isEnabled(): Boolean
Whether or not this report should be generated by whatever generates it. If |
interface DirectoryReport : ConfigurableReport
A directory based report to be created. |
|
interface SingleFileReport : ConfigurableReport
A report that is a single file. |