Interface ReportContainer<T extends Report>
- Type Parameters:
T- The base report type for reports of this container.
- All Superinterfaces:
Collection<T>,Configurable<ReportContainer<T>>,DomainObjectCollection<T>,DomainObjectSet<T>,Iterable<T>,NamedDomainObjectCollection<T>,NamedDomainObjectSet<T>,Set<T>
- All Known Subinterfaces:
ArtifactTransformReports,BuildDashboardReports,CheckstyleReports,CodeNarcReports,ConfigurationReports,DependencyReportContainer,JacocoReportsContainer,PmdReports,TestTaskReports
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.getRequired() required} 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.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic classThe exception thrown when any of this container's mutation methods are called. -
Method Summary
Modifier and TypeMethodDescriptiongetAsMap()Returns the objects in this collection, as a map from object name to object instance.Returns an immutable collection of all the enabledReportobjects in this container.Returns the enabled reports, keyed by report name.getNamer()An object that represents the naming strategy used to name objects of this collection.getNames()Returns the names of the objects in this collection as a Set of Strings.getRules()Returns the rules used by this collection.booleanisEmpty()Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArrayMethods inherited from interface org.gradle.util.Configurable
configureMethods inherited from interface org.gradle.api.DomainObjectCollection
addAllLater, addLater, all, all, configureEach, whenObjectAdded, whenObjectAdded, whenObjectRemoved, whenObjectRemoved, withType, withTypeMethods inherited from interface org.gradle.api.NamedDomainObjectCollection
add, addAll, addRule, addRule, addRule, findByName, getAt, getByName, getByName, getByName, getCollectionSchema, named, named, named, named
-
Method Details
-
getEnabled
Returns an immutable collection of all the enabledReportobjects 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.
-
getNamer
Description copied from interface:NamedDomainObjectCollectionAn object that represents the naming strategy used to name objects of this collection.- Specified by:
getNamerin interfaceNamedDomainObjectCollection<T extends Report>- Returns:
- Object representing the naming strategy.
-
getAsMap
Description copied from interface:NamedDomainObjectCollectionReturns the objects in this collection, as a map from object name to object instance.The map is ordered by the natural ordering of the object names (i.e. keys).
This operation is eager and will cause all elements of the collection to be realized.
- Specified by:
getAsMapin interfaceNamedDomainObjectCollection<T extends Report>- Returns:
- The objects. Returns an empty map if this collection is empty.
-
getNames
Description copied from interface:NamedDomainObjectCollectionReturns the names of the objects in this collection as a Set of Strings.The set of names is in natural ordering.
This operation is lazy and pending elements of this collection will not be realized.
- Specified by:
getNamesin interfaceNamedDomainObjectCollection<T extends Report>- Returns:
- The names. Returns an empty set if this collection is empty.
-
getRules
Description copied from interface:NamedDomainObjectCollectionReturns the rules used by this collection.- Specified by:
getRulesin interfaceNamedDomainObjectCollection<T extends Report>- Returns:
- The rules, in the order they will be applied.
-
isEmpty
-
getEnabledReports
Returns the enabled reports, keyed by report name.- Since:
- 4.7
-