Exec

@DisableCachingByDefault(because = "Gradle would require more information to cache this task")

abstract class Exec : AbstractExecTask<Exec> (source)

Executes a command line process. Example:

task stopTomcat(type:Exec) {
  workingDir '../tomcat/bin'

  //on windows:
  commandLine 'cmd.exe', '/d', '/c', 'stop.bat'

  //on linux
  commandLine './stop.sh'

  //store the output instead of printing to the console:
  standardOutput = new ByteArrayOutputStream()

  //extension method stopTomcat.output() can be used to obtain the output:
  ext.output = {
    return standardOutput.toString()
  }
}

Constructors

Exec

constructor()

Properties

conventionMapping

open val conventionMapping: @Nullable ConventionMapping

description

@get:Nullable

open var description: @Nullable String

enabled

open var enabled: Boolean

extra

val ExtensionAware.extra: ExtraPropertiesExtension

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

group

@get:Nullable

open var group: @Nullable String

impliesSubProjects

open var impliesSubProjects: Boolean

state

val state: TaskStateInternal

TASK_ACTION

val TASK_ACTION: String = "action"

TASK_CONSTRUCTOR_ARGS

val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"

Constructor arguments for the Task

TASK_DEPENDS_ON

val TASK_DEPENDS_ON: String = "dependsOn"

TASK_DESCRIPTION

val TASK_DESCRIPTION: String = "description"

TASK_GROUP

val TASK_GROUP: String = "group"

TASK_NAME

val TASK_NAME: String = "name"

TASK_OVERWRITE

val TASK_OVERWRITE: String = "overwrite"

TASK_TYPE

val TASK_TYPE: String = "type"

timeout

val timeout: Property<Duration>

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task>)

args

open fun args(args: Iterable<out Any>): T

open fun args(args: Array<Any>): T

abstract fun args(args: Iterable<out Any>): ExecSpec

abstract fun args(args: Array<Any>): ExecSpec

Adds arguments for the command to be executed.

commandLine

open fun commandLine(args: Iterable<out Any>): T

open fun commandLine(arguments: Array<Any>): T

abstract fun commandLine(args: Iterable<out Any>): ExecSpec

abstract fun commandLine(args: Array<Any>): ExecSpec

Sets the full command line, including the executable to be executed plus its arguments.

compareTo

open fun compareTo(otherTask: Task): Int

configure

open fun configure(closure: Closure): Task

abstract fun configure(configureClosure: Closure): Task

open fun configure(closure: Closure): Task

Applies the statements of the closure against this task object.

abstract fun configure(cl: Closure): T

configure

inline fun <T : Any> ExtensionAware.configure(noinline configuration: T.() -> Unit)

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

conventionMapping

open fun conventionMapping(property: String, mapping: Callable<out Any>): Task

copyTo

open fun copyTo(target: ProcessForkOptions): T

abstract fun copyTo(options: ProcessForkOptions): ProcessForkOptions

Copies these options to the given target options.

dependsOn

open fun dependsOn(paths: Array<Any>): Task

Adds the given dependencies to this task.

doFirst

open fun doFirst(action: Closure): Task

abstract fun doFirst(@DelegatesTo(value = Task::class) 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

open fun doFirst(action: Action<in Task>): Task

Adds the given Action to the beginning of this task's action list.

doLast

open fun doLast(action: Closure): Task

abstract fun doLast(@DelegatesTo(value = Task::class) 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

open fun doLast(action: Action<in Task>): Task

Adds the given Action to the end of this task's action list.

doNotTrackState

abstract fun doNotTrackState(reasonNotToTrackState: String)

open fun doNotTrackState(reasonNotToTrackState: String)

Do not track the state of the task.

doNotTrackStateIf

open fun doNotTrackStateIf(reason: String, spec: Spec<in TaskInternal>)

environment

open fun environment(environmentVariables: Map<String, out Any>): T

abstract fun environment(environmentVariables: Map<String, out Any>): ProcessForkOptions

Adds some environment variables to the environment for this process.

open fun environment(name: String, value: Any): T

abstract fun environment(name: String, value: Any): ProcessForkOptions

Adds an environment variable to the environment for this process.

environment

inline fun <T : AbstractExecTask<*>> AbstractExecTask<T>.environment(vararg environmentVariables: Pair<String, Any>): T

Kotlin extension function for org.gradle.api.tasks.AbstractExecTask.environment.

inline fun ProcessForkOptions.environment(vararg environmentVariables: Pair<String, Any>): ProcessForkOptions

Kotlin extension function for org.gradle.process.ProcessForkOptions.environment.

executable

open fun executable(executable: Any): T

abstract fun executable(executable: Any): ProcessForkOptions

Sets the name of the executable to use.

finalizedBy

open fun finalizedBy(paths: Array<Any>): Task

Adds the given finalizer tasks for this task.

getActions

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.

getAnt

open fun getAnt(): AntBuilder

Returns the AntBuilder for this task.

getArgs

open fun getArgs(): List<String>

getArgumentProviders

open fun getArgumentProviders(): List<CommandLineArgumentProvider>

Argument providers for the application.

getAsDynamicObject

open fun getAsDynamicObject(): DynamicObject

getCommandLine

@Internal

open fun getCommandLine(): List<String>

Returns the full command line, including the executable plus its arguments.

getDependsOn

open fun getDependsOn(): Set<Any>

Returns the dependencies of this task.

getDestroyables

open fun getDestroyables(): TaskDestroyables

Returns the destroyables of this task.

getDidWork

open fun getDidWork(): Boolean

Checks if the task actually did any work.

getEnvironment

@Internal

open fun getEnvironment(): Map<String, Any>

The environment variables to use for the process.

getErrorOutput

open fun getErrorOutput(): OutputStream

getExecutable

@Nullable

@Optional

@Input

open fun getExecutable(): @Nullable String

Returns the name of the executable to use.

getExecutionResult

@Internal

open fun getExecutionResult(): Provider<ExecResult>

Returns the result for the command run by this task.

getExtensions

open fun getExtensions(): ExtensionContainer

The container of extensions.

getFinalizedBy

open fun getFinalizedBy(): TaskDependency

Returns tasks that finalize this task.

getIdentityPath

open fun getIdentityPath(): Path

getInputs

open fun getInputs(): TaskInputsInternal

@Internal

abstract fun getInputs(): TaskInputs

open fun getInputs(): TaskInputsInternal

Returns the inputs of this task.

getLifecycleDependencies

open fun getLifecycleDependencies(): TaskDependencyInternal

abstract fun getLifecycleDependencies(): TaskDependency

getLocalState

open fun getLocalState(): TaskLocalState

Returns the local state of this task.

getLogger

open fun getLogger(): Logger

Returns the logger for this task.

getLogging

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.

getMustRunAfter