Package org.gradle.api.reporting

Schnittstelle ReportContainer<T extends Report>

Typparameter:
T - The base report type for reports of this container.
Alle Superschnittstellen:
Collection<T>, Configurable<ReportContainer<T>>, DomainObjectCollection<T>, DomainObjectSet<T>, Iterable<T>, NamedDomainObjectCollection<T>, NamedDomainObjectSet<T>, Set<T>
Alle bekannten Unterschnittstellen:
ArtifactTransformReports, BuildDashboardReports, CheckstyleReports, CodeNarcReports, ConfigurationReports, DependencyReportContainer, JacocoReportsContainer, PmdReports, TestTaskReports
public interface ReportContainer<T extends Report> extends NamedDomainObjectSet<T>, Configurable<ReportContainer<T>>
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.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.

  • Methodendetails

    • getEnabled

      @Internal NamedDomainObjectSet<T> 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.

      Gibt zurück:
      The enabled reports.

    • getNamer

      @Internal Namer<T> getNamer()
      Beschreibung aus Schnittstelle kopiert: NamedDomainObjectCollection
      An object that represents the naming strategy used to name objects of this collection.
      Angegeben von:
      getNamer in Schnittstelle NamedDomainObjectCollection<T extends Report>
      Gibt zurück:
      Object representing the naming strategy.

    • getAsMap

      @Internal SortedMap<String,T> getAsMap()
      Beschreibung aus Schnittstelle kopiert: NamedDomainObjectCollection
      Returns 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.

      Angegeben von:
      getAsMap in Schnittstelle NamedDomainObjectCollection<T extends Report>
      Gibt zurück:
      The objects. Returns an empty map if this collection is empty.

    • getNames

      @Internal SortedSet<String> getNames()
      Beschreibung aus Schnittstelle kopiert: NamedDomainObjectCollection
      Returns 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.

      Angegeben von:
      getNames in Schnittstelle NamedDomainObjectCollection<T extends Report>
      Gibt zurück:
      The names. Returns an empty set if this collection is empty.

    • getRules

      @Internal List<Rule> getRules()
      Beschreibung aus Schnittstelle kopiert: NamedDomainObjectCollection
      Returns the rules used by this collection.
      Angegeben von:
      getRules in Schnittstelle NamedDomainObjectCollection<T extends Report>
      Gibt zurück:
      The rules, in the order they will be applied.

    • isEmpty

      @Internal boolean isEmpty()
      Angegeben von:
      isEmpty in Schnittstelle Collection<T extends Report>
      Angegeben von:
      isEmpty in Schnittstelle Set<T extends Report>

    • getEnabledReports

      Map<String,T> getEnabledReports()
      Returns the enabled reports, keyed by report name.
      Seit:
      4.7