api / org.gradle.api.reporting / DirectoryReport

DirectoryReport

@Incubating interface DirectoryReport : ConfigurableReport

A directory based report to be created.

Functions

getDestination

abstract fun getDestination(): File

getEntryPoint

abstract fun getEntryPoint(): File

Returns the entry point of a directory based Report This can be the index.html file in a HTML report

getOutputType

abstract fun getOutputType(): OutputType

Always returns Report.OutputType#DIRECTORY

Inherited Functions

setDestination

abstract fun setDestination(file: Any): Unit

Sets the destination for the report. The file parameter is evaluated as per org.gradle.api.Project#file(Object).

abstract fun setDestination(file: File): Unit
abstract fun setDestination(provider: Provider<File>): Unit

Sets the destination for the report.

setEnabled

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.

Inheritors

JUnitXmlReport

interface JUnitXmlReport : DirectoryReport

The JUnit XML files, commonly used to communicate results to CI servers.