Package org.gradle.api.plugins

Interface PluginCollection<T extends Plugin>

Type Parameters:

T - The type of plugins which this collection contains.

All Superinterfaces:

Collection<T>, DomainObjectCollection<T>, DomainObjectSet<T>, Iterable<T>, Set<T>

All Known Subinterfaces:

PluginContainer

public interface PluginCollection<T extends Plugin>
extends DomainObjectSet<T>

A PluginCollection represents a collection of Plugin instances.

Method Summary

Modifier and Type	Method	Description
boolean	add(T plugin)	Deprecated. Use PluginManager.apply(Class) instead.
boolean	addAll(Collection<? extends T> c)	Deprecated. Use PluginManager.apply(Class) instead.
void	clear()	Deprecated. plugins cannot be removed.
PluginCollection<T>	matching(Closure closure)	Returns a collection which contains the objects in this collection which meet the given closure specification.
PluginCollection<T>	matching(Spec<? super T> spec)	Returns a collection which contains the objects in this collection which meet the given specification.
boolean	remove(Object o)	Deprecated. plugins cannot be removed.
boolean	removeAll(Collection<?> c)	Deprecated. plugins cannot be removed.
void	whenPluginAdded(Closure closure)	Adds a closure to be called when a plugin is added to this collection.
Action<? super T>	whenPluginAdded(Action<? super T> action)	Adds an Action to be executed when a plugin is added to this collection.
<S extends T> PluginCollection<S>	withType(Class<S> type)	Returns a collection containing the objects in this collection of the given type.

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface org.gradle.api.DomainObjectCollection

addAllLater, addLater, all, all, configureEach, whenObjectAdded, whenObjectAdded, whenObjectRemoved, whenObjectRemoved, withType, withType

Methods inherited from interface org.gradle.api.DomainObjectSet

findAll

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

contains, containsAll, equals, hashCode, isEmpty, iterator, retainAll, size, spliterator, toArray, toArray

Method Details

matching

PluginCollection<T> matching(Spec<? super T> spec)

Returns a collection which contains the objects in this collection which meet the given specification. The returned collection is live, so that when matching objects are added to this collection, they are also visible in the filtered collection.

This method is an intermediate eager operation. The application of the filter forces the realization of the collection elements.

Specified by:

matching in interface DomainObjectCollection<T extends Plugin>

Specified by:

matching in interface DomainObjectSet<T extends Plugin>

Parameters:

spec - The specification to use.

Returns:

The collection of matching objects. Returns an empty collection if there are no such objects in this collection.

matching

PluginCollection<T> matching(Closure closure)

Returns a collection which contains the objects in this collection which meet the given closure specification. The returned collection is live, so that when matching objects are added to this collection, they are also visible in the filtered collection.

This method is an intermediate eager operation. The application of the filter forces the realization of the collection elements.

Specified by:

matching in interface DomainObjectCollection<T extends Plugin>

Specified by:

matching in interface DomainObjectSet<T extends Plugin>

Parameters:

closure - The specification to use. The closure gets a collection element as an argument.

Returns:

The collection of matching objects. Returns an empty collection if there are no such objects in this collection.

withType

<S extends T> PluginCollection<S> withType(Class<S> type)

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.

This method is an intermediate operation. It does not change the realized/unrealized state of the elements in the collection.

Specified by:

withType in interface DomainObjectCollection<T extends Plugin>

Specified by:

withType in interface DomainObjectSet<T extends Plugin>

Parameters:

type - The type of objects to find.

Returns:

The matching objects. Returns an empty collection if there are no such objects in this collection.

whenPluginAdded

Action<? super T> whenPluginAdded(Action<? super T> action)

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

Parameters:

action - The action to be executed

Returns:

the supplied action

whenPluginAdded

void whenPluginAdded(Closure closure)

Adds a closure to be called when a plugin is added to this collection. The plugin is passed to the closure as the parameter.

Parameters:

closure - The closure to be called

add

@Deprecated
boolean add(T plugin)

Deprecated.

Use PluginManager.apply(Class) instead.

Unsupported.

Specified by:

add in interface Collection<T extends Plugin>

Specified by:

add in interface Set<T extends Plugin>

addAll

@Deprecated
boolean addAll(Collection<? extends T> c)

Deprecated.

Use PluginManager.apply(Class) instead.

Unsupported.

Specified by:

addAll in interface Collection<T extends Plugin>

Specified by:

addAll in interface Set<T extends Plugin>

remove

@Deprecated
boolean remove(Object o)

Deprecated.

plugins cannot be removed.

Unsupported.

Specified by:

remove in interface Collection<T extends Plugin>

Specified by:

remove in interface Set<T extends Plugin>

removeAll

@Deprecated
boolean removeAll(Collection<?> c)

Deprecated.

plugins cannot be removed.

Unsupported.

Specified by:

removeAll in interface Collection<T extends Plugin>

Specified by:

removeAll in interface Set<T extends Plugin>

clear

@Deprecated
void clear()

Deprecated.

plugins cannot be removed.

Unsupported.

Specified by:

clear in interface Collection<T extends Plugin>

Specified by:

clear in interface Set<T extends Plugin>