org.gradle.api.reporting

インタフェース Reporting<T extends ReportContainer>

型パラメータ:

T - The base type of the report container

既知の実装クラスのリスト:

GenerateBuildDashboard, HtmlDependencyReportTask, Test

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.enabled = true
         csv.enabled = false
     }
 }
 

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

メソッドの概要

修飾子とタイプ	メソッドと説明
T	getReports() A ReportContainer instance.
T	reports(Closure closure) Allow configuration of the report container by closure.

メソッドの詳細

getReports

T getReports()

A ReportContainer instance.

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

戻り値:

The report container

reports

T reports(Closure closure)

Allow configuration of the report container by closure.

 reports {
   html {
     enabled false
   }
   xml.destination "build/reports/myReport.xml"
 }
 

パラメータ:

closure - The configuration

戻り値:

The report container