Interface TaskCollection<T extends Task>
- Type Parameters:
T- The type of tasks which this collection contains.
- All Superinterfaces:
Collection<T>,DomainObjectCollection<T>,DomainObjectSet<T>,Iterable<T>,NamedDomainObjectCollection<T>,NamedDomainObjectSet<T>,Set<T>
- All Known Subinterfaces:
TaskContainer
TaskCollection contains a set of Task instances, and provides a number of query methods.-
Method Summary
Modifier and TypeMethodDescriptionLocates an object by name, failing if there is no such object.Locates an object by name, failing if there is no such object.Locates an object by name, failing if there is no such object.Returns a collection which contains the objects in this collection which meet the given closure specification.Returns a collection which contains the objects in this collection which meet the given specification.Locates a task by name, without triggering its creation or configuration, failing if there is no such object.<S extends T>
TaskProvider<S> Locates a object by name and type, failing if there is no such object.<S extends T>
TaskProvider<S> Locates a object by name and type, failing if there is no such object.Locates a object by name, failing if there is no such object.Returns a collection containing the objects with names matching the provided filter.voidwhenTaskAdded(Closure closure) Adds a closure to be called when a task is added to this collection.whenTaskAdded(Action<? super T> action) Adds anActionto be executed when a task is added to this collection.<S extends T>
TaskCollection<S> Returns a collection containing the objects in this collection of the given type.Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArrayMethods inherited from interface org.gradle.api.DomainObjectCollection
addAllLater, addLater, all, all, configureEach, whenObjectAdded, whenObjectAdded, whenObjectRemoved, whenObjectRemoved, withType, withTypeMethods inherited from interface org.gradle.api.NamedDomainObjectCollection
add, addAll, addRule, addRule, addRule, findByName, getAsMap, getByName, getCollectionSchema, getNamer, getNames, getRulesMethods inherited from interface org.gradle.api.NamedDomainObjectSet
findAll
-
Method Details
-
named
Returns a collection containing the objects with names matching the provided filter. 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 operation. It does not change the realized/unrealized state of the elements in the collection.
- Specified by:
namedin interfaceNamedDomainObjectCollection<T extends Task>- Specified by:
namedin interfaceNamedDomainObjectSet<T extends Task>- Parameters:
nameFilter- The specification to test names against.- Returns:
- The collection of objects with names satisfying the filter. Returns an empty collection if there are no such objects in this collection.
-
matching
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:
matchingin interfaceDomainObjectCollection<T extends Task>- Specified by:
matchingin interfaceDomainObjectSet<T extends Task>- Specified by:
matchingin interfaceNamedDomainObjectCollection<T extends Task>- Specified by:
matchingin interfaceNamedDomainObjectSet<T extends Task>- 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
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:
matchingin interfaceDomainObjectCollection<T extends Task>- Specified by:
matchingin interfaceDomainObjectSet<T extends Task>- Specified by:
matchingin interfaceNamedDomainObjectCollection<T extends Task>- Specified by:
matchingin interfaceNamedDomainObjectSet<T extends Task>- 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.
-
getByName
Locates an object by name, failing if there is no such object. The given configure closure is executed against the object before it is returned from this method. The object is passed to the closure as its delegate.This operation is eager and will cause the returned element to be realized.
- Specified by:
getByNamein interfaceNamedDomainObjectCollection<T extends Task>- Parameters:
name- The object nameconfigureClosure- The closure to use to configure the object.- Returns:
- The object with the given name, after the configure closure has been applied to it. Never returns null.
- Throws:
UnknownTaskException
-
getByName
Locates an object by name, failing if there is no such object.This operation is eager and will cause the returned element to be realized.
- Specified by:
getByNamein interfaceNamedDomainObjectCollection<T extends Task>- Parameters:
name- The object name- Returns:
- The object with the given name. Never returns null.
- Throws:
UnknownTaskException
-
withType
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:
withTypein interfaceDomainObjectCollection<T extends Task>- Specified by:
withTypein interfaceDomainObjectSet<T extends Task>- Specified by:
withTypein interfaceNamedDomainObjectCollection<T extends Task>- Specified by:
withTypein interfaceNamedDomainObjectSet<T extends Task>- 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.
-
whenTaskAdded
Adds anActionto be executed when a task is added to this collection.Like
DomainObjectCollection.all(Action), this method will cause all tasks in this container to be realized.- Parameters:
action- The action to be executed- Returns:
- the supplied action
-
whenTaskAdded
Adds a closure to be called when a task is added to this collection. The task is passed to the closure as the parameter.- Parameters:
closure- The closure to be called- See Also:
-
getAt
Locates an object by name, failing if there is no such object. This method is identical toNamedDomainObjectCollection.getByName(String). You can call this method in your build script by using the groovy[]operator.This operation is eager and will cause the returned element to be realized.
- Specified by:
getAtin interfaceNamedDomainObjectCollection<T extends Task>- Parameters:
name- The object name- Returns:
- The object with the given name. Never returns null.
- Throws:
UnknownTaskException
-
named
Locates a task by name, without triggering its creation or configuration, failing if there is no such object.- Specified by:
namedin interfaceNamedDomainObjectCollection<T extends Task>- Parameters:
name- The task name- Returns:
- A
Providerthat will return the task when queried. The task may be created and configured at this point, if not already. - Throws:
UnknownTaskException- If a task with the given name is not defined.- Since:
- 4.9
-
named
TaskProvider<T> named(String name, Action<? super T> configurationAction) throws UnknownTaskException Locates a object by name, failing if there is no such object. The given configure action is executed against the object before it is returned from the provider.This method is lazy and will not cause the returned element to be realized.
- Specified by:
namedin interfaceNamedDomainObjectCollection<T extends Task>- Parameters:
name- The object's name- Returns:
- A
Providerthat will return the object when queried. The object may be created and configured at this point, if not already. - Throws:
UnknownTaskException- Since:
- 5.0
-
named
Locates a object by name and type, failing if there is no such object.This method is lazy and will not cause the returned element to be realized.
- Specified by:
namedin interfaceNamedDomainObjectCollection<T extends Task>- Parameters:
name- The object's nametype- The object's type- Returns:
- A
Providerthat will return the object when queried. The object may be created and configured at this point, if not already. - Throws:
UnknownTaskException- Since:
- 5.0
-
named
<S extends T> TaskProvider<S> named(String name, Class<S> type, Action<? super S> configurationAction) throws UnknownTaskException Locates a object by name and type, failing if there is no such object. The given configure action is executed against the object before it is returned from the provider.This method is lazy and will not cause the returned element to be realized.
- Specified by:
namedin interfaceNamedDomainObjectCollection<T extends Task>- Parameters:
name- The object's nametype- The object's typeconfigurationAction- The action to use to configure the object.- Returns:
- A
Providerthat will return the object when queried. The object may be created and configured at this point, if not already. - Throws:
UnknownTaskException- Since:
- 5.0
-