# PluginContainer

interface PluginContainer : PluginCollection<T>

A `PluginContainer` is used to manage a set of org.gradle.api.Plugin instances applied to a particular project.

Plugins can be specified using either an id or type. The id of a plugin is specified using a META-INF/gradle-plugins/${id}.properties classpath resource.

## Functions

add
Link copied to clipboard
abstract fun add(plugin: 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>)
all
Link copied to clipboard
abstract fun all(action: Action<in T>)
apply
Link copied to clipboard
abstract fun <T : Plugin?> apply(type: Class<T>): T
Applies a plugin to the project.
abstract fun apply(id: String): Plugin
Has the same behavior as apply except that the plugin is specified via its id.
apply
Link copied to clipboard
inline fun <T : Plugin<*>> PluginContainer.apply(type: KClass<T>): T

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.plugins.PluginContainer.apply.

clear
Link copied to clipboard
abstract fun clear()
configureEach
Link copied to clipboard
abstract fun configureEach(action: Action<in T>)
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(p: Collection<out E>): Set<E>
equals
Link copied to clipboard
abstract fun equals(p: Any): Boolean
findAll
Link copied to clipboard
abstract fun findAll(spec: Closure): Collection<T>
abstract fun findAll(spec: Closure): Set<T>
findPlugin
Link copied to clipboard
@Nullable
abstract fun <T : Plugin?> findPlugin(type: Class<T>): @Nullable T
Returns the plugin for the given type.
@Nullable
abstract fun findPlugin(id: String): @Nullable Plugin
Returns the plugin for the given id.
findPlugin
Link copied to clipboard
inline fun <T : Plugin<*>> PluginContainer.findPlugin(type: KClass<T>): T?

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.plugins.PluginContainer.findPlugin.

forEach
Link copied to clipboard
open fun forEach(p: Consumer<in T>)
getAt
Link copied to clipboard
abstract fun <T : Plugin?> getAt(type: Class<T>): T
Returns a plugin with the specified type if this plugin has been used in the project.
abstract fun getAt(id: String): Plugin
Returns a plugin with the specified id if this plugin has been used in the project.
getAt
Link copied to clipboard
inline fun <T : Plugin<*>> PluginContainer.getAt(type: KClass<T>): T

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.plugins.PluginContainer.getAt.

getPlugin
Link copied to clipboard
abstract fun <T : Plugin?> getPlugin(type: Class<T>): T
Returns a plugin with the specified type if this plugin has been used in the project.
abstract fun getPlugin(id: String): Plugin
Returns a plugin with the specified id if this plugin has been used in the project.
getPlugin
Link copied to clipboard
inline fun <T : Plugin<*>> PluginContainer.getPlugin(type: KClass<T>): T

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.plugins.PluginContainer.getPlugin.

hashCode
Link copied to clipboard
abstract fun hashCode(): Int
hasPlugin
Link copied to clipboard
abstract fun hasPlugin(type: Class<out Plugin>): Boolean
Returns true if the container has a plugin with the given type, false otherwise.
abstract fun hasPlugin(id: String): Boolean
Returns true if the container has a plugin with the given id, false otherwise.
hasPlugin
Link copied to clipboard
inline fun PluginContainer.hasPlugin(type: KClass<out Plugin<*>>): Boolean

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.plugins.PluginContainer.hasPlugin.

isEmpty
Link copied to clipboard
abstract fun isEmpty(): Boolean
iterator
Link copied to clipboard
abstract fun iterator(): Iterator<T>
abstract fun iterator(): Iterator<E>
matching
Link copied to clipboard
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>): PluginCollection<T>
of
Link copied to clipboard
open fun <E> of(): Set<E>
parallelStream
Link copied to clipboard
open fun parallelStream(): Stream<E>
remove
Link copied to clipboard
abstract fun remove(o: Any): Boolean
removeAll
Link copied to clipboard
abstract fun removeAll(c: Collection<out Any>): Boolean
removeIf
Link copied to clipboard
open fun removeIf(p: Predicate<in E>): Boolean
retainAll
Link copied to clipboard
abstract fun retainAll(p: Collection<out Any>): Boolean
size
Link copied to clipboard
abstract fun size(): Int
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>
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<in T>): Action<in T>
whenObjectRemoved
Link copied to clipboard
abstract fun whenObjectRemoved(action: Closure)
abstract fun whenObjectRemoved(action: Action<in T>): Action<in T>
whenPluginAdded
Link copied to clipboard
abstract fun whenPluginAdded(closure: Closure)
abstract fun whenPluginAdded(action: Action<in T>): Action<in T>
withId
Link copied to clipboard
abstract fun withId(pluginId: String, action: Action<in Plugin>)
Executes or registers an action for a plugin with given id.
withType
Link copied to clipboard
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>): PluginCollection<S>
withType
Link copied to clipboard
inline fun <S : Any> DomainObjectCollection<in S>.withType(): <Error class: unknown class>

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 : Plugin<*>> PluginCollection<T>.withType(type: KClass<S>): PluginCollection<S>

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