Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | METHOD DETAIL: FIELD | METHOD

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

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

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(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 Report objects in this container.
 
Methods inherited from interface NamedDomainObjectSet
findAll, matching, matching, withType
 
Methods inherited from interface NamedDomainObjectCollection
add, addAll, addRule, addRule, findByName, getAsMap, getAt, getByName, getByName, getNamer, getNames, getRules, matching, matching, withType
 
Methods inherited from interface Set
add, equals, hashCode, clear, contains, isEmpty, size, toArray, toArray, addAll, iterator, remove, containsAll, removeAll, retainAll
 

Method Detail

getEnabled

public NamedDomainObjectSet 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.

Returns:
The enabled reports.

 

Gradle API 1.8