|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Task
A Task
represents a single step of 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.add(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 myType << { task action } 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 TaskAction
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 doFirst(TaskAction)
or doLast(TaskAction)
.
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 doFirst(groovy.lang.Closure)
or
doLast(groovy.lang.Closure)
or using the left-shift << operator.
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. Gradle ensures that tasks are executed in dependency order, so that
the dependencies of a task are executed before the task is executed. You can add dependencies to a task using dependsOn(Object[])
or setDependsOn(java.util.Set)
. You can add objects of any of the following types as
a depedency:
Project
. This allows
you to refer to tasks in other projects, although the recommended way of establishing cross project dependencies, is
via the Project.dependsOn(String)
method of the task's Project
Task
.Task
as parameter, and should return a Task
or collection of
tasks.TaskDependency
.Collection
or Map
. The collection/map is flattened and its elements added as described
above.A Task
has 3 'scopes' for properties. You can access these properties by name from the build file or by
calling the property(String)
method.
Task
object itself. This includes any property getters and setters declared by the Task
implementation class. The properties of this scope are readable or writable based on the presence of the
corresponding getter and setter methods.Plugin
applied to the project. A Plugin
can add properties and methods to a task through the task's Convention
object. The properties of
this scope may be readable or writable, depending on the convention objects.A Plugin
may add methods to a Task
using its Convention
object.
Field Summary | |
---|---|
static java.lang.String |
AUTOSKIP_PROPERTY_PREFIX
|
static java.lang.String |
TASK_ACTION
|
static java.lang.String |
TASK_DEPENDS_ON
|
static java.lang.String |
TASK_DESCRIPTION
|
static java.lang.String |
TASK_NAME
|
static java.lang.String |
TASK_OVERWRITE
|
static java.lang.String |
TASK_TYPE
|
Method Summary | |
---|---|
Task |
captureStandardOutput(LogLevel level)
Enables redirection of standard output during task execution to the logging system. |
Task |
configure(groovy.lang.Closure configureClosure)
Applies the statements of the closure against this task object. |
Task |
deleteAllActions()
Removes all the actions of this task. |
Task |
dependsOn(java.lang.Object... paths)
Adds the given dependencies to this task. |
boolean |
dependsOnTaskDidWork()
Checks if any of the tasks that this task depends on didWork . |
Task |
disableStandardOutputCapture()
Disables redirection of standard output during task execution. |
Task |
doFirst(groovy.lang.Closure action)
Adds the given closure to the beginning of this task's action list. |
Task |
doFirst(TaskAction action)
Adds the given TaskAction to the beginning of this task's action list. |
Task |
doLast(groovy.lang.Closure action)
Adds the given closure to the end of this task's action list. |
Task |
doLast(TaskAction action)
Adds the given TaskAction to the end of this task's action list. |
java.util.List<TaskAction> |
getActions()
Returns the sequence of TaskAction objects which will be executed by this task, in the order of
execution. |
groovy.util.AntBuilder |
getAnt()
Returns the AntBuilder for this task. |
Convention |
getConvention()
Returns the Convention object for this task. |
java.util.Set<java.lang.Object> |
getDependsOn()
Returns the dependencies of this task. |
java.lang.String |
getDescription()
Returns the description of a task. |
boolean |
getDidWork()
Checks if the task actually did any work. |
boolean |
getEnabled()
Returns if this task is enabled or not. |
boolean |
getExecuted()
Returns true if this task has been executed. |
org.slf4j.Logger |
getLogger()
Returns the logger for this task. |
java.lang.String |
getName()
Returns the name of this task. |
java.lang.String |
getPath()
Returns the path of the task, which is a fully qualified name for the task. |
Project |
getProject()
Returns the Project which this task belongs to. |
java.util.List<java.lang.String> |
getSkipProperties()
Returns the list of skip properties. |
TaskDependency |
getTaskDependencies()
Returns a TaskDependency which contains all the tasks that this task depends on. |
boolean |
hasProperty(java.lang.String propertyName)
Determines if this task has the given property. |
Task |
leftShift(groovy.lang.Closure action)
Adds the given closure to the end of this task's action list. |
void |
onlyIf(groovy.lang.Closure onlyIfClosure)
Execute the task only if the closure returns true. |
void |
onlyIf(Spec<? super Task> onlyIfSpec)
Execute the task only if the spec is satisfied. |
java.lang.Object |
property(java.lang.String propertyName)
Returns the value of the given property of this task. |
void |
setActions(java.util.List<TaskAction> actions)
Sets the sequence of TaskAction objects which will be executed by this task. |
void |
setDependsOn(java.util.Set<?> dependsOnTasks)
Sets the dependencies of this task. |
void |
setDescription(java.lang.String description)
Adds a text to describe what the task does to the user of the build. |
void |
setEnabled(boolean enabled)
Set the enabled state of a task. |
void |
setProperty(java.lang.String name,
java.lang.Object value)
Sets a property of this task. |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Field Detail |
---|
static final java.lang.String TASK_NAME
static final java.lang.String TASK_DESCRIPTION
static final java.lang.String TASK_TYPE
static final java.lang.String TASK_DEPENDS_ON
static final java.lang.String TASK_OVERWRITE
static final java.lang.String TASK_ACTION
static final java.lang.String AUTOSKIP_PROPERTY_PREFIX
Method Detail |
---|
java.lang.String getName()
Project
.
Project getProject()
Returns the Project
which this task belongs to.
java.util.List<TaskAction> getActions()
Returns the sequence of TaskAction
objects which will be executed by this task, in the order of
execution.
void setActions(java.util.List<TaskAction> actions)
Sets the sequence of TaskAction
objects which will be executed by this task.
actions
- The actions.TaskDependency getTaskDependencies()
Returns a TaskDependency
which contains all the tasks that this task depends on.
java.util.Set<java.lang.Object> getDependsOn()
Returns the dependencies of this task.
void setDependsOn(java.util.Set<?> dependsOnTasks)
Sets the dependencies of this task. See here for a description of the types of objects which can be used as task dependencies.
dependsOnTasks
- The set of task paths.Task dependsOn(java.lang.Object... 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.
paths
- The dependencies to add to this task.
void onlyIf(groovy.lang.Closure onlyIfClosure)
Execute the task only if the closure returns true. The closure will be evaluated at the
task execution time, not during configuration. The closure will be passed a single parameter,
this task. The closure will be coerced to a Spec
of type Task
.
If the closure returns false, the task will not execute, but will log a message of 'SKIPPED as onlyIf is false'.
Typical usage:
myTask.onlyIf{ dependsOnTaskDidWork() }
onlyIfClosure
- code to execute to determine if task should be rungetDidWork()
void onlyIf(Spec<? super Task> onlyIfSpec)
Execute the task only if the spec is satisfied. The spec will be evaluated at task execution time, not during configuration.
If the Spec is not satisfied, the task will not execute, but will log a message of 'SKIPPED as onlyIf is false'.
Typical usage (from Java):
myTask.onlyIf(new Spec() { boolean isSatisfiedBy(Task task) { return task.dependsOnTaskDidWork(); } });
onlyIfSpec
- specifies if a task should be rungetDidWork()
boolean getDidWork()
Checks if the task actually did any work. Even if a Task executes, it may determine that it has nothing to do. For example, the Compile task may determine that source files have not changed since the last time a the task was run.
boolean getExecuted()
Returns true if this task has been executed.
java.lang.String getPath()
Returns 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 :
.
Task doFirst(TaskAction action)
Adds the given TaskAction
to the beginning of this task's action list.
action
- The action to add
Task doFirst(groovy.lang.Closure 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.
action
- The action closure to execute.
Task doLast(TaskAction action)
Adds the given TaskAction
to the end of this task's action list.
action
- The action to add.
Task doLast(groovy.lang.Closure 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.
action
- The action closure to execute.
Task leftShift(groovy.lang.Closure 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. You can call this method from your build script using the << left shift operator.
action
- The action closure to execute.
Task deleteAllActions()
Removes all the actions of this task.
boolean getEnabled()
Returns if this task is enabled or not.
setEnabled(boolean)
void setEnabled(boolean enabled)
Set the enabled state of a task. If a task is disabled none of the its actions are executed. Note that disabling a task does not prevent the execution of the tasks which this task depends on.
enabled
- The enabled state of this task (true or false)Task configure(groovy.lang.Closure configureClosure)
Applies the statements of the closure against this task object. The delegate object for the closure is set to this task.
configureClosure
- The closure to be applied (can be null).
java.util.List<java.lang.String> getSkipProperties()
Returns the list of skip properties. The returned list can be used to add further skip properties. If a system
property with the same key as one of the skip properties is set to a value different than false, none of
the task actions are executed. It has the same effect as disabling the task. Therefore when starting gradle it is
enough to say gradle -Dskip.test
to skip a task. You may, but don't need to assign a value.
groovy.util.AntBuilder getAnt()
Returns the AntBuilder
for this task. You can use this in your build file to execute ant
tasks.
AntBuilder
org.slf4j.Logger getLogger()
Returns the logger for this task. You can use this in your build file to write log messages.
Task disableStandardOutputCapture()
captureStandardOutput(org.gradle.api.logging.LogLevel)
Task captureStandardOutput(LogLevel level)
StandardOutputLogging
.
level
- The level standard out should be logged to.
disableStandardOutputCapture()
java.lang.Object property(java.lang.String propertyName) throws groovy.lang.MissingPropertyException
MissingPropertyException
propertyName
- The name of the property.
groovy.lang.MissingPropertyException
- When the given property is unknown.boolean hasProperty(java.lang.String propertyName)
Determines if this task has the given property. See here for details of the properties which are available for a task.
propertyName
- The name of the property to locate.
void setProperty(java.lang.String name, java.lang.Object 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.
enabled
project property.If the property is not found in any of these locations, it is added to the project's additional properties.
name
- The name of the propertyvalue
- The value of the propertyConvention getConvention()
Returns the Convention
object for this task. A Plugin
can use the convention object to
contribute properties and methods to this task.
java.lang.String getDescription()
setDescription(String)
void setDescription(java.lang.String description)
gradle -t
is called.
description
- The description of the task. Might be null.boolean dependsOnTaskDidWork()
Checks if any of the tasks that this task depends on didWork
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |