Package org.gradle.api.reporting

Schnittstelle Reporting<T extends ReportContainer>

Typparameter:
T - The base type of the report container
Alle bekannten Implementierungsklassen:
AbstractConfigurationReportTask, AbstractTestTask, Checkstyle, CodeNarc, GenerateBuildDashboard, HtmlDependencyReportTask, JacocoReport, OutgoingVariantsReportTask, Pmd, ResolvableConfigurationsReportTask, Test, XCTest
public interface Reporting<T extends ReportContainer>
An object that provides reporting options.

Tasks that produce reports as part of their execution expose configuration options of those reports via these methods. The Reporting interface is parameterized, where the parameter denotes the specific type of reporting container that is exposed. The specific type of the reporting container denotes the different types of reports available.

For example, given a task such as: 

 class MyTask implements Reporting<MyReportContainer> {
     // implementation
 }

 interface MyReportContainer extends ReportContainer<Report> {
     Report getHtml();
     Report getCsv();
 }

The reporting aspects of such a task can be configured as such: 

 task my(type: MyTask) {
     reports {
         html.required = true
         csv.required = false
     }
 }

See the documentation for the specific ReportContainer type for the task for information on report types and options.

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    T
    getReports()
    A ReportContainer instance.
    T
    reports(Closure closure)
    Allow configuration of the report container by closure.
    T
    reports(Action<? super T> configureAction)
    Allow configuration of the report container by closure.

  • Methodendetails

    • getReports

      T getReports()
      A ReportContainer instance.

      Implementers specify a specific implementation of ReportContainer that describes the types of reports that are available.

      Gibt zurück:
      The report container

    • reports

      T reports(@DelegatesTo(type="T",strategy=1) Closure closure)
      Allow configuration of the report container by closure. 
       reports {
   html {
     required false
   }
   xml.outputLocation = "build/reports/myReport.xml"
 }
      Parameter:
      closure - The configuration
      Gibt zurück:
      The report container

    • reports

      T reports(Action<? super T> configureAction)
      Allow configuration of the report container by closure. 
       reports {
   html {
     required false
   }
   xml.outputLocation = "build/reports/myReport.xml"
 }
      Parameter:
      configureAction - The configuration
      Gibt zurück:
      The report container