Groovy Documentation

org.gradle.api.reporting
[Java] Interface ReportContainer

org.gradle.api.NamedDomainObjectSet
  org.gradle.api.DomainObjectCollection
      org.gradle.util.Configurable
          java.util.Collection
              org.gradle.api.NamedDomainObjectCollection
                  org.gradle.api.reporting.ReportContainer
                      java.lang.Iterable
All Superinterfaces:
NamedDomainObjectSet, DomainObjectCollection, Configurable, Collection, NamedDomainObjectCollection, Iterable

public interface ReportContainer
extends Configurable, NamedDomainObjectSet

A container of 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(boolean)#setEnabled(boolean) 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.

Parameters:
- The base report type for reports of this container.


Nested Class Summary
static class ReportContainer.ImmutableViolationException

The exception thrown when any of this container's mutation methods are called.

 
Method Summary
NamedDomainObjectSet getEnabled()

Returns an immutable collection of all the enabled reports.

 
Methods inherited from interface NamedDomainObjectSet
findAll, matching, matching, withType
 

Method Detail

getEnabled

public NamedDomainObjectSet getEnabled()
Returns an immutable collection of all the enabled reports. The returned collection is live. That is, as reports are enabled/disabled the returned collection always reflects the current set of enabled reports.
Returns:
The enabled reports.


 

Gradle API 1.5