org.gradle.api.reporting

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

型パラメータ:

T - The base report type for reports of this container.

すべてのスーパーインタフェース:

Collection<T>, org.gradle.util.Configurable<ReportContainer<T>>, DomainObjectCollection<T>, Iterable<T>, NamedDomainObjectCollection<T>, NamedDomainObjectSet<T>, Set<T>

既知のサブインタフェースのリスト:

BuildDashboardReports, CheckstyleReports, CodeNarcReports, DependencyReportContainer, FindBugsReports, JacocoReportsContainer, JDependReports, PmdReports, TestTaskReports

public interface ReportContainer<T extends Report>
extends NamedDomainObjectSet<T>, org.gradle.util.Configurable<ReportContainer<T>>

A container of Report objects, that represent potential reports.

Things that produce reports (typically tasks) expose a report container that contains Report objects for each possible report that they can produce. Each report object can be configured individually, including whether or not it should be produced by way of its enabled property.

ReportContainer implementations are immutable in that standard collection methods such as add(), remove() and clear() will throw an ReportContainer.ImmutableViolationException. However, implementations may provide new methods that allow the addition of new report object and/or the removal of existing report objects.

ネストされたクラスの概要

ネストされたクラス

修飾子とタイプ	インタフェースと説明
static class	ReportContainer.ImmutableViolationException The exception thrown when any of this container's mutation methods are called.

メソッドの概要

修飾子とタイプ	メソッドと説明
NamedDomainObjectSet<T>	getEnabled() Returns an immutable collection of all the enabled Report objects in this container.

インタフェースから継承されたメソッド org.gradle.api.NamedDomainObjectSet

findAll, matching, matching, withType

インタフェースから継承されたメソッド org.gradle.api.NamedDomainObjectCollection

add, addAll, addRule, addRule, findByName, getAsMap, getAt, getByName, getByName, getNamer, getNames, getRules

インタフェースから継承されたメソッド org.gradle.api.DomainObjectCollection

all, all, whenObjectAdded, whenObjectAdded, whenObjectRemoved, whenObjectRemoved, withType, withType

インタフェースから継承されたメソッド java.util.Collection

clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray

インタフェースから継承されたメソッド java.lang.Iterable

forEach

インタフェースから継承されたメソッド java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

インタフェースから継承されたメソッド org.gradle.util.Configurable

configure

メソッドの詳細

getEnabled

NamedDomainObjectSet<T> getEnabled()

Returns an immutable collection of all the enabled Report objects in this container.

The returned collection is live. That is, as reports are enabled/disabled the returned collection always reflects the current set of enabled reports.

戻り値:

The enabled reports.