Package org.gradle.api.reporting
Interface DirectoryReport
-
- All Superinterfaces:
org.gradle.util.Configurable<Report>,ConfigurableReport,Report,Serializable
- 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 FilegetDestination()The location on the filesystem of the report when it is generated.FilegetEntryPoint()Returns the entry point of a directory based Report This can be the index.html file in a HTML reportReport.OutputTypegetOutputType()Always returnsReport.OutputType.DIRECTORY-
Methods inherited from interface org.gradle.api.reporting.ConfigurableReport
setDestination, setDestination, setEnabled, setEnabled
-
Methods inherited from interface org.gradle.api.reporting.Report
getDisplayName, getName, isEnabled
-
-
-
-
Method Detail
-
getEntryPoint
@Internal 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
getDestination()if no entry point defined
-
getDestination
@OutputDirectory File getDestination()
Description copied from interface:ReportThe location on the filesystem of the report when it is generated.Depending on the
output typeof the report, this may point to a file or a directory.Subtypes may implement setters for the destination.
- Specified by:
getDestinationin interfaceReport- Returns:
- The location on the filesystem of the report when it is generated
-
getOutputType
Report.OutputType getOutputType()
Always returnsReport.OutputType.DIRECTORY- Specified by:
getOutputTypein interfaceReport- Returns:
Report.OutputType.DIRECTORY
-
-