gradle/org.gradle.api.publish.ivy/IvyConfigurationContainer

IvyConfigurationContainer

interface IvyConfigurationContainer : NamedDomainObjectContainer<T> (source)

The set of IvyConfigurations that will be included in the IvyPublication. Being a org.gradle.api.NamedDomainObjectContainer, a IvyConfigurationContainer provides convenient methods for adding, querying, filtering, and applying actions to the set of IvyConfigurations.

plugins {
    id 'ivy-publish'
}

def publication = publishing.publications.create("my-pub", IvyPublication)
def configurations = publication.configurations

configurations.create("extended", { extend "default"})
configurations.all {
    extend "base"
}

Properties

creating

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

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

Functions

add

abstract fun add(e: T): Boolean

addAll

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

addAllLater

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

addLater

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

addRule

abstract fun addRule(rule: Rule): Rule

all

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

clear

abstract fun clear()

configure

abstract fun configure(configureClosure: Closure): NamedDomainObjectContainer<T>

abstract fun configure(cl: Closure): T

configureEach

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

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>

create

abstract fun create(name: String): T

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.

equals

abstract fun equals(p: Any): Boolean

findAll

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

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

findByName

abstract fun findByName(name: String): T

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

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

getAt

abstract fun getAt(name: String): T

getByName

abstract fun getByName(name: String): 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

abstract fun getCollectionSchema(): NamedDomainObjectCollectionSchema

getNamer

abstract fun getNamer(): Namer<T>

getNames

abstract fun getNames(): SortedSet<String>

getRules

abstract fun getRules(): List<Rule>

getting

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

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

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

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

hashCode

abstract fun hashCode(): Int

isEmpty

abstract fun isEmpty(): Boolean

iterator

abstract fun iterator(): Iterator<T>

abstract fun iterator(): Iterator<E>

matching

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>

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

maybeCreate

abstract fun maybeCreate(name: String): T

named

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

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

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

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

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.

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

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)

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

whenObjectRemoved

abstract fun whenObjectRemoved(action: Closure)

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

withType

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

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

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

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.