Package org.gradle.api.plugins
Interface PluginCollection<T extends Plugin>
-
- Type Parameters:
T- The type of plugins which this collection contains.
- All Superinterfaces:
java.util.Collection<T>,DomainObjectCollection<T>,DomainObjectSet<T>,java.lang.Iterable<T>,java.util.Set<T>
- All Known Subinterfaces:
PluginContainer
public interface PluginCollection<T extends Plugin> extends DomainObjectSet<T>
A
PluginCollectionrepresents a collection ofPlugininstances.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description booleanadd(T plugin)Deprecated.UsePluginManager.apply(Class)instead.booleanaddAll(java.util.Collection<? extends T> c)Deprecated.UsePluginManager.apply(Class)instead.voidclear()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.booleanremove(java.lang.Object o)Deprecated.plugins cannot be removed.booleanremoveAll(java.util.Collection<?> c)Deprecated.plugins cannot be removed.voidwhenPluginAdded(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 anActionto be executed when a plugin is added to this collection.<S extends T>
PluginCollection<S>withType(java.lang.Class<S> type)Returns a collection containing the objects in this collection of the given type.-
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
-
-
-
-
Method Detail
-
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.- Specified by:
matchingin interfaceDomainObjectCollection<T extends Plugin>- Specified by:
matchingin interfaceDomainObjectSet<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.- Specified by:
matchingin interfaceDomainObjectCollection<T extends Plugin>- Specified by:
matchingin interfaceDomainObjectSet<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(java.lang.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.- Specified by:
withTypein interfaceDomainObjectCollection<T extends Plugin>- Specified by:
withTypein interfaceDomainObjectSet<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 anActionto 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.UsePluginManager.apply(Class)instead.Unsupported.
-
addAll
@Deprecated boolean addAll(java.util.Collection<? extends T> c)
Deprecated.UsePluginManager.apply(Class)instead.Unsupported.
-
remove
@Deprecated boolean remove(java.lang.Object o)
Deprecated.plugins cannot be removed.Unsupported.
-
removeAll
@Deprecated boolean removeAll(java.util.Collection<?> c)
Deprecated.plugins cannot be removed.Unsupported.
-
-