Interface TaskContainer
- All Superinterfaces:
Collection<Task>,Configurable<NamedDomainObjectContainer<Task>>,DomainObjectCollection<Task>,DomainObjectSet<Task>,Iterable<Task>,NamedDomainObjectCollection<Task>,NamedDomainObjectContainer<Task>,NamedDomainObjectSet<Task>,PolymorphicDomainObjectContainer<Task>,Set<Task>,TaskCollection<Task>
A TaskContainer is responsible for managing a set of Task instances.
You can obtain a TaskContainer instance by calling Project.getTasks(), or using the
tasks property in your build script.
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Deprecated.Useregister(String, Action)instead.<T extends Task>
TDeprecated.Useregister(String, Class)instead.<T extends Task>
TDeprecated.Useregister(String, Class, Object...)instead.<T extends Task>
TDeprecated.Useregister(String, Class, Action)instead.Deprecated.Useregister(String, Action)instead.Deprecated.Useregister(String, Action)orregister(String, Class, Action)instead.Deprecated.Useregister(String, Action)instead.findByPath(String path) Locates a task by path.Locates a task by path.Defines a new task, which will be created when it is required.<T extends Task>
TaskProvider<T>Defines a new task, which will be created when it is required.<T extends Task>
TaskProvider<T>Defines a new task, which will be created when it is required passing the given arguments to the@Inject-annotated constructor.<T extends Task>
TaskProvider<T>Defines a new task, which will be created and configured when it is required.Defines a new task, which will be created and configured when it is required.Creates aTaskwith the given name and adds it to this container, replacing any existing task with the same name.<T extends Task>
TCreates aTaskwith the given name and type, and adds it to this container, replacing any existing task of the same name.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.NamedDomainObjectContainer
configure, maybeCreateMethods inherited from interface org.gradle.api.NamedDomainObjectSet
findAllMethods inherited from interface org.gradle.api.PolymorphicDomainObjectContainer
containerWithType, maybeCreateMethods inherited from interface java.util.Set
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArrayMethods inherited from interface org.gradle.api.tasks.TaskCollection
getAt, getByName, getByName, matching, matching, named, named, named, named, named, whenTaskAdded, whenTaskAdded, withType
-
Method Details
-
findByPath
Locates a task by path. You can supply a task name, a relative path, or an absolute path. Relative paths are interpreted relative to the project for this container. This method returns null if no task with the given path exists.
- Parameters:
path- the path of the task to be returned- Returns:
- The task. Returns null if so such task exists.
-
getByPath
Locates a task by path. You can supply a task name, a relative path, or an absolute path. Relative paths are interpreted relative to the project for this container. This method throws an exception if no task with the given path exists.
- Parameters:
path- the path of the task to be returned- Returns:
- The task. Never returns null
- Throws:
UnknownTaskException- If no task with the given path exists.
-
create
Deprecated.Useregister(String, Action)orregister(String, Class, Action)instead. See documentation for more information.Creates a
Taskand adds it to this container. A map of creation options can be passed to this method to control how the task is created. The following options are available:Permitted map keys Option Description Default Value "name"The name of the task to create. None. Must be specified. "type"The class of the task to create. DefaultTask"action"The closure or Actionto execute when the task executes. SeeTask.doFirst(Action).null"overwrite"Replace an existing task? false"dependsOn"The dependencies of the task. See here for more details. []"group"The group of the task. null"description"The description of the task. null"constructorArgs"The arguments to pass to the task class constructor. nullAfter the task is added, it is made available as a property of the project, so that you can reference the task by name in your build file.
If a task with the given name already exists in this container and the
"overwrite"option is not set to true, an exception is thrown.- Parameters:
options- The task creation options.- Returns:
- The newly created task object
- Throws:
InvalidUserDataException- If a task with the given name already exists in this project.NullPointerException- If any of the values in"constructorArgs"is null.- See Also:
-
create
@Deprecated Task create(Map<String, ?> options, Closure configureClosure) throws InvalidUserDataExceptionDeprecated.Useregister(String, Action)instead. See documentation for more information.Creates a
Taskadds it to this container. A map of creation options can be passed to this method to control how the task is created. Seecreate(java.util.Map)for the list of options available. The given closure is used to configure the task before it is returned by this method.After the task is added, it is made available as a property of the project, so that you can reference the task by name in your build file.
- Parameters:
options- The task creation options.configureClosure- The closure to use to configure the task.- Returns:
- The newly created task object
- Throws:
InvalidUserDataException- If a task with the given name already exists in this project.- See Also:
-
create
Deprecated.Useregister(String, Action)instead. See documentation for more information.Creates a
Taskwith the given name adds it to this container. The given closure is used to configure the task before it is returned by this method.After the task is added, it is made available as a property of the project, so that you can reference the task by name in your build file.
- Specified by:
createin interfaceNamedDomainObjectContainer<Task>- Parameters:
name- The name of the task to be createdconfigureClosure- The closure to use to configure the task.- Returns:
- The newly created task object
- Throws:
InvalidUserDataException- If a task with the given name already exists in this project.- See Also:
-
create
Deprecated.Useregister(String)instead. See documentation for more information.Creates a
Taskwith the given name and adds it to this container.After the task is added, it is made available as a property of the project, so that you can reference the task by name in your build file.
- Specified by:
createin interfaceNamedDomainObjectContainer<Task>- Parameters:
name- The name of the task to be created- Returns:
- The newly created task object
- Throws:
InvalidUserDataException- If a task with the given name already exists in this project.- See Also:
-
create
Deprecated.Useregister(String, Class)instead. See documentation for more information.Creates a
Taskwith the given name and type, and adds it to this container.After the task is added, it is made available as a property of the project, so that you can reference the task by name in your build file.
- Specified by:
createin interfacePolymorphicDomainObjectContainer<Task>- Type Parameters:
T- the type of the domain object to be created- Parameters:
name- The name of the task to be created.type- The type of task to create.- Returns:
- The newly created task object
- Throws:
InvalidUserDataException- If a task with the given name already exists in this project.- See Also:
-
create
@Deprecated <T extends Task> T create(String name, Class<T> type, Object... constructorArgs) throws InvalidUserDataException Deprecated.Useregister(String, Class, Object...)instead. See documentation for more information.Creates a
Taskwith the given name and type, passing the given arguments to the@Inject-annotated constructor, and adds it to this container. All values passed to the task constructor must be non-null; otherwise aNullPointerExceptionwill be thrownAfter the task is added, it is made available as a property of the project, so that you can reference the task by name in your build file.
- Parameters:
name- The name of the task to be created.type- The type of task to create.constructorArgs- The arguments to pass to the task constructor- Returns:
- The newly created task object
- Throws:
InvalidUserDataException- If a task with the given name already exists in this project.NullPointerException- If any of the values inconstructorArgsis null.- Since:
- 4.7
- See Also:
-
create
@Deprecated <T extends Task> T create(String name, Class<T> type, Action<? super T> configuration) throws InvalidUserDataException Deprecated.Useregister(String, Class, Action)instead. See documentation for more information.Creates a
Taskwith the given name and type, configures it with the given action, and adds it to this container.After the task is added, it is made available as a property of the project, so that you can reference the task by name in your build file.
- Specified by:
createin interfacePolymorphicDomainObjectContainer<Task>- Type Parameters:
T- the type of the domain object to be created- Parameters:
name- The name of the task to be created.type- The type of task to create.configuration- The action to configure the task with.- Returns:
- The newly created task object.
- Throws:
InvalidUserDataException- If a task with the given name already exists in this project.- See Also:
-
create
@Deprecated Task create(String name, Action<? super Task> configuration) throws InvalidUserDataException Deprecated.Useregister(String, Action)instead. See documentation for more information.Creates a
Taskwith the given name and of typeDefaultTask, configures it with the given action, and adds it to this container.After the task is added, it is made available as a property of the project, so that you can reference the task by name in your build file.
- Specified by:
createin interfaceNamedDomainObjectContainer<Task>- Parameters:
name- The name of the task to be created.configuration- The action to configure the task with.- Returns:
- The newly created task object.
- Throws:
InvalidUserDataException- If a task with the given name already exists in this project.- See Also:
-
register
TaskProvider<Task> register(String name, Action<? super Task> configurationAction) throws InvalidUserDataException Defines a new task, which will be created and configured when it is required. A task is 'required' when the task is located using query methods such asTaskCollection.getByName(java.lang.String), when the task is added to the task graph for execution or whenProvider.get()is called on the return value of this method.It is generally more efficient to use this method instead of
NamedDomainObjectContainer.create(java.lang.String, org.gradle.api.Action)orcreate(java.lang.String), as those methods will eagerly create and configure the task, regardless of whether that task is required for the current build or not. This method, on the other hand, will defer creation and configuration until required.- Specified by:
registerin interfaceNamedDomainObjectContainer<Task>- Parameters:
name- The name of the task.configurationAction- The action to run to configure the task. This action runs when the task is required.- Returns:
- A
Providerwhose value will be the task, when queried. - Throws:
InvalidUserDataException- If a task with the given name already exists in this project.- Since:
- 4.9
-
register
<T extends Task> TaskProvider<T> register(String name, Class<T> type, Action<? super T> configurationAction) throws InvalidUserDataException Defines a new task, which will be created and configured when it is required. A task is 'required' when the task is located using query methods such asTaskCollection.getByName(java.lang.String), when the task is added to the task graph for execution or whenProvider.get()is called on the return value of this method.It is generally more efficient to use this method instead of
create(java.lang.String, java.lang.Class, org.gradle.api.Action)orcreate(java.lang.String, java.lang.Class), as those methods will eagerly create and configure the task, regardless of whether that task is required for the current build or not. This method, on the other hand, will defer creation and configuration until required.- Specified by:
registerin interfacePolymorphicDomainObjectContainer<Task>- Type Parameters:
T- The task type- Parameters:
name- The name of the task.type- The task type.configurationAction- The action to run to configure the task. This action runs when the task is required.- Returns:
- A
Providerwhose value will be the task, when queried. - Throws:
InvalidUserDataException- If a task with the given name already exists in this project.- Since:
- 4.9
-
register
<T extends Task> TaskProvider<T> register(String name, Class<T> type) throws InvalidUserDataException Defines a new task, which will be created when it is required. A task is 'required' when the task is located using query methods such asTaskCollection.getByName(java.lang.String), when the task is added to the task graph for execution or whenProvider.get()is called on the return value of this method.It is generally more efficient to use this method instead of
create(java.lang.String, java.lang.Class, org.gradle.api.Action)orcreate(java.lang.String, java.lang.Class), as those methods will eagerly create and configure the task, regardless of whether that task is required for the current build or not. This method, on the other hand, will defer creation until required.- Specified by:
registerin interfacePolymorphicDomainObjectContainer<Task>- Type Parameters:
T- The task type- Parameters:
name- The name of the task.type- The task type.- Returns:
- A
Providerwhose value will be the task, when queried. - Throws:
InvalidUserDataException- If a task with the given name already exists in this project.- Since:
- 4.9
-
register
<T extends Task> TaskProvider<T> register(String name, Class<T> type, Object... constructorArgs) throws InvalidUserDataException Defines a new task, which will be created when it is required passing the given arguments to the@Inject-annotated constructor. A task is 'required' when the task is located using query methods such asTaskCollection.getByName(java.lang.String), when the task is added to the task graph for execution or whenProvider.get()is called on the return value of this method. All values passed to the task constructor must be non-null; otherwise aNullPointerExceptionwill be thrownIt is generally more efficient to use this method instead of
create(java.lang.String, java.lang.Class, org.gradle.api.Action)orcreate(java.lang.String, java.lang.Class), as those methods will eagerly create and configure the task, regardless of whether that task is required for the current build or not. This method, on the other hand, will defer creation until required.- Type Parameters:
T- The task type- Parameters:
name- The name of the task.type- The task type.constructorArgs- The arguments to pass to the task constructor- Returns:
- A
Providerwhose value will be the task, when queried. - Throws:
NullPointerException- If any of the values inconstructorArgsis null.InvalidUserDataException- Since:
- 4.9
-
register
Defines a new task, which will be created when it is required. A task is 'required' when the task is located using query methods such asTaskCollection.getByName(java.lang.String), when the task is added to the task graph for execution or whenProvider.get()is called on the return value of this method.It is generally more efficient to use this method instead of
create(java.lang.String), as that method will eagerly create the task, regardless of whether that task is required for the current build or not. This method, on the other hand, will defer creation until required.- Specified by:
registerin interfaceNamedDomainObjectContainer<Task>- Parameters:
name- The name of the task.- Returns:
- A
Providerwhose value will be the task, when queried. - Throws:
InvalidUserDataException- If a task with the given name already exists in this project.- Since:
- 4.9
-
replace
Creates a
Taskwith the given name and adds it to this container, replacing any existing task with the same name.After the task is added, it is made available as a property of the project, so that you can reference the task by name in your build file.
- Parameters:
name- The name of the task to be created- Returns:
- The newly created task object
- See Also:
-
replace
Creates a
Taskwith the given name and type, and adds it to this container, replacing any existing task of the same name.After the task is added, it is made available as a property of the project, so that you can reference the task by name in your build file.
- Parameters:
name- The name of the task to be created.type- The type of task to create.- Returns:
- The newly created task object
- See Also:
-
register(String)instead.