gradle/org.gradle.kotlin.dsl/ConfigurationContainerScope

ConfigurationContainerScope

class ConfigurationContainerScope : NamedDomainObjectContainerScope<Configuration> , ConfigurationContainer(source)

Receiver for ConfigurationContainer configuration blocks.

Since

8.4

Types

Companion

object Companion

Properties

creating

val <T : Any> NamedDomainObjectContainer<T>.creating: NamedDomainObjectContainerCreatingDelegateProvider<T>

Provides a property delegate that creates elements of the default collection type.

delegate

open override val delegate: ConfigurationContainer

size

open override val size: Int

Functions

add

open override fun add(element: Configuration): Boolean

addAll

open override fun addAll(elements: Collection<Configuration>): Boolean

addAllLater

open override fun addAllLater(provider: Provider<out Iterable<Configuration>>)

addLater

open override fun addLater(provider: Provider<out Configuration>)

addRule

open override fun addRule(rule: Rule): Rule

open override fun addRule(description: String, ruleAction: Closure<Any>): Rule

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

all

open override fun all(action: Closure<Any>)

open override fun all(action: Action<in Configuration>)

clear

open override fun clear()

configure

open override fun configure(configureClosure: Closure<Any>): NamedDomainObjectContainer<Configuration>

configureEach

open override fun configureEach(action: Action<in Configuration>)

consumable

open override fun consumable(name: String): NamedDomainObjectProvider<ConsumableConfiguration>

open override fun consumable(name: String, action: Action<in ConsumableConfiguration>): NamedDomainObjectProvider<ConsumableConfiguration>

containerWithType

open override fun containerWithType(type: Class): NamedDomainObjectContainer

containerWithType

inline fun PolymorphicDomainObjectContainer<T>.containerWithType(type: KClass): NamedDomainObjectContainer

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.PolymorphicDomainObjectContainer.containerWithType.

contains

open operator override fun contains(element: Configuration): Boolean

containsAll

open override fun containsAll(elements: Collection<Configuration>): Boolean

create

open override fun create(name: String, type: Class): U

open override fun create(name: String, type: Class, configuration: Action<in U>): U

open override fun create(name: String): Configuration

open override fun create(name: String, configureClosure: Closure<Any>): Configuration

open override fun create(name: String, configureAction: Action<in Configuration>): Configuration

create

inline fun PolymorphicDomainObjectContainer<in U>.create(name: String): U

Creates a domain object with the specified name and type, and adds it to the container.

inline fun PolymorphicDomainObjectContainer<in U>.create(name: String, noinline configuration: U.() -> Unit): U

Creates a domain object with the specified name and type, adds it to the container, and configures it with the specified action.

inline fun PolymorphicDomainObjectContainer<T>.create(name: String, type: KClass): U

inline fun PolymorphicDomainObjectContainer<T>.create(name: String, type: KClass, configuration: Action<in U>): U

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.PolymorphicDomainObjectContainer.create.

creating

fun <T : Any> NamedDomainObjectContainer<T>.creating(configuration: T.() -> Unit): NamedDomainObjectContainerCreatingDelegateProvider<T>

Provides a property delegate that creates elements of the default collection type with the given configuration.

fun <T : Any, U : T> PolymorphicDomainObjectContainer<T>.creating(type: KClass): PolymorphicDomainObjectContainerCreatingDelegateProvider<T, U>

Provides a property delegate that creates elements of the given type.

fun <T : Any, U : T> PolymorphicDomainObjectContainer<T>.creating(type: Class, configuration: U.() -> Unit): PolymorphicDomainObjectContainerCreatingDelegateProvider<T, U>

Provides a property delegate that creates elements of the given type expressed as a java.lang.Class with the given configuration.

fun <T : Any, U : T> PolymorphicDomainObjectContainer<T>.creating(type: KClass, configuration: U.() -> Unit): PolymorphicDomainObjectContainerCreatingDelegateProvider<T, U>

Provides a property delegate that creates elements of the given type with the given configuration.

dependencyScope

open override fun dependencyScope(name: String): NamedDomainObjectProvider<DependencyScopeConfiguration>

open override fun dependencyScope(name: String, action: Action<in DependencyScopeConfiguration>): NamedDomainObjectProvider<DependencyScopeConfiguration>

detachedConfiguration

open override fun detachedConfiguration(vararg dependencies: Dependency): Configuration

findAll

open override fun findAll(spec: Closure<Any>): MutableSet<Configuration>

findByName

open override fun findByName(name: String): Configuration?

forEach

open fun forEach(p0: Consumer<in Configuration>)

get

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

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

getAsMap

open override fun getAsMap(): SortedMap<String, Configuration>

getAt

open override fun getAt(name: String): Configuration

getByName

open override fun getByName(name: String): Configuration

open override fun getByName(name: String, configureClosure: Closure<Any>): Configuration

open override fun getByName(name: String, configureAction: Action<in Configuration>): Configuration

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

open override fun getCollectionSchema(): NamedDomainObjectCollectionSchema

getNamer

open override fun getNamer(): Namer<Configuration>

getNames

open override fun getNames(): SortedSet<String>

getRules

open override fun getRules(): MutableList<Rule>

getting

fun <T : Any, U : T> NamedDomainObjectContainer<T>.getting(type: KClass): PolymorphicDomainObjectContainerGettingDelegateProvider<T, U>

Provides a property delegate that gets elements of the given type.

fun <T : Any, U : T> NamedDomainObjectContainer<T>.getting(type: KClass, configuration: U.() -> Unit): PolymorphicDomainObjectContainerGettingDelegateProvider<T, U>

Provides a property delegate that gets elements of the given type and applies the given configuration.

invoke

operator fun String.~~invoke~~(): NamedDomainObjectProvider<Configuration>

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

operator fun String.invoke(configuration: Configuration.() -> Unit): NamedDomainObjectProvider<Configuration>

operator fun String.invoke(type: KClass, configuration: U.() -> Unit): NamedDomainObjectProvider

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

operator fun String.invoke(type: KClass): NamedDomainObjectProvider

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

invoke

@Incubating

inline operator fun ConfigurationContainer.invoke(configuration: Action<ConfigurationContainerScope>): ConfigurationContainer

Allows the container to be configured via an augmented DSL.

isEmpty

open override fun isEmpty(): Boolean

iterator

open operator override fun iterator(): MutableIterator<Configuration>

matching

open override fun matching(spec: Closure<Any>): NamedDomainObjectSet<Configuration>

open override fun matching(spec: Spec<in Configuration>): NamedDomainObjectSet<Configuration>

maybeCreate

open override fun maybeCreate(name: String, type: Class): U

open override fun maybeCreate(name: String): Configuration

maybeCreate

inline fun PolymorphicDomainObjectContainer<in U>.maybeCreate(name: String): U

Creates a domain object with the specified name and type if it does not exists, and adds it to the container.

inline fun PolymorphicDomainObjectContainer<T>.maybeCreate(name: String, type: KClass): U

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.PolymorphicDomainObjectContainer.maybeCreate.

named

open override fun named(name: String): NamedDomainObjectProvider<Configuration>

open override fun named(predicate: Spec<String>): NamedDomainObjectSet<Configuration>

open override fun <S : Configuration> named(name: String, type: Class<S>): NamedDomainObjectProvider<S>

open override fun named(name: String, configurationAction: Action<in Configuration>): NamedDomainObjectProvider<Configuration>

open override fun <S : Configuration> named(name: String, type: Class<S>, configurationAction: Action<in S>): NamedDomainObjectProvider<S>

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.

parallelStream

open fun parallelStream(): Stream<Configuration>

provideDelegate

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

Allows a NamedDomainObjectCollection to be used as a property delegate.

open override fun register(name: String, type: Class): NamedDomainObjectProvider

open override fun register(name: String, type: Class, configurationAction: Action<in U>): NamedDomainObjectProvider

open override fun register(name: String): NamedDomainObjectProvider<Configuration>

open override fun register(name: String, configurationAction: Action<in Configuration>): NamedDomainObjectProvider<Configuration>

inline fun <T : Any> PolymorphicDomainObjectContainer<in T>.register(name: String): NamedDomainObjectProvider<T>

Defines a new object, which will be created when it is required.

inline fun <T : Any> PolymorphicDomainObjectContainer<in T>.register(name: String, noinline configuration: T.() -> Unit): NamedDomainObjectProvider<T>

Defines and configure a new object, which will be created when it is required.

inline fun PolymorphicDomainObjectContainer<T>.register(name: String, type: KClass): NamedDomainObjectProvider

inline fun PolymorphicDomainObjectContainer<T>.register(name: String, type: KClass, configurationAction: Action<in U>): NamedDomainObjectProvider

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.PolymorphicDomainObjectContainer.register.

remove

open override fun remove(element: Configuration): Boolean

removeAll

open override fun removeAll(elements: Collection<Configuration>): Boolean

removeIf

open fun removeIf(p0: Predicate<in Configuration>): Boolean

resolvable

open override fun resolvable(name: String): NamedDomainObjectProvider<ResolvableConfiguration>

open override fun resolvable(name: String, action: Action<in ResolvableConfiguration>): NamedDomainObjectProvider<ResolvableConfiguration>

retainAll

open override fun retainAll(elements: Collection<Configuration>): Boolean

spliterator

open override fun spliterator(): Spliterator<Configuration>

stream

open fun stream(): Stream<Configuration>

toArray

open fun <T : Any> ~~toArray~~(p0: IntFunction<Array<T>>): Array<T>

whenObjectAdded

open override fun whenObjectAdded(action: Closure<Any>)

open override fun whenObjectAdded(action: Action<in Configuration>): Action<in Configuration>

whenObjectRemoved

open override fun whenObjectRemoved(action: Closure<Any>)

open override fun whenObjectRemoved(action: Action<in Configuration>): Action<in Configuration>

withType

open override fun <S : Configuration> withType(type: Class<S>): NamedDomainObjectSet<S>

open override fun <S : Configuration> withType(type: Class<S>, configureClosure: Closure<Any>): DomainObjectCollection<S>

open override fun <S : Configuration> withType(type: Class<S>, configureAction: Action<in S>): DomainObjectCollection<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.