org.myire.quill.report

Interface ReportingEntity<T extends ReportSet & org.gradle.util.Configurable<T>>

Type Parameters:

T - The report container type.

All Known Implementing Classes:

CpdTask, DashboardTask, JolTask, ScentTask

public interface ReportingEntity<T extends ReportSet & org.gradle.util.Configurable<T>>

A ReportingEntity produces one or more reports encapsulated in a container type that allows configuring the reports through a Closure or Action.

This interface is variant of org.gradle.api.reporting.Reporting that doesn't depend on org.gradle.api.reporting.ReportContainer. See https://github.com/gradle/gradle/issues/7063 for a discussion on why external plugins shouldn't use Reporting and ReportContainer (and don't miss this comment).

Method Summary

Modifier and Type	Method and Description
T	getReports() Get the reports created by this entity.
T	reports(org.gradle.api.Action<? super T> pConfigureAction) Configure the reports created by this entity.
T	reports(groovy.lang.Closure pClosure) Configure the reports created by this entity.

Method Detail

getReports

T getReports()

Get the reports created by this entity.

Returns:

The reports, never null.

reports

T reports(@DelegatesTo(type="T",strategy=1)
          groovy.lang.Closure pClosure)

Configure the reports created by this entity.

Parameters:

pClosure - A closure that configures the reports.

Returns:

The configured reports, never null.

reports

T reports(org.gradle.api.Action<? super T> pConfigureAction)

Configure the reports created by this entity.

Parameters:

pConfigureAction - An action that configures the reports.

Returns:

The configured reports, never null.