Package org.gradle.api.reporting
Interface Report
- All Superinterfaces:
- Configurable<Report>
- All Known Subinterfaces:
- ConfigurableReport,- CustomizableHtmlReport,- DirectoryReport,- JUnitXmlReport,- SingleFileReport
A file based report to be created.
 
 Tasks that produce reports expose instances of this type for configuration via the Reporting interface.
- 
Nested Class SummaryNested ClassesModifier and TypeInterfaceDescriptionstatic enumThe type of output the report produces
- 
Field SummaryFields
- 
Method SummaryModifier and TypeMethodDescriptionA more descriptive name of this report.getName()The symbolic name of this report.Property<? extends FileSystemLocation> The location on the filesystem to generate the report to.The type of output that the report generates.A flag that determines whether this report should be generated or not.Methods inherited from interface org.gradle.util.Configurableconfigure
- 
Field Details- 
NAMER
 
- 
- 
Method Details- 
getNameThe 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 namedreportscontaining a report who'sgetName()returns"html", the report could be accessed via:reports.html - Returns:
- The name of this report.
 
- 
getDisplayNameA more descriptive name of this report. Used when the report is referenced for end users.- Returns:
- A more descriptive name of this report.
 
- 
getRequiredA flag that determines whether this report should be generated or not.- Since:
- 6.1
 
- 
getOutputLocation@Internal("Implementations need to add the correct annotation, @OutputDirectory or @OutputFile") Property<? extends FileSystemLocation> getOutputLocation()The location on the filesystem to generate the report to.- Since:
- 6.1
 
- 
getOutputTypeThe type of output that the report generates.- Returns:
- The type of output that the report generates.
 
 
-