gradle/org.gradle.kotlin.dsl/NamedDomainObjectContainerScope

NamedDomainObjectContainerScope

open class NamedDomainObjectContainerScope<T : Any> : NamedDomainObjectContainerDelegate<T> , PolymorphicDomainObjectContainer<T> (source)

Receiver for NamedDomainObjectContainer configuration blocks.

Inheritors

ConfigurationContainerScope

Types

Companion

object Companion

Properties

asMap

open override val asMap: SortedMap<String, T>

collectionSchema

open override val collectionSchema: NamedDomainObjectCollectionSchema

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: NamedDomainObjectContainer<T>

namer

open override val namer: Namer<T>

names

open override val names: SortedSet<String>

rules

open override val rules: MutableList<Rule>

size

open override val size: Int

Functions

add

open override fun add(element: T): Boolean

addAll

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

addAllLater

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

addLater

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

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 T>)

clear

open override fun clear()

configure

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

configureEach

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

containerWithType

open override fun containerWithType(type: Class): NamedDomainObjectContainer

Creates a regular container that wraps the polymorphic container presenting all elements of a specified type.

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: T): Boolean

containsAll

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

create

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

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

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

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

open override fun create(name: String): T

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

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

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.

disallowChanges

@Incubating

open fun disallowChanges()

Disallows further structural modifications to this collection.

findAll

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

findByName

open override fun findByName(name: String): 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

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

getAt

open override fun getAt(name: String): T

getByName

open override fun getByName(name: String): T

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

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

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<T>

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(configuration: T.() -> Unit): NamedDomainObjectProvider<T>

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.

isEmpty

open override fun isEmpty(): Boolean

iterator

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

matching

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

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

maybeCreate

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

Looks for an item with the given name and type, creating and adding it to this container if it does not exist.

open override fun maybeCreate(name: String): T

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<T>

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

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

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

open override fun <S : T> 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.

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

Defines a new object, which will be created when it is required. A object is 'required' when the object is located using query methods such as getByName or when get is called on the return value of this method.

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

Defines a new object, which will be created and configured when it is required. A object is 'required' when the object is located using query methods such as getByName or when get is called on the return value of this method.

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

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

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: T): Boolean

removeAll

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

retainAll

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

whenObjectAdded

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

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

whenObjectRemoved

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

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

withType

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

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

open override fun <S : T> 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.