Interface ReportContainer<T extends Report>
-
- Type Parameters:
T- The base report type for reports of this container.
- All Superinterfaces:
java.util.Collection<T>,Configurable<ReportContainer<T>>,DomainObjectCollection<T>,DomainObjectSet<T>,java.lang.Iterable<T>,NamedDomainObjectCollection<T>,NamedDomainObjectSet<T>,java.util.Set<T>
- All Known Subinterfaces:
BuildDashboardReports,CheckstyleReports,CodeNarcReports,ConfigurationReports,DependencyReportContainer,JacocoReportsContainer,PmdReports,TestTaskReports
public interface ReportContainer<T extends Report> extends NamedDomainObjectSet<T>, Configurable<ReportContainer<T>>
A container ofReportobjects, that represent potential reports.Things that produce reports (typically tasks) expose a report container that contains
Reportobjects 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 itsReport.getRequired()required} property.ReportContainerimplementations are immutable in that standard collection methods such asadd(),remove()andclear()will throw anReportContainer.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 Classes Modifier and Type Interface Description static classReportContainer.ImmutableViolationExceptionThe exception thrown when any of this container's mutation methods are called.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.SortedMap<java.lang.String,T>getAsMap()Returns the objects in this collection, as a map from object name to object instance.NamedDomainObjectSet<T>getEnabled()Returns an immutable collection of all the enabledReportobjects in this container.java.util.Map<java.lang.String,T>getEnabledReports()Returns the enabled reports, keyed by report name.Namer<T>getNamer()An object that represents the naming strategy used to name objects of this collection.java.util.SortedSet<java.lang.String>getNames()Returns the names of the objects in this collection as a Set of Strings.java.util.List<Rule>getRules()Returns the rules used by this collection.booleanisEmpty()-
Methods inherited from interface org.gradle.util.Configurable
configure
-
Methods inherited from interface org.gradle.api.DomainObjectCollection
addAllLater, addLater, all, all, configureEach, whenObjectAdded, whenObjectAdded, whenObjectRemoved, whenObjectRemoved, withType, withType
-
Methods inherited from interface org.gradle.api.NamedDomainObjectCollection
add, addAll, addRule, addRule, addRule, findByName, getAt, getByName, getByName, getByName, getCollectionSchema, named, named, named, named
-
-
-
-
Method Detail
-
getEnabled
@Internal NamedDomainObjectSet<T> 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
@Internal Namer<T> 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
@Internal java.util.SortedMap<java.lang.String,T> 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).
- Specified by:
getAsMapin interfaceNamedDomainObjectCollection<T extends Report>- Returns:
- The objects. Returns an empty map if this collection is empty.
-
getNames
@Internal java.util.SortedSet<java.lang.String> 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.
- Specified by:
getNamesin interfaceNamedDomainObjectCollection<T extends Report>- Returns:
- The names. Returns an empty set if this collection is empty.
-
getRules
@Internal java.util.List<Rule> 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
@Internal boolean isEmpty()
-
getEnabledReports
java.util.Map<java.lang.String,T> getEnabledReports()
Returns the enabled reports, keyed by report name.- Since:
- 4.7
-
-