gradle/org.gradle.api.plugins/PluginContainer

PluginContainer

interface PluginContainer : PluginCollection<Plugin> (source)

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

abstract fun add(p: E): Boolean

abstract fun ~~add~~(plugin: T): Boolean

Unsupported.

addAll

abstract fun addAll(p: Collection<out E>): Boolean

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

Unsupported.

addAllLater

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

Adds elements to this collection, given a Provider of Iterable that will provide the elements when required.

addLater

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

Adds an element to this collection, given a Provider that will provide the element when required.

all

abstract fun all(action: Closure)

Executes the given closure against all objects in this collection, and any objects subsequently added to this collection.

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

Executes the given action against all objects in this collection, and any objects subsequently added to this collection.

apply

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.

clear

abstract fun clear()

abstract fun ~~clear~~()

Unsupported.

configureEach

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

Configures each element in this collection using the given action, as each element is required.

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>

disallowChanges

@Incubating

open fun disallowChanges()

Disallows further structural modifications to this collection.

equals

abstract fun equals(p: Any): Boolean

findAll

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

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

Returns a collection which contains the objects in this collection which meet the given closure specification.

findPlugin

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

forEach

open fun forEach(action: Consumer<in T>)

getAt

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.

getPlugin

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.

hashCode

abstract fun hashCode(): Int

hasPlugin

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.

isEmpty

abstract fun isEmpty(): Boolean

iterator

abstract fun iterator(): Iterator<T>

abstract fun iterator(): Iterator<E>

matching

abstract fun matching(spec: Closure): DomainObjectCollection<T>

abstract fun matching(spec: Closure): DomainObjectSet<T>

Returns a collection which contains the objects in this collection which meet the given closure specification.

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

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

Returns a collection which contains the objects in this collection which meet the given specification.

abstract fun matching(closure: Closure): PluginCollection<T>

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

open fun <E> of(): Set<E>

parallelStream

open fun parallelStream(): Stream<E>

remove

abstract fun remove(p: Any): Boolean

abstract fun ~~remove~~(o: Any): Boolean

Unsupported.

removeAll

abstract fun removeAll(p: Collection<out Any>): Boolean

abstract fun ~~removeAll~~(c: Collection<out Any>): Boolean

Unsupported.

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)

Adds a closure to be called when an object is added to this collection.

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

Adds an Action to be executed when an object is added to this collection.

whenObjectRemoved

abstract fun whenObjectRemoved(action: Closure)

Adds a closure to be called when an object is removed from this collection.

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

Adds an Action to be executed when an object is removed from this collection.

whenPluginAdded

abstract fun whenPluginAdded(closure: Closure)

Adds a closure to be called when a plugin is added to this collection.

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

Adds an Action to be executed when a plugin is added to this collection.

withId

abstract fun withId(pluginId: String, action: Action<in Plugin>)

Executes or registers an action for a plugin with given id.

withType

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

abstract fun <S : T?> withType(type: Class<S>, @DelegatesTo(genericTypeIndex = 0) configureClosure: Closure): DomainObjectCollection<S>

abstract fun <S : T?> withType(type: Class<S>, configureAction: Action<in S>): DomainObjectCollection<S>

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

Returns a collection containing the objects in this collection of the given type.

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