AbstractTask (Gradle API 1.0)

java.lang.Object
- org.gradle.api.internal.AbstractTask

All Implemented Interfaces:

Comparable<Task>, DynamicObjectAware, TaskInternal, ExtensionAware, Task, Configurable<Task>

Direct Known Subclasses:

DefaultTask
```
public abstract class AbstractTask
extends Object
implements TaskInternal, DynamicObjectAware
```
Author:

Hans Dockter

Nested Class Summary
- Nested classes/interfaces inherited from interface org.gradle.api.Task
  Task.Namer

Field Summary
- Fields inherited from interface org.gradle.api.Task
  TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractTask()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractTask()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addValidator(TaskValidator validator)`
`int`	`compareTo(Task otherTask)`
`Task`	`configure(Closure closure)` Applies the statements of the closure against this task object.
`Task`	`deleteAllActions()` Removes all the actions of this task.
`Task`	`dependsOn(Object... paths)` Adds the given dependencies to this task.
`boolean`	`dependsOnTaskDidWork()` Checks if any of the tasks that this task depends on `didWork`.
`Task`	`doFirst(Action<? super Task> action)` Adds the given `Action` to the beginning of this task's action list.
`Task`	`doFirst(Closure action)` Adds the given closure to the beginning of this task's action list.
`Task`	`doLast(Action<? super Task> action)` Adds the given `Action` to the end of this task's action list.
`Task`	`doLast(Closure action)` Adds the given closure to the end of this task's action list.
`void`	`execute()`
`void`	`executeWithoutThrowingTaskFailure()`
`List<Action<? super Task>>`	`getActions()` Returns the sequence of `Action` objects which will be executed by this task, in the order of execution.
`AntBuilder`	`getAnt()` Returns the `AntBuilder` for this task.
`DynamicObject`	`getAsDynamicObject()` Returns a `DynamicObject` for this object.
`Convention`	`getConvention()` Returns the `Convention` object for this task.
`Set<Object>`	`getDependsOn()` Returns the dependencies of this task.
`String`	`getDescription()` Returns the description of this task.
`boolean`	`getDidWork()` Checks if the task actually did any work.
`DynamicObjectHelper`	`getDynamicObjectHelper()`
`boolean`	`getEnabled()` Returns if this task is enabled or not.
`TaskExecuter`	`getExecuter()`
`ExtensionContainer`	`getExtensions()` The container of extensions.
`String`	`getGroup()` Returns the task group which this task belongs to.
`TaskInputs`	`getInputs()` Returns the inputs of this task.
`Logger`	`getLogger()` Returns the logger for this task.
`LoggingManager`	`getLogging()` Returns the `LoggingManager` which can be used to control the logging level and standard output/error capture for this task.
`String`	`getName()` Returns the name of this task.
`Spec<? super TaskInternal>`	`getOnlyIf()`
`TaskOutputsInternal`	`getOutputs()` Returns the outputs of this task.
`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.
`protected ServiceRegistry`	`getServices()`
`StandardOutputCapture`	`getStandardOutputCapture()`
`TaskState`	`getState()` Returns the execution state of this task.
`TaskDependencyInternal`	`getTaskDependencies()` Returns a `TaskDependency` which contains all the tasks that this task depends on.
`File`	`getTemporaryDir()` Returns a directory which this task can use to write temporary files to.
`Factory<File>`	`getTemporaryDirFactory()` The returned factory is expected to return the same file each time.
`List<TaskValidator>`	`getValidators()`
`boolean`	`hasProperty(String propertyName)` Determines if this task has the given property.
`static <T extends Task> T`	`injectIntoNewInstance(ProjectInternal project, String name, Callable<T> factory)`
`boolean`	`isEnabled()`
`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 given closure returns true.
`void`	`onlyIf(Spec<? super Task> onlyIfSpec)` Execute the task only if the given spec is satisfied.
`Object`	`property(String propertyName)` Returns the value of the given property of this task.
`void`	`setActions(List<Action<? super Task>> actions)` Sets the sequence of `Action` objects which will be executed by this task.
`void`	`setDependsOn(Iterable<?> dependsOn)` Sets the dependencies of this task.
`void`	`setDescription(String description)` Sets a description for this task.
`void`	`setDidWork(boolean didWork)` Sets whether the task actually did any work.
`void`	`setEnabled(boolean enabled)` Set the enabled state of a task.
`void`	`setExecuter(TaskExecuter executer)`
`void`	`setGroup(String group)` Sets the task group which this task belongs to.
`void`	`setName(String name)`
`void`	`setOnlyIf(Closure onlyIfClosure)` Execute the task only if the given closure returns true.
`void`	`setOnlyIf(Spec<? super Task> spec)` Execute the task only if the given spec is satisfied.
`void`	`setProject(Project project)`
`void`	`setProperty(String name, Object value)` Sets a property of this task.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AbstractTask
```
protected AbstractTask()
```
- Method Detail
  - injectIntoNewInstance
```
public static <T extends Task> T injectIntoNewInstance(ProjectInternal project,
                                       String name,
                                       Callable<T> factory)
```
  - getState
```
public TaskState getState()
```
    Description copied from interface: Task
    
    Returns 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.
    
    Specified by:
    
    getState in interface Task
    
    Returns:
    The execution state of this task. Never returns null.
  - getAnt
```
public AntBuilder getAnt()
```
    Description copied from interface: Task
    
    Returns the AntBuilder for this task. You can use this in your build file to execute ant tasks.
    
    Specified by:
    
    getAnt in interface Task
    
    Returns:
    The AntBuilder
  - getProject
```
public Project getProject()
```
    Description copied from interface: Task
    
    Returns the Project which this task belongs to.
    
    Specified by:
    
    getProject in interface Task
    
    Returns:
    The project this task belongs to. Never returns null.
  - setProject
```
public void setProject(Project project)
```
  - getName
```
public String getName()
```
    Description copied from interface: Task
    
    Returns the name of this task. The name uniquely identifies the task within its Project.
    
    Specified by:
    
    getName in interface Task
    
    Returns:
    The name of the task. Never returns null.
  - setName
```
public void setName(String name)
```
  - getActions
```
public List<Action<? super Task>> getActions()
```
    Description copied from interface: Task
    
    Returns the sequence of Action objects which will be executed by this task, in the order of execution.
    
    Specified by:
    
    getActions in interface Task
    
    Returns:
    The task actions in the order they are executed. Returns an empty list if this task has no actions.
  - setActions
```
public void setActions(List<Action<? super Task>> actions)
```
    Description copied from interface: Task
    
    Sets the sequence of Action objects which will be executed by this task.
    
    Specified by:
    
    setActions in interface Task
    
    Parameters:
    actions - The actions.
  - getTaskDependencies
```
public TaskDependencyInternal getTaskDependencies()
```
    Description copied from interface: Task
    
    Returns a TaskDependency which contains all the tasks that this task depends on.
    
    Specified by:
    
    getTaskDependencies in interface Task
    
    Returns:
    The dependencies of this task. Never returns null.
  - getDependsOn
```
public Set<Object> getDependsOn()
```
    Description copied from interface: Task
    
    Returns the dependencies of this task.
    
    Specified by:
    
    getDependsOn in interface Task
    
    Returns:
    The dependencies of this task. Returns an empty set if this task has no dependencies.
  - setDependsOn
```
public void setDependsOn(Iterable<?> dependsOn)
```
    Description copied from interface: Task
    
    Sets the dependencies of this task. See here for a description of the types of objects which can be used as task dependencies.
    
    Specified by:
    
    setDependsOn in interface Task
    
    Parameters:
    dependsOn - The set of task paths.
  - onlyIf
```
public void onlyIf(Closure onlyIfClosure)
```
    Description copied from interface: Task
    
    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{ dependsOnTaskDidWork() }
    
    Specified by:
    
    onlyIf in interface Task
    
    Parameters:
    onlyIfClosure - code to execute to determine if task should be run
  - onlyIf
```
public void onlyIf(Spec<? super Task> onlyIfSpec)
```
    Description copied from interface: Task
    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 task.dependsOnTaskDidWork();
    }
 });
 
```
    Specified by:
    
    onlyIf in interface Task
    
    Parameters:
    onlyIfSpec - specifies if a task should be run
  - setOnlyIf
```
public void setOnlyIf(Spec<? super Task> spec)
```
    Description copied from interface: Task
    
    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.
    
    The given predicate replaces all such predicates for this task.
    
    Specified by:
    
    setOnlyIf in interface Task
    
    Parameters:
    spec - specifies if a task should be run
  - setOnlyIf
```
public void setOnlyIf(Closure onlyIfClosure)
```
    Description copied from interface: Task
    
    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.
    
    The given predicate replaces all such predicates for this task.
    
    Specified by:
    
    setOnlyIf in interface Task
    
    Parameters:
    onlyIfClosure - code to execute to determine if task should be run
  - getOnlyIf
```
public Spec<? super TaskInternal> getOnlyIf()
```
    Specified by:
    
    getOnlyIf in interface TaskInternal
  - getDidWork
```
public boolean getDidWork()
```
    Description copied from interface: 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, the Compile task may determine that source files have not changed since the last time a the task was run.
    
    Specified by:
    
    getDidWork in interface Task
    
    Returns:
    true if this task did any work
  - setDidWork
```
public void setDidWork(boolean didWork)
```
    Description copied from interface: Task
    
    Sets whether the task actually did any work. Most built-in tasks will set this automatically, but it may be useful to manually indicate this for custom user tasks.
    This is useful when combined with onlyIf { dependsOnTaskDidWork() }.
    
    Specified by:
    
    setDidWork in interface Task
    
    Parameters:
    didWork - indicates if the task did any work
  - isEnabled
```
public boolean isEnabled()
```
  - getEnabled
```
public boolean getEnabled()
```
    Description copied from interface: Task
    
    Returns if this task is enabled or not.
    
    Specified by:
    
    getEnabled in interface Task
    
    See Also:
    Task.setEnabled(boolean)
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Description copied from interface: Task
    
    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.
    
    Specified by:
    
    setEnabled in interface Task
    
    Parameters:
    enabled - The enabled state of this task (true or false)
  - getPath
```
public String getPath()
```
    Description copied from interface: Task
    
    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 :.
    
    Specified by:
    
    getPath in interface Task
    
    Returns:
    the path of the task, which is equal to the path of the project plus the name of the task.
  - deleteAllActions
```
public Task deleteAllActions()
```
    Description copied from interface: Task
    
    Removes all the actions of this task.
    
    Specified by:
    
    deleteAllActions in interface Task
    
    Returns:
    the task object this method is applied to
  - execute
```
public final void execute()
```
    Specified by:
    
    execute in interface TaskInternal
  - executeWithoutThrowingTaskFailure
```
public void executeWithoutThrowingTaskFailure()
```
    Specified by:
    
    executeWithoutThrowingTaskFailure in interface TaskInternal
  - getExecuter
```
public TaskExecuter getExecuter()
```
    Specified by:
    
    getExecuter in interface TaskInternal
  - setExecuter
```
public void setExecuter(TaskExecuter executer)
```
    Specified by:
    
    setExecuter in interface TaskInternal
  - dependsOn
```
public Task dependsOn(Object... paths)
```
    Description copied from interface: 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.
    
    Specified by:
    
    dependsOn in interface Task
    
    Parameters:
    paths - The dependencies to add to this task. The path can be defined by:
    A String, CharSequence or groovy.lang.GString task path or name. A relative path is interpreted relative to the task's Project. This allows you to refer to tasks in other projects.
    
    A Task.
    
    A closure. The closure may take a Task as parameter. It may return any of the types listed here. Its return value is recursively converted to tasks. A null return value is treated as an empty collection.
    
    A TaskDependency object.
    
    A Buildable object.
    
    A Iterable, Collection, Map or array. May contain any of the types listed here. The elements of the iterable/collection/map/array are recursively converted to tasks.
    
    A Callable. The call() method may return any of the types listed here. Its return value is recursively converted to tasks. A null return value is treated as an empty collection.
    
    An Object. The object's toString() method is interpreted as a task path or name. The support for custom Objects has been deprecated and will be removed in the next version of Gradle.
    
    Returns:
    the task object this method is applied to
  - doFirst
```
public Task doFirst(Action<? super Task> action)
```
    Description copied from interface: Task
    
    Adds the given Action to the beginning of this task's action list.
    
    Specified by:
    
    doFirst in interface Task
    
    Parameters:
    action - The action to add
    
    Returns:
    the task object this method is applied to
  - doLast
```
public Task doLast(Action<? super Task> action)
```
    Description copied from interface: Task
    
    Adds the given Action to the end of this task's action list.
    
    Specified by:
    
    doLast in interface Task
    
    Parameters:
    action - The action to add.
    
    Returns:
    the task object this method is applied to
  - compareTo
```
public int compareTo(Task otherTask)
```
    Specified by:
    
    compareTo in interface Comparable<Task>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getLogger
```
public Logger getLogger()
```
    Description copied from interface: Task
    
    Returns the logger for this task. You can use this in your build file to write log messages.
    
    Specified by:
    
    getLogger in interface Task
    
    Returns:
    The logger. Never returns null.
  - getLogging
```
public LoggingManager getLogging()
```
    Description copied from interface: Task
    
    Returns the LoggingManager which can be used to control the logging level and 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.
    
    Specified by:
    
    getLogging in interface Task
    
    Returns:
    the LoggingManager. Never returns null.
  - getStandardOutputCapture
```
public StandardOutputCapture getStandardOutputCapture()
```
    Specified by:
    
    getStandardOutputCapture in interface TaskInternal
  - getDynamicObjectHelper
```
public DynamicObjectHelper getDynamicObjectHelper()
```
  - property
```
public Object property(String propertyName)
                throws MissingPropertyException
```
    Description copied from interface: Task
    Returns the value of the given property of this task. This method locates a property as follows:
    1. If this task object has a property with the given name, return the value of the property.
    2. If this task has an additional property with the given name, return the value of the property.
    3. If this task's convention object has a property with the given name, return the value of the property.
    4. If not found, throw MissingPropertyException
    Specified by:
    
    property in interface Task
    
    Parameters:
    propertyName - The name of the property.
    
    Returns:
    The value of the property, possibly null.
    
    Throws:
    
    MissingPropertyException - When the given property is unknown.
  - hasProperty
```
public boolean hasProperty(String propertyName)
```
    Description copied from interface: Task
    
    Determines if this task has the given property. See here for details of the properties which are available for a task.
    
    Specified by:
    
    hasProperty in interface Task
    
    Parameters:
    propertyName - The name of the property to locate.
    
    Returns:
    True if this project has the given property, false otherwise.
  - setProperty
```
public void setProperty(String name,
               Object value)
```
    Description copied from interface: Task
    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.
    1. The task object itself. For example, the enabled project property.
    2. The task's convention object.
    3. The task's additional properties.
    If the property is not found in any of these locations, it is added to the project's additional properties.
    Specified by:
    
    setProperty in interface Task
    
    Parameters:
    name - The name of the property
    value - The value of the property
  - getConvention
```
public Convention getConvention()
```
    Description copied from interface: Task
    
    Returns the Convention object for this task. A Plugin can use the convention object to contribute properties and methods to this task.
    
    Specified by:
    
    getConvention in interface Task
    
    Returns:
    The convention object. Never returns null.
  - getExtensions
```
public ExtensionContainer getExtensions()
```
    Description copied from interface: ExtensionAware
    
    The container of extensions.
    
    Specified by:
    
    getExtensions in interface ExtensionAware
  - getAsDynamicObject
```
public DynamicObject getAsDynamicObject()
```
    Description copied from interface: DynamicObjectAware
    
    Returns a DynamicObject for this object.
    
    Specified by:
    
    getAsDynamicObject in interface DynamicObjectAware
    
    Returns:
    The dynamic object.
  - getDescription
```
public String getDescription()
```
    Description copied from interface: Task
    
    Returns the description of this task.
    
    Specified by:
    
    getDescription in interface Task
    
    Returns:
    the description. May return null.
  - setDescription
```
public void setDescription(String description)
```
    Description copied from interface: Task
    
    Sets a description for this task. This should describe what the task does to the user of the build. The description will be displayed when gradle tasks is called.
    
    Specified by:
    
    setDescription in interface Task
    
    Parameters:
    description - The description of the task. Might be null.
  - getGroup
```
public String getGroup()
```
    Description copied from interface: Task
    
    Returns 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.
    
    Specified by:
    
    getGroup in interface Task
    
    Returns:
    The task group for this task. Might be null.
  - setGroup
```
public void setGroup(String group)
```
    Description copied from interface: Task
    
    Sets 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.
    
    Specified by:
    
    setGroup in interface Task
    
    Parameters:
    group - The task group for this task. Can be null.
  - getInputs
```
public TaskInputs getInputs()
```
    Description copied from interface: Task
    
    Returns the inputs of this task.
    
    Specified by:
    
    getInputs in interface Task
    
    Returns:
    The inputs. Never returns null.
  - getOutputs
```
public TaskOutputsInternal getOutputs()
```
    Description copied from interface: Task
    
    Returns the outputs of this task.
    
    Specified by:
    
    getOutputs in interface TaskInternal
    
    Specified by:
    
    getOutputs in interface Task
    
    Returns:
    The outputs. Never returns null.
  - getServices
```
protected ServiceRegistry getServices()
```
  - dependsOnTaskDidWork
```
public boolean dependsOnTaskDidWork()
```
    Description copied from interface: Task
    
    Checks if any of the tasks that this task depends on didWork.
    
    Specified by:
    
    dependsOnTaskDidWork in interface Task
    
    Returns:
    true if any task this task depends on did work.
  - doFirst
```
public Task doFirst(Closure action)
```
    Description copied from interface: Task
    
    Adds the given closure to the beginning of this task's action list. The closure is passed this task as a parameter when executed.
    
    Specified by:
    
    doFirst in interface Task
    
    Parameters:
    action - The action closure to execute.
    
    Returns:
    This task.
  - doLast
```
public Task doLast(Closure action)
```
    Description copied from interface: Task
    
    Adds the given closure to the end of this task's action list. The closure is passed this task as a parameter when executed.
    
    Specified by:
    
    doLast in interface Task
    
    Parameters:
    action - The action closure to execute.
    
    Returns:
    This task.
  - leftShift
```
public Task leftShift(Closure action)
```
    Description copied from interface: Task
    
    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.
    
    Specified by:
    
    leftShift in interface Task
    
    Parameters:
    action - The action closure to execute.
    
    Returns:
    This task.
  - configure
```
public Task configure(Closure closure)
```
    Description copied from interface: Task
    
    Applies the statements of the closure against this task object. The delegate object for the closure is set to this task.
    
    Specified by:
    
    configure in interface Task
    
    Specified by:
    
    configure in interface Configurable<Task>
    
    Parameters:
    closure - The closure to be applied (can be null).
    
    Returns:
    This task
  - getTemporaryDir
```
public File getTemporaryDir()
```
    Description copied from interface: Task
    
    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.
    
    Specified by:
    
    getTemporaryDir in interface Task
    
    Returns:
    The directory. Never returns null. The directory will already exist.
  - getTemporaryDirFactory
```
public Factory<File> getTemporaryDirFactory()
```
    Description copied from interface: TaskInternal
    
    The returned factory is expected to return the same file each time.
    The getTemporaryDir() method creates the directory which can be problematic. Use this to delay that creation.
    
    Specified by:
    
    getTemporaryDirFactory in interface TaskInternal
  - addValidator
```
public void addValidator(TaskValidator validator)
```
    Specified by:
    
    addValidator in interface TaskInternal
  - getValidators
```
public List<TaskValidator> getValidators()
```
    Specified by:
    
    getValidators in interface TaskInternal

Class AbstractTask

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

Field Summary

Fields inherited from interface org.gradle.api.Task

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractTask

Method Detail

injectIntoNewInstance

getState

getAnt

getProject

setProject

getName

setName

getActions

setActions

getTaskDependencies

getDependsOn

setDependsOn

onlyIf

onlyIf

setOnlyIf

setOnlyIf

getOnlyIf

getDidWork

setDidWork

isEnabled

getEnabled

setEnabled

getPath

deleteAllActions

execute

executeWithoutThrowingTaskFailure

getExecuter

setExecuter

dependsOn

doFirst

doLast

compareTo

toString

getLogger

getLogging

getStandardOutputCapture

getDynamicObjectHelper

property

hasProperty

setProperty

getConvention

getExtensions

getAsDynamicObject

getDescription

setDescription

getGroup

setGroup

getInputs

getOutputs

getServices

dependsOnTaskDidWork

doFirst

doLast

leftShift

configure

getTemporaryDir

getTemporaryDirFactory

addValidator

getValidators