|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | METHOD | DETAIL: FIELD | METHOD |
interface Task extends java.lang.Comparable
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 org.gradle.api.tasks.TaskContainer to create and lookup task instances. For example, org.gradle.api.tasks.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 {
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 TaskAction#execute. You can add actions to a task by calling #doFirst(Action) or #doLast(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 #doFirst(groovy.lang.Closure) or #doLast(groovy.lang.Closure) or using the left-shift << operator.
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 org.gradle.api.tasks.StopActionException. A task action can abort execution of the task and continue to the next task by throwing a org.gradle.api.tasks.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(Iterable). You can add objects of any of the following types as a dependency:
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.
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(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 { |
Task
|
disableStandardOutputCapture()
Disables redirection of standard output during task execution. |
Task
|
doFirst(Action action)
Adds the given { |
Task
|
doFirst(Closure action)
Adds the given closure to the beginning of this task's action list. |
Task
|
doLast(Action action)
Adds the given { |
Task
|
doLast(Closure action)
Adds the given closure to the end of this task's action list. |
List
|
getActions()
Returns the sequence of { execution. |
AntBuilder
|
getAnt()
Returns the |
Convention
|
getConvention()
Returns the { |
Set
|
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. |
Logger
|
getLogger()
Returns the logger for this task. |
java.lang.String
|
getName()
Returns the name of this task. |
OutputHandler
|
getOutput()
Returns a OutputHandler object providing information whether a task's output was created successfully and when it was last modified. |
java.lang.String
|
getPath()
Returns the path of the task, which is a fully qualified name for the task. |
Project
|
getProject()
Returns the { |
TaskDependency
|
getTaskDependencies()
Returns a { |
boolean
|
hasProperty(java.lang.String propertyName)
Determines if this task has the given property. |
Task
|
leftShift(Closure action)
Adds the given closure to the end of this task's action list. |
void
|
onlyIf(Closure onlyIfClosure)
Execute the task only if the closure returns true. |
void
|
onlyIf(Spec 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(List actions)
Sets the sequence of { |
void
|
setDependsOn(java.lang.Iterable 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 |
Methods inherited from class java.lang.Object | |
---|---|
wait, wait, wait, hashCode, getClass, equals, toString, notify, notifyAll |
Field Detail |
---|
static final java.lang.String AUTOSKIP_PROPERTY_PREFIX
static final java.lang.String TASK_ACTION
static final java.lang.String TASK_DEPENDS_ON
static final java.lang.String TASK_DESCRIPTION
static final java.lang.String TASK_NAME
static final java.lang.String TASK_OVERWRITE
static final java.lang.String TASK_TYPE
Method Detail |
---|
public Task captureStandardOutput(LogLevel level)
public Task configure(Closure configureClosure)
Applies the statements of the closure against this task object. The delegate object for the closure is set to this task.
public Task deleteAllActions()
Removes all the actions of this task.
public 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.
public boolean dependsOnTaskDidWork()
Checks if any of the tasks that this task depends on Task#getDidWork() didWork.
public Task disableStandardOutputCapture()
public Task doFirst(Action action)
Adds the given TaskAction to the beginning of this task's action list.
public Task doFirst(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.
public Task doLast(Action action)
Adds the given TaskAction to the end of this task's action list.
public Task doLast(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.
public List getActions()
Returns the sequence of TaskAction objects which will be executed by this task, in the order of execution.
public AntBuilder getAnt()
Returns the AntBuilder
for this task. You can use this in your build file to execute ant
tasks.
AntBuilder
public Convention getConvention()
Returns the Convention object for this task. A Plugin can use the convention object to contribute properties and methods to this task.
public Set getDependsOn()
Returns the dependencies of this task.
public java.lang.String getDescription()
public 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.
public boolean getEnabled()
Returns if this task is enabled or not.
public boolean getExecuted()
Returns true if this task has been executed.
public Logger getLogger()
Returns the logger for this task. You can use this in your build file to write log messages.
public java.lang.String getName()
public OutputHandler getOutput()
public 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 :
.
public Project getProject()
Returns the Project which this task belongs to.
public TaskDependency getTaskDependencies()
Returns a TaskDependency which contains all the tasks that this task depends on.
public 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.
public Task leftShift(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.
public void onlyIf(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 org.gradle.api.specs.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() }
public void onlyIf(Spec 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(); } });
public java.lang.Object property(java.lang.String propertyName)
public void setActions(List actions)
Sets the sequence of org.gradle.api.TaskAction objects which will be executed by this task.
public void setDependsOn(java.lang.Iterable dependsOnTasks)
Sets the dependencies of this task. See here for a description of the types of objects which can be used as task dependencies.
public void setDescription(java.lang.String description)
gradle -t
is called.
public 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.
public 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.
Groovy Documentation