gradle/org.gradle.api.reporting.dependencies/DependencyReportContainer

DependencyReportContainer

interface DependencyReportContainer : ReportContainer<Report> (source)

The set of reports that can be generated by the HtmlDependencyReportTask task type.

Functions

add

abstract fun add(p: E): Boolean

abstract fun add(e: T): Boolean

Adds an object to the collection, if there is no existing object in the collection with the same name.

addAll

abstract fun addAll(p: Collection<out E>): Boolean

abstract fun addAll(c: Collection<out T>): Boolean

Adds any of the given objects to the collection that do not have the same name as any existing element.

addAllLater

abstract fun addAllLater(provider: Provider<out Iterable<T>>)

Adds elements to this collection, given a Provider of Iterable that will provide the elements when required.

addLater

abstract fun addLater(provider: Provider<out T>)

Adds an element to this collection, given a Provider that will provide the element when required.

addRule

abstract fun addRule(rule: Rule): Rule

abstract fun addRule(description: String, ruleAction: Closure): Rule

abstract fun addRule(description: String, ruleAction: Action<String>): Rule

Adds a rule to this collection.

all

abstract fun all(action: Closure)

Executes the given closure against all objects in this collection, and any objects subsequently added to this collection.

abstract fun all(action: Action<in T>)

Executes the given action against all objects in this collection, and any objects subsequently added to this collection.

clear

abstract fun clear()

configure

abstract fun configure(cl: Closure): T

configureEach

abstract fun configureEach(action: Action<in T>)

Configures each element in this collection using the given action, as each element is required.

contains

abstract fun contains(p: Any): Boolean

containsAll

abstract fun containsAll(p: Collection<out Any>): Boolean

copyOf

open fun <E> copyOf(coll: Collection<out E>): Set<E>

disallowChanges

@Incubating

open fun disallowChanges()

Disallows further structural modifications to this collection.

equals

abstract fun equals(p: Any): Boolean

findAll

abstract fun ~~findAll~~(spec: Closure): Collection<T>

abstract fun ~~findAll~~(spec: Closure): Set<T>

Returns a collection which contains the objects in this collection which meet the given closure specification.

findByName

@Nullable

abstract fun findByName(name: String): @Nullable T

Locates an object by name, returning null if there is no such object.

forEach

open fun forEach(action: Consumer<in T>)

get

operator fun <T : Any> NamedDomainObjectCollection<T>.get(name: String): T

Locates an object by name, failing if there is no such object.

getAsMap

@Internal

abstract fun getAsMap(): SortedMap<String, T>

Returns the objects in this collection, as a map from object name to object instance.

getAt

abstract fun getAt(name: String): T

Locates an object by name, failing if there is no such object.

getByName

abstract fun getByName(name: String): T

abstract fun getByName(name: String, configureClosure: Closure): T

abstract fun getByName(name: String, configureAction: Action<in T>): T

Locates an object by name, failing if there is no such object.

getByName

inline fun <T : Any> NamedDomainObjectCollection<out Any>.getByName(name: String): T

Locates an object by name and casts it to the expected type T.

inline fun <T : Any> NamedDomainObjectCollection<out Any>.getByName(name: String, configure: T.() -> Unit): T

Locates an object by name and casts it to the expected type T then configures it.

fun <T : Any> NamedDomainObjectCollection<out Any>.getByName(name: String, type: KClass<T>): T

Locates an object by name and casts it to the expected type.

fun <T : Any> NamedDomainObjectCollection<out Any>.getByName(name: String, type: KClass<T>, configure: T.() -> Unit): T

Locates an object by name and casts it to the expected type then configures it.

getCollectionSchema

@Internal

abstract fun getCollectionSchema(): NamedDomainObjectCollectionSchema

Provides access to the schema of all created or registered named domain objects in this collection.

getEnabled

@Internal

abstract fun getEnabled(): NamedDomainObjectSet<T>

Returns an immutable collection of all the enabled Report objects in this container.

getEnabledReports

abstract fun getEnabledReports(): Map<String, T>

Returns the enabled reports, keyed by report name.

getHtml

@Internal

abstract fun getHtml(): DirectoryReport

The dependency HTML report

getNamer

@Internal

abstract fun getNamer(): Namer<T>

An object that represents the naming strategy used to name objects of this collection.

getNames

@Internal

abstract fun getNames(): SortedSet<String>

Returns the names of the objects in this collection as a Set of Strings.

getRules

@Internal

abstract fun getRules(): List<Rule>

Returns the rules used by this collection.

hashCode

abstract fun hashCode(): Int

isEmpty

abstract fun isEmpty(): Boolean

@Internal

abstract fun isEmpty(): Boolean

iterator

abstract fun iterator(): Iterator<T>

abstract fun iterator(): Iterator<E>

matching

abstract fun matching(spec: Closure): DomainObjectCollection<T>

abstract fun matching(spec: Closure): DomainObjectSet<T>

abstract fun matching(spec: Closure): NamedDomainObjectCollection<T>

Returns a collection which contains the objects in this collection which meet the given closure specification.

abstract fun matching(spec: Spec<in T>): DomainObjectCollection<T>

abstract fun matching(spec: Spec<in T>): DomainObjectSet<T>

abstract fun matching(spec: Spec<in T>): NamedDomainObjectCollection<T>

Returns a collection which contains the objects in this collection which meet the given specification.

abstract fun matching(spec: Closure): NamedDomainObjectSet<T>

abstract fun matching(spec: Spec<in T>): NamedDomainObjectSet<T>

named

abstract fun named(name: String): NamedDomainObjectProvider<T>

abstract fun named(name: String, configurationAction: Action<in T>): NamedDomainObjectProvider<T>

Locates a object by name, failing if there is no such object.

@Incubating

open fun named(nameFilter: Spec<String>): NamedDomainObjectCollection<T>

abstract fun named(nameFilter: Spec<String>): NamedDomainObjectSet<T>

Returns a collection containing the objects with names matching the provided filter.

abstract fun <S : T?> named(name: String, type: Class<S>): NamedDomainObjectProvider<S>

abstract fun <S : T?> named(name: String, type: Class<S>, configurationAction: Action<in S>): NamedDomainObjectProvider<S>

Locates a object by name and type, failing if there is no such object.

named

inline fun <T : Any> NamedDomainObjectCollection<out Any>.named(name: String): NamedDomainObjectProvider<T>

fun <T : Any> NamedDomainObjectCollection<out Any>.named(name: String, type: KClass<T>): NamedDomainObjectProvider<T>

Locates an object by name and type, without triggering its creation or configuration, failing if there is no such object.

inline fun <S : T, T : Any> NamedDomainObjectCollection<T>.named(name: String, type: KClass<S>): NamedDomainObjectProvider<S>

inline fun <S : T, T : Any> NamedDomainObjectCollection<T>.named(name: String, type: KClass<S>, configurationAction: Action<in S>): NamedDomainObjectProvider<S>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.NamedDomainObjectCollection.named.

inline fun <T : Any> NamedDomainObjectCollection<out Any>.named(name: String, noinline configuration: T.() -> Unit): NamedDomainObjectProvider<T>

fun <T : Any> NamedDomainObjectCollection<out Any>.named(name: String, type: KClass<T>, configuration: T.() -> Unit): NamedDomainObjectProvider<T>

Configures an object by name and type, without triggering its creation or configuration, failing if there is no such object.

open fun <E> of(): Set<E>

parallelStream

open fun parallelStream(): Stream<E>

provideDelegate

operator fun <T : Any> NamedDomainObjectCollection<T>.~~provideDelegate~~(thisRef: Any?, property: KProperty<*>): NamedDomainObjectProvider<T?>?

Allows a NamedDomainObjectCollection to be used as a property delegate.

remove

abstract fun remove(p: Any): Boolean

removeAll

abstract fun removeAll(p: Collection<out Any>): Boolean

removeIf

open fun removeIf(filter: Predicate<in E>): Boolean

retainAll

abstract fun retainAll(p: Collection<out Any>): Boolean

size

abstract fun size(): Int

spliterator

open fun spliterator(): Spliterator<T>

open fun spliterator(): Spliterator<E>

stream

open fun stream(): Stream<E>

toArray

abstract fun toArray(): Array<Any>

abstract fun <T> toArray(p: Array<T>): Array<T>

whenObjectAdded

abstract fun whenObjectAdded(action: Closure)

Adds a closure to be called when an object is added to this collection.

abstract fun whenObjectAdded(action: Action<in T>): Action<in T>

Adds an Action to be executed when an object is added to this collection.

whenObjectRemoved

abstract fun whenObjectRemoved(action: Closure)

Adds a closure to be called when an object is removed from this collection.

abstract fun whenObjectRemoved(action: Action<in T>): Action<in T>

Adds an Action to be executed when an object is removed from this collection.

withType

abstract fun <S : T?> withType(type: Class<S>): DomainObjectCollection<S>

abstract fun <S : T?> withType(type: Class<S>, @DelegatesTo(genericTypeIndex = 0) configureClosure: Closure): DomainObjectCollection<S>

abstract fun <S : T?> withType(type: Class<S>, configureAction: Action<in S>): DomainObjectCollection<S>

abstract fun <S : T?> withType(type: Class<S>): DomainObjectSet<S>

abstract fun <S : T?> withType(type: Class<S>): NamedDomainObjectCollection<S>

Returns a collection containing the objects in this collection of the given type.

abstract fun <S : T?> withType(type: Class<S>): NamedDomainObjectSet<S>

withType

inline fun <S : Any> DomainObjectCollection<in S>.withType(): DomainObjectCollection<S?>?

inline fun <S : Any> NamedDomainObjectCollection<in S>.withType(): NamedDomainObjectCollection<S>

Returns a collection containing the objects in this collection of the given type. The returned collection is live, so that when matching objects are later added to this collection, they are also visible in the filtered collection.

inline fun <S : Any> DomainObjectCollection<in S>.withType(noinline configuration: S.() -> Unit): DomainObjectCollection<S?>?

Returns a collection containing the objects in this collection of the given type. Equivalent to calling withType(type).all(configureAction).

inline fun <S : T, T : Any> DomainObjectCollection<T>.withType(type: KClass<S>): DomainObjectCollection<S>

inline fun <S : T, T : Any> DomainObjectCollection<T>.withType(type: KClass<S>, configureAction: Action<in S>): DomainObjectCollection<S>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.DomainObjectCollection.withType.

inline fun <S : T, T : Any> DomainObjectSet<T>.withType(type: KClass<S>): DomainObjectSet<S>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.DomainObjectSet.withType.

inline fun <S : T, T : Any> NamedDomainObjectCollection<T>.withType(type: KClass<S>): NamedDomainObjectCollection<S>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.NamedDomainObjectCollection.withType.

inline fun <S : T, T : Any> NamedDomainObjectSet<T>.withType(type: KClass<S>): NamedDomainObjectSet<S>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.NamedDomainObjectSet.withType.