| API Documentation: | ReportContainer |
|---|
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 Report.setEnabled() property.
ReportContainer implementations are immutable in that standard collection methods such as add(), remove()
and clear() will throw an ImmutableViolationException. However, implementations may provide new methods that allow
the addition of new report object and/or the removal of existing report objects.
| Method | Description |
getAt(name) | Locates an object by name, failing if there is no such task. This method is identical to |
getByName(name) | Locates an object by name, failing if there is no such object. |
getByName(name, configureClosure) | Locates an object by name, failing if there is no such object. The given configure closure is executed against the object before it is returned from this method. The object is passed to the closure as its delegate. |
NamedDomainObjectSet<T>enabled (read-only)
NamedDomainObjectSet<T>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.
T getAt(String name)
Locates an object by name, failing if there is no such task. This method is identical to NamedDomainObjectCollection.getByName(). You can call this method in your build script by using the groovy [] operator.
T getByName(String name)
Locates an object by name, failing if there is no such object.