Table of Contents
| API Documentation: | Task |
|---|
A Task represents a single atomic piece of work for a build, such as compiling classes or generating
javadoc.
Each task belongs to a Project. You can use the various methods on TaskContainer to create and lookup task instances. For example, TaskContainer.create(java.lang.String) creates an empty task with the given name. You can also use the
task keyword in your build file:
task myTask
task myTask { configure closure }
task myTask(type: SomeType)
task myTask(type: SomeType) { configure closure }
Each task has a name, which can be used to refer to the task within its owning project, and a fully qualified
path, which is unique across all tasks in all projects. The path is the concatenation of the owning project's path
and the task's name. Path elements are separated using the :
character.
A Task is made up of a sequence of Action objects. When the task is executed, each of the
actions is executed in turn, by calling Action.execute(T). You can add actions to a task by calling Task.doFirst(org.gradle.api.Action) or Task.doLast(org.gradle.api.Action).
Groovy closures can also be used to provide a task action. When the action is executed, the closure is called with
the task as parameter. You can add action closures to a task by calling Task.doFirst(groovy.lang.Closure) or
Task.doLast(groovy.lang.Closure).
There are 2 special exceptions which a task action can throw to abort execution and continue without failing the
build. A task action can abort execution of the action and continue to the next action of the task by throwing a
StopActionException. A task action can abort execution of the task and continue to the
next task by throwing a StopExecutionException. Using these exceptions allows you to
have precondition actions which skip execution of the task, or part of the task, if not true.
A task may have dependencies on other tasks or might be scheduled to always run after another task. Gradle ensures that all task dependencies and ordering rules are honored when executing tasks, so that the task is executed after all of its dependencies and any "must run after" tasks have been executed.
Dependencies to a task are controlled using Task.dependsOn(java.lang.Object[]) or Task.setDependsOn(java.lang.Iterable),
and Task.mustRunAfter(java.lang.Object[]), Task.setMustRunAfter(java.lang.Iterable), Task.shouldRunAfter(java.lang.Object[]) and
Task.setShouldRunAfter(java.lang.Iterable) are used to specify ordering between tasks. You can use objects of any of
the following types to specify dependencies and ordering:
- A
String,CharSequenceorgroovy.lang.GStringtask path or name. A relative path is interpreted relative to the task'sProject. This allows you to refer to tasks in other projects. - A
Task. - A closure. The closure may take a
Taskas parameter. It may return any of the types listed here. Its return value is recursively converted to tasks. Anullreturn value is treated as an empty collection. - A
TaskDependencyobject. - A
TaskReferenceobject. - A
Buildableobject. - A
RegularFilePropertyorDirectoryProperty. - A
Providerobject. May contain any of the types listed here. - A
Iterable,Collection,Mapor array. May contain any of the types listed here. The elements of the iterable/collection/map/array are recursively converted to tasks. - A
Callable. Thecall()method may return any of the types listed here. Its return value is recursively converted to tasks. Anullreturn value is treated as an empty collection. - Anything else is treated as a failure.
A Task has 4 'scopes' for properties. You can access these properties by name from the build file or by
calling the Task.property(java.lang.String) method. You can change the value of these properties by calling the Task.setProperty(java.lang.String, java.lang.Object) method.
- The
Taskobject itself. This includes any property getters and setters declared by theTaskimplementation class. The properties of this scope are readable or writable based on the presence of the corresponding getter and setter methods. - The extensions added to the task by plugins. Each extension is available as a read-only property with the same name as the extension.
- The convention properties added to the task by plugins. A plugin can add properties and methods to a task through
the task's
Conventionobject. The properties of this scope may be readable or writable, depending on the convention objects. - The extra properties of the task. Each task object maintains a map of additional properties. These are arbitrary name -> value pairs which you can use to dynamically add properties to a task object. Once defined, the properties of this scope are readable and writable.
A Plugin may add methods to a Task using its Convention object.
By default, tasks are not executed in parallel unless a task is waiting on asynchronous work and another task (which
is not dependent) is ready to execute.
Parallel execution can be enabled by the --parallel flag when the build is initiated.
In parallel mode, the tasks of different projects (i.e. in a multi project build) are able to be executed in parallel.
| Property | Description |
actions | The sequence of |
ant | The |
convention | The |
dependsOn | The dependencies of this task. |
description | The description of this task. |
destroyables | The destroyables of this task. |
didWork | Checks if the task actually did any work. Even if a Task executes, it may determine that it has nothing to do. For example, a compilation task may determine that source files have not changed since the last time a the task was run. |
enabled | Returns if this task is enabled or not. |
extensions | The container of extensions. |
finalizedBy | Returns tasks that finalize this task. |
group | The task group which this task belongs to. The task group is used in reports and user interfaces to group related tasks together when presenting a list of tasks to the user. |
inputs | The inputs of this task. |
localState | The local state of this task. |
logger | The logger for this task. You can use this in your build file to write log messages. |
logging | The |
mustRunAfter | Returns tasks that this task must run after. |
name | The name of this task. The name uniquely identifies the task within its |
outputs | The outputs of this task. |
path | The path of the task, which is a fully qualified name for the task. The path of a task is the path of
its |
project | The |
state | The execution state of this task. This provides information about the execution of this task, such as whether it has executed, been skipped, has failed, etc. |
taskDependencies | Returns a |
temporaryDir | Returns a directory which this task can use to write temporary files to. Each task instance is provided with a separate temporary directory. There are no guarantees that the contents of this directory will be kept beyond the execution of the task. |
| Method | Description |
dependsOn(paths) | Adds the given dependencies to this task. See here for a description of the types of objects which can be used as task dependencies. |
doFirst(action) | Adds the given closure to the beginning of this task's action list. The closure is passed this task as a parameter when executed. |
doFirst(actionName, action) | Incubating Adds the given |
doFirst(action) | Adds the given |
doLast(action) | Adds the given closure to the end of this task's action list. The closure is passed this task as a parameter when executed. |
doLast(actionName, action) | Incubating Adds the given |
doLast(action) | Adds the given |
finalizedBy(paths) | Adds the given finalizer tasks for this task. |
hasProperty(propertyName) | Determines if this task has the given property. See here for details of the properties which are available for a task. |
mustRunAfter(paths) | Specifies that this task must run after all of the supplied tasks. |
onlyIf(onlyIfClosure) | Execute the task only if the given closure returns true. The closure will be evaluated at task execution time, not during configuration. The closure will be passed a single parameter, this task. If the closure returns false, the task will be skipped. |
onlyIf(onlyIfSpec) | Execute the task only if the given spec is satisfied. The spec will be evaluated at task execution time, not during configuration. If the Spec is not satisfied, the task will be skipped. |
property(propertyName) | Returns the value of the given property of this task. This method locates a property as follows: |
setProperty(name, value) | Sets a property of this task. This method searches for a property with the given name in the following locations, and sets the property on the first location where it finds the property. |
The sequence of Action objects which will be executed by this task, in the order of
execution.
The AntBuilder for this task. You can use this in your build file to execute ant
tasks.
The Convention object for this task. A Plugin can use the convention object to
contribute properties and methods to this task.
The description of this task.
The destroyables of this task.
Checks if the task actually did any work. Even if a Task executes, it may determine that it has nothing to do. For example, a compilation task may determine that source files have not changed since the last time a the task was run.
The container of extensions.
Returns tasks that finalize this task.
The task group which this task belongs to. The task group is used in reports and user interfaces to group related tasks together when presenting a list of tasks to the user.
The inputs of this task.
The local state of this task.
The logger for this task. You can use this in your build file to write log messages.
The LoggingManager which can be used to receive logging and to control the
standard output/error capture for this task. By default, System.out is redirected to the Gradle logging system at
the QUIET log level, and System.err is redirected at the ERROR log level.
Returns tasks that this task must run after.
The name of this task. The name uniquely identifies the task within its Project.
The outputs of this task.
The path of the task, which is a fully qualified name for the task. The path of a task is the path of
its Project plus the name of the task, separated by :.
The execution state of this task. This provides information about the execution of this task, such as whether it has executed, been skipped, has failed, etc.
Returns a TaskDependency which contains all the tasks that this task depends on.
Returns a directory which this task can use to write temporary files to. Each task instance is provided with a separate temporary directory. There are no guarantees that the contents of this directory will be kept beyond the execution of the task.
Adds the given dependencies to this task. See here for a description of the types of objects which can be used as task dependencies.
Adds the given closure to the beginning of this task's action list. The closure is passed this task as a parameter when executed.
Note: This method is incubating and may change in a future version of Gradle.
Adds the given Action to the beginning of this task's action list.
Adds the given Action to the beginning of this task's action list.
Adds the given closure to the end of this task's action list. The closure is passed this task as a parameter when executed.
Note: This method is incubating and may change in a future version of Gradle.
Adds the given Action to the end of this task's action list.
Adds the given Action to the end of this task's action list.
Adds the given finalizer tasks for this task.
task taskY {
finalizedBy "taskX"
}
See here for a description of the types of objects which can be used to specify a finalizer task.
Determines if this task has the given property. See here for details of the properties which are available for a task.
Specifies that this task must run after all of the supplied tasks.
task taskY {
mustRunAfter "taskX"
}
For each supplied task, this action adds a task 'ordering', and does not specify a 'dependency' between the tasks. As such, it is still possible to execute 'taskY' without first executing the 'taskX' in the example.
See here for a description of the types of objects which can be used to specify an ordering relationship.
Execute the task only if the given closure returns true. The closure will be evaluated at task execution time, not during configuration. The closure will be passed a single parameter, this task. If the closure returns false, the task will be skipped.
You may add multiple such predicates. The task is skipped if any of the predicates return false.
Typical usage:myTask.onlyIf { isProductionEnvironment() }
Execute the task only if the given spec is satisfied. The spec will be evaluated at task execution time, not during configuration. If the Spec is not satisfied, the task will be skipped.
You may add multiple such predicates. The task is skipped if any of the predicates return false.
Typical usage (from Java):
myTask.onlyIf(new Spec<Task>() { boolean isSatisfiedBy(Task task) { return isProductionEnvironment(); } });
Returns the value of the given property of this task. This method locates a property as follows:
- If this task object has a property with the given name, return the value of the property.
- If this task has an extension with the given name, return the extension.
- If this task's convention object has a property with the given name, return the value of the property.
- If this task has an extra property with the given name, return the value of the property.
- If not found, throw
MissingPropertyException
Sets a property of this task. This method searches for a property with the given name in the following locations, and sets the property on the first location where it finds the property.
- The task object itself. For example, the
enabledproject property. - The task's convention object.
- The task's extra properties.
If the property is not found, a MissingPropertyException is thrown.