gradle/org.gradle.api/DefaultTask

DefaultTask

@DisableCachingByDefault(because = "Gradle would require more information to cache this task")
abstract class DefaultTask : AbstractTask, Task(source)

DefaultTask is the standard Task implementation. You can extend this to implement your own task types.

Inheritors

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
open var description: @Nullable String
Link copied to clipboard
open var enabled: Boolean
Link copied to clipboard
val ExtensionAware.extra: ExtraPropertiesExtension

The extra properties extension in this object's extension container.

Link copied to clipboard
open var group: @Nullable String
Link copied to clipboard
open var impliesSubProjects: Boolean
Link copied to clipboard
val state: TaskStateInternal
Link copied to clipboard
val TASK_ACTION: String = "action"
Link copied to clipboard
val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"
Constructor arguments for the Task
Link copied to clipboard
val TASK_DEPENDS_ON: String = "dependsOn"
Link copied to clipboard
val TASK_DESCRIPTION: String = "description"
Link copied to clipboard
val TASK_GROUP: String = "group"
Link copied to clipboard
val TASK_NAME: String = "name"
Link copied to clipboard
val TASK_OVERWRITE: String = "overwrite"
Link copied to clipboard
val TASK_TYPE: String = "type"
Link copied to clipboard

Functions

Link copied to clipboard
open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)
Link copied to clipboard
open fun appendParallelSafeAction(action: Action<in Task>)
Link copied to clipboard
open fun compareTo(otherTask: Task): Int
Link copied to clipboard
open fun configure(closure: Closure): Task
Applies the statements of the closure against this task object.
abstract fun configure(cl: Closure): T
Link copied to clipboard
inline fun <T : Any> ExtensionAware.configure(noinline configuration: T.() -> Unit)

Executes the given configuration block against the extension of the specified type.

Link copied to clipboard
open fun dependsOn(paths: Array<Any>): Task
Adds the given dependencies to this task.
Link copied to clipboard
open fun doFirst(action: Closure): Task
Adds the given closure to the beginning of this task's action list.
open fun doFirst(action: Action<in Task>): Task
open fun doFirst(actionName: String, action: Action<in Task>): Task
Adds the given Action to the beginning of this task's action list.
Link copied to clipboard
open fun doLast(action: Closure): Task
Adds the given closure to the end of this task's action list.
open fun doLast(action: Action<in Task>): Task
open fun doLast(actionName: String, action: Action<in Task>): Task
Adds the given Action to the end of this task's action list.
Link copied to clipboard
abstract fun doNotTrackState(reasonNotToTrackState: String)
open fun doNotTrackState(reasonNotToTrackState: String)
Do not track the state of the task.
Link copied to clipboard
open fun doNotTrackStateIf(reason: String, spec: Spec<in TaskInternal>)
Link copied to clipboard
open fun finalizedBy(paths: Array<Any>): Task
Adds the given finalizer tasks for this task.
Link copied to clipboard
open fun getActions(): List<Action<in Task>>
Returns the sequence of Action objects which will be executed by this task, in the order of execution.
Link copied to clipboard
open fun getAnt(): AntBuilder
Returns the AntBuilder for this task.
Link copied to clipboard
open fun getAsDynamicObject(): DynamicObject
Link copied to clipboard
open fun getDependsOn(): Set<Any>
Returns the dependencies of this task.
Link copied to clipboard
@Nullable
open fun getDescription(): @Nullable String
Returns the description of this task.
Link copied to clipboard
open fun getDestroyables(): TaskDestroyables
Returns the destroyables of this task.
Link copied to clipboard
open fun getDidWork(): Boolean
Checks if the task actually did any work.
Link copied to clipboard
open fun getEnabled(): Boolean
Returns if this task is enabled or not.
Link copied to clipboard
open fun getExtensions(): ExtensionContainer
The container of extensions.
Link copied to clipboard
open fun getFinalizedBy(): TaskDependency
Returns tasks that finalize this task.
Link copied to clipboard
@Nullable
open fun getGroup(): @Nullable String
Returns the task group which this task belongs to.
Link copied to clipboard
open fun getIdentityPath(): Path
Link copied to clipboard
open fun getInputs(): TaskInputsInternal
Returns the inputs of this task.
Link copied to clipboard
open fun getLifecycleDependencies(): TaskDependencyInternal
abstract fun getLifecycleDependencies(): TaskDependency
Link copied to clipboard
open fun getLocalState(): TaskLocalState
Returns the local state of this task.
Link copied to clipboard
open fun getLogger(): Logger
Returns the logger for this task.
Link copied to clipboard
open fun getLogging(): LoggingManager
Returns the org.gradle.api.logging.LoggingManager which can be used to receive logging and to control the standard output/error capture for this task.
Link copied to clipboard
open fun getMustRunAfter(): TaskDependency
Returns tasks that this task must run after.
Link copied to clipboard
open fun getName(): String
Returns the name of this task.
Link copied to clipboard
open fun getOnlyIf(): Spec<in TaskInternal>
Link copied to clipboard
open fun getOutputs(): TaskOutputsInternal
Returns the outputs of this task.
Link copied to clipboard
open fun getPath(): String
Returns the path of the task, which is a fully qualified name for the task.
Link copied to clipboard
open fun getProject(): Project
Returns the Project which this task belongs to.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun getRequiredServices(): TaskRequiredServices
Link copied to clipboard
open fun getSharedResources(): List<ResourceLock>
abstract fun getSharedResources(): List<out ResourceLock>
Link copied to clipboard
open fun getShouldRunAfter(): TaskDependency
Returns tasks that this task should run after.
Link copied to clipboard
open fun getStandardOutputCapture(): StandardOutputCapture
Link copied to clipboard
open fun getState(): TaskStateInternal
Returns the execution state of this task.
Link copied to clipboard
open fun getTaskActions(): List<InputChangesAwareTaskAction>
Link copied to clipboard
open fun getTaskDependencies(): TaskDependencyInternal
Returns a TaskDependency which contains all the tasks that this task depends on.
Link copied to clipboard
open fun getTaskIdentity(): TaskIdentity<out Any>
Link copied to clipboard
open fun getTemporaryDir(): File
Returns a directory which this task can use to write temporary files to.
Link copied to clipboard
open fun getTemporaryDirFactory(): Factory<File>
Link copied to clipboard
open fun getTimeout(): Property<Duration>
The timeout of this task.
Link copied to clipboard
open fun hasProperty(propertyName: String): Boolean
Determines if this task has the given property.
Link copied to clipboard
open fun hasTaskActions(): Boolean
Link copied to clipboard
open fun <T : Task?> injectIntoNewInstance(project: ProjectInternal, identity: TaskIdentity<T>, factory: Callable<T>): T
Link copied to clipboard
Link copied to clipboard
open fun isEnabled(): Boolean
Link copied to clipboard
open fun isHasCustomActions(): Boolean
Link copied to clipboard
open fun mustRunAfter(paths: Array<Any>): Task
Specifies that this task must run after all of the supplied tasks.
Link copied to clipboard
abstract fun notCompatibleWithConfigurationCache(reason: String)
open fun notCompatibleWithConfigurationCache(reason: String)
Specifies that this task is not compatible with the configuration cache.
Link copied to clipboard
open fun onlyIf(onlyIfClosure: Closure)
Execute the task only if the given closure returns true.
open fun onlyIf(spec: Spec<in Task>)
open fun onlyIf(onlyIfReason: String, spec: Spec<in Task>)
Execute the task only if the given spec is satisfied.
Link copied to clipboard
open fun prependParallelSafeAction(action: Action<in Task>)
Link copied to clipboard
open fun property(propertyName: String): Any
Returns the value of the given property of this task.
Link copied to clipboard
open fun restoreOnlyIf(onlyIf: Spec<in TaskInternal>)
Link copied to clipboard
open fun restoreTaskActions(taskActions: List<InputChangesAwareTaskAction>)
Link copied to clipboard
open fun setActions(replacements: List<Action<in Task>>)
Sets the sequence of Action objects which will be executed by this task.
Link copied to clipboard
open fun setDependsOn(dependsOn: Iterable<out Any>)
Sets the dependencies of this task.
Link copied to clipboard
open fun setDescription(@Nullable description: @Nullable String)
Sets a description for this task.
Link copied to clipboard
open fun setDidWork(didWork: Boolean)
Sets whether the task actually did any work.
Link copied to clipboard
open fun setEnabled(enabled: Boolean)
Set the enabled state of a task.
Link copied to clipboard
open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)
Specifies the set of finalizer tasks for this task.
Link copied to clipboard
open fun setGroup(@Nullable group: @Nullable String)
Sets the task group which this task belongs to.
Link copied to clipboard
open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)
Specifies the set of tasks that this task must run after.
Link copied to clipboard
open fun setOnlyIf(onlyIfClosure: Closure)
Execute the task only if the given closure returns true.
open fun setOnlyIf(spec: Spec<in Task>)
open fun setOnlyIf(onlyIfReason: String, spec: Spec<in Task>)
Execute the task only if the given spec is satisfied.
Link copied to clipboard
open fun setProperty(name: String, value: Any)
Sets a property of this task.
Link copied to clipboard
open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)
Specifies the set of tasks that this task should run after.
Link copied to clipboard
open fun shouldRunAfter(paths: Array<Any>): TaskDependency
Specifies that this task should run after all of the supplied tasks.
Link copied to clipboard
inline fun <T : Any> ExtensionAware.the(): T

Returns the extension of the specified type.

fun <T : Any> ExtensionAware.the(extensionType: KClass<T>): T

Returns the extension of the specified extensionType.

Link copied to clipboard
open fun usesService(service: Provider<out BuildService<out Any>>)
Registers a BuildService that is used by this task so its constraint on parallel execution can be honored.
Generated by Dokka
Gradle Kotlin DSL Reference