gradle/org.gradle.language/BinaryCollection

BinaryCollection

interface BinaryCollection<T : SoftwareComponent?>(source)

A collection of binaries that are created and configured as they are required.

Each element in this collection passes through several states. The element is created and becomes 'known'. The element is passed to any actions registered using whenElementKnown. The element is then configured using any actions registered using configureEach and becomes 'finalized'. The element is passed to any actions registered using whenElementFinalized. Elements are created and configured only when required.

Since

4.5

Parameters

<T>

type of the elements in this container.

Functions

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

Registers an action to execute to configure each element in the collection.

abstract fun <S> configureEach(type: Class<S>, action: Action<in S>)

Registers an action to execute to configure each element of the given type in the collection.

abstract fun get(): Set<T>

Returns the set of binaries from this collection.

abstract fun get(spec: Spec<in T>): BinaryProvider<T>

Returns a Provider that contains the single binary matching the given specification.

abstract fun <S> get(type: Class<S>, spec: Spec<in S>): BinaryProvider<S>

Returns a BinaryProvider that contains the single binary matching the specified type and specification.

abstract fun getByName(name: String): BinaryProvider<T>

Returns a BinaryProvider that contains the single binary with the given name.

whenElementFinalized

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

Registers an action to execute when an element is finalized.

abstract fun <S> whenElementFinalized(type: Class<S>, action: Action<in S>)

Registers an action to execute when an element of the given type is finalized.

whenElementKnown

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

Registers an action to execute when an element becomes known.

abstract fun <S> whenElementKnown(type: Class<S>, action: Action<in S>)

Registers an action to execute when an element of the given type becomes known.