gradle
8.4

# NamedDomainObjectList

interface NamedDomainObjectList<T> : NamedDomainObjectCollection<T> , List<E> (source)

A specialization of org.gradle.api.NamedDomainObjectCollection that also implements java.util.List.

All object equality is determined in terms of object names. That is, calling `remove()` with an object that is NOT equal to an existing object in terms of `equals`, but IS in terms of name equality will result in the existing collection item with the equal name being removed.

You can create an instance of this type using the factory method namedDomainObjectList.

#### Parameters

<T>

The type of objects in the list

#### Inheritors

ArtifactRepositoryContainer

## Functions

add
Link copied to clipboard
abstract fun add(p: Int, p1: E)
abstract fun add(e: T): Boolean
addAll
Link copied to clipboard
abstract fun addAll(c: Collection<out T>): Boolean
addAllLater
Link copied to clipboard
abstract fun addAllLater(provider: Provider<out Iterable<T>>)
addLater
Link copied to clipboard
abstract fun addLater(provider: Provider<out T>)
addRule
Link copied to clipboard
abstract fun addRule(rule: Rule): Rule
all
Link copied to clipboard
abstract fun all(action: Action<out Any>)
clear
Link copied to clipboard
abstract fun clear()
configureEach
Link copied to clipboard
abstract fun configureEach(action: Action<out Any>)
contains
Link copied to clipboard
abstract fun contains(p: Any): Boolean
containsAll
Link copied to clipboard
abstract fun containsAll(p: Collection<out Any>): Boolean
copyOf
Link copied to clipboard
open fun <E> copyOf(coll: Collection<out E>): List<E>
equals
Link copied to clipboard
abstract fun equals(p: Any): Boolean
findAll
Link copied to clipboard
abstract fun findAll(spec: Closure): List<T>
findByName
Link copied to clipboard
abstract fun findByName(name: String): T
forEach
Link copied to clipboard
open fun forEach(action: Consumer<out Any>)
get
Link copied to clipboard
abstract fun get(p: Int): E
get
Link copied to clipboard
operator fun <T : Any> NamedDomainObjectCollection<T>.get(name: String): T

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

getAsMap
Link copied to clipboard
abstract fun getAsMap(): SortedMap<String, T>
getAt
Link copied to clipboard
abstract fun getAt(name: String): T
getByName
Link copied to clipboard
abstract fun getByName(name: String): T
getByName
Link copied to clipboard
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
Link copied to clipboard
abstract fun getCollectionSchema(): NamedDomainObjectCollectionSchema
getNamer
Link copied to clipboard
abstract fun getNamer(): Namer<T>
getNames
Link copied to clipboard
abstract fun getNames(): SortedSet<String>
getRules
Link copied to clipboard
abstract fun getRules(): List<Rule>
hashCode
Link copied to clipboard
abstract fun hashCode(): Int
indexOf
Link copied to clipboard
abstract fun indexOf(p: Any): Int
isEmpty
Link copied to clipboard
abstract fun isEmpty(): Boolean
iterator
Link copied to clipboard
abstract fun iterator(): Iterator<T>
abstract fun iterator(): Iterator<E>
lastIndexOf
Link copied to clipboard
abstract fun lastIndexOf(p: Any): Int
listIterator
Link copied to clipboard
abstract fun listIterator(): ListIterator<E>
matching
Link copied to clipboard
abstract fun matching(spec: Spec<out Any>): DomainObjectCollection<T>
abstract fun matching(spec: Closure): NamedDomainObjectList<T>
abstract fun matching(spec: Spec<out Any>): NamedDomainObjectList<T>
named
Link copied to clipboard
abstract fun named(name: String): NamedDomainObjectProvider<T>
abstract fun <S : T?> named(name: String, type: Class<S>): NamedDomainObjectProvider<S>
named
Link copied to clipboard
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.

of
Link copied to clipboard
open fun <E> of(): List<E>
parallelStream
Link copied to clipboard
open fun parallelStream(): Stream<E>
provideDelegate
Link copied to clipboard
operator fun <T : Any> NamedDomainObjectCollection<T>.provideDelegate(thisRef: Any?, property: KProperty<*>): NamedDomainObjectProvider<T>

Allows a NamedDomainObjectCollection to be used as a property delegate.

remove
Link copied to clipboard
abstract fun remove(p: Int): E
abstract fun remove(p: Any): Boolean
removeAll
Link copied to clipboard
abstract fun removeAll(p: Collection<out Any>): Boolean
removeIf
Link copied to clipboard
open fun removeIf(filter: Predicate<out Any>): Boolean
replaceAll
Link copied to clipboard
open fun replaceAll(operator: UnaryOperator<E>)
retainAll
Link copied to clipboard
abstract fun retainAll(p: Collection<out Any>): Boolean
set
Link copied to clipboard
abstract fun set(p: Int, p1: E): E
size
Link copied to clipboard
abstract fun size(): Int
sort
Link copied to clipboard
open fun sort(c: Comparator<out Any>)
spliterator
Link copied to clipboard
open fun spliterator(): Spliterator<T>
open fun spliterator(): Spliterator<E>
stream
Link copied to clipboard
open fun stream(): Stream<E>
subList
Link copied to clipboard
abstract fun subList(p: Int, p1: Int): List<E>
toArray
Link copied to clipboard
abstract fun toArray(): Array<Any>
abstract fun <T> toArray(p: Array<T>): Array<T>
whenObjectAdded
Link copied to clipboard
abstract fun whenObjectAdded(action: Closure)
abstract fun whenObjectAdded(action: Action<out Any>): Action<out Any>
whenObjectRemoved
Link copied to clipboard
abstract fun whenObjectRemoved(action: Closure)
abstract fun whenObjectRemoved(action: Action<out Any>): Action<out Any>
withType
Link copied to clipboard
abstract fun <S : T?> withType(type: Class<S>): DomainObjectCollection<S>
abstract fun <S : T?> withType(type: Class<S>): NamedDomainObjectList<S>
withType
Link copied to clipboard
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> 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> NamedDomainObjectList<T>.withType(type: KClass<S>): NamedDomainObjectList<S>

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