Package org.gradle.api.reporting
Interface DirectoryReport
-
- All Superinterfaces:
Configurable<Report>
,ConfigurableReport
,Report
- All Known Subinterfaces:
JUnitXmlReport
public interface DirectoryReport extends ConfigurableReport
A directory based report to be created.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.gradle.api.reporting.Report
Report.OutputType
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.io.File
getEntryPoint()
Returns the entry point of a directory based Report This can be the index.html file in a HTML reportDirectoryProperty
getOutputLocation()
The location on the filesystem to generate the report to.Report.OutputType
getOutputType()
Always returnsReport.OutputType.DIRECTORY
-
Methods inherited from interface org.gradle.util.Configurable
configure
-
Methods inherited from interface org.gradle.api.reporting.ConfigurableReport
setDestination
-
Methods inherited from interface org.gradle.api.reporting.Report
getDisplayName, getName, getRequired
-
-
-
-
Method Detail
-
getEntryPoint
@Internal java.io.File getEntryPoint()
Returns the entry point of a directory based Report This can be the index.html file in a HTML report- Returns:
- the entry point of the report or
getOutputLocation()
if no entry point defined
-
getOutputLocation
@OutputDirectory DirectoryProperty getOutputLocation()
Description copied from interface:Report
The location on the filesystem to generate the report to.- Specified by:
getOutputLocation
in interfaceReport
-
getOutputType
Report.OutputType getOutputType()
Always returnsReport.OutputType.DIRECTORY
- Specified by:
getOutputType
in interfaceReport
- Returns:
Report.OutputType.DIRECTORY
-
-