T - The base report type for reports of this container.public interface ReportContainer<T extends Report> extends NamedDomainObjectSet<T>, org.gradle.util.Configurable<ReportContainer<T>>
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.
| Modifier and Type | Interface and Description |
|---|---|
static class |
ReportContainer.ImmutableViolationException
The exception thrown when any of this container's mutation methods are called.
|
| Modifier and Type | Method and Description |
|---|---|
NamedDomainObjectSet<T> |
getEnabled()
Returns an immutable collection of all the enabled
Report objects in this container. |
findAll, matching, matching, withTypeadd, addAll, addRule, addRule, findByName, getAsMap, getAt, getByName, getByName, getNamer, getRulesall, all, whenObjectAdded, whenObjectAdded, whenObjectRemoved, whenObjectRemoved, withType, withTypeclear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArrayNamedDomainObjectSet<T> getEnabled()
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.