PluginContainer

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

Link copied to clipboard
abstract fun add(plugin: T): Boolean
Link copied to clipboard
abstract fun addAll(c: Collection<out T>): Boolean
Link copied to clipboard
abstract fun addAllLater(provider: Provider<out Iterable<T>>)
Link copied to clipboard
abstract fun addLater(provider: Provider<out T>)
Link copied to clipboard
abstract fun all(action: Action<in T>)
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.
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.

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

Link copied to clipboard
open fun forEach(action: Consumer<in T>)
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.
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.

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

Link copied to clipboard
abstract fun hashCode(): Int
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.
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.

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

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>, 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.