gradle/org.gradle.api.tasks/Exec

Exec

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

abstract class Exec : AbstractExecTask<T> (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

constructor()

Properties

conventionMapping

open val conventionMapping: ConventionMapping

open var description: String

open var enabled: Boolean

val ExtensionAware.extra: ExtraPropertiesExtension

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

open var group: String

impliesSubProjects

open var impliesSubProjects: Boolean

val state: TaskStateInternal

val TASK_ACTION: String = "action"

TASK_CONSTRUCTOR_ARGS

val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"

TASK_DEPENDS_ON

val TASK_DEPENDS_ON: String = "dependsOn"

TASK_DESCRIPTION

val TASK_DESCRIPTION: String = "description"

val TASK_GROUP: String = "group"

val TASK_NAME: String = "name"

val TASK_OVERWRITE: String = "overwrite"

val TASK_TYPE: String = "type"

val timeout: Property<Duration>

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)

appendParallelSafeAction

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

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

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

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

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

open fun compareTo(otherTask: Task): Int

open fun configure(closure: Closure): Task

abstract fun configure(cl: Closure): T

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

open fun copyTo(target: ProcessForkOptions): T

abstract fun copyTo(options: ProcessForkOptions): ProcessForkOptions

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

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

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

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String)

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

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

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.

open fun executable(executable: Any): T

abstract fun executable(executable: Any): ProcessForkOptions

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

open fun getActions(): List<Action<in Task>>

open fun getAnt(): AntBuilder

@Nullable

open fun getArgs(): List<String>

getArgumentProviders

open fun getArgumentProviders(): List<CommandLineArgumentProvider>

getAsDynamicObject

open fun getAsDynamicObject(): DynamicObject

open fun getCommandLine(): List<String>

open fun getConvention(): Convention

open fun getDependsOn(): Set<Any>

getDestroyables

open fun getDestroyables(): TaskDestroyables

open fun getDidWork(): Boolean

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

open fun getErrorOutput(): OutputStream

open fun getExecutable(): String

getExecutionResult

open fun getExecutionResult(): Provider<ExecResult>

open fun getExtensions(): ExtensionContainer

open fun getFinalizedBy(): TaskDependency

getIdentityPath

open fun getIdentityPath(): Path

open fun getInputs(): TaskInputsInternal

abstract fun getInputs(): TaskInputs

getLifecycleDependencies

open fun getLifecycleDependencies(): TaskDependencyInternal

abstract fun getLifecycleDependencies(): TaskDependency

open fun getLocalState(): TaskLocalState

open fun getLogger(): Logger

open fun getLogging(): LoggingManager

getMustRunAfter

open fun getMustRunAfter(): TaskDependency

open fun getName(): String

open fun getOnlyIf(): Spec<in TaskInternal>

open fun getOutputs(): TaskOutputsInternal

abstract fun getOutputs(): TaskOutputs

open fun getPath(): String

open fun getProject(): Project

getReasonNotToTrackState

open fun getReasonNotToTrackState(): Optional<String>

getReasonTaskIsIncompatibleWithConfigurationCache

open fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

getRequiredServices

open fun getRequiredServices(): TaskRequiredServices

getSharedResources

open fun getSharedResources(): List<ResourceLock>

abstract fun getSharedResources(): List<out ResourceLock>

getShouldRunAfter

open fun getShouldRunAfter(): TaskDependency

getStandardInput

open fun getStandardInput(): InputStream

getStandardOutput

open fun getStandardOutput(): OutputStream

getStandardOutputCapture

open fun getStandardOutputCapture(): StandardOutputCapture

abstract fun getState(): TaskState

open fun getTaskActions(): List<InputChangesAwareTaskAction>

getTaskDependencies

open fun getTaskDependencies(): TaskDependencyInternal

abstract fun getTaskDependencies(): TaskDependency

getTaskIdentity

open fun getTaskIdentity(): TaskIdentity<out Any>

getTemporaryDir

open fun getTemporaryDir(): File

getTemporaryDirFactory

open fun getTemporaryDirFactory(): Factory<File>

open fun getWorkingDir(): File

open fun hasProperty(propertyName: String): Boolean

open fun hasTaskActions(): Boolean

injectIntoNewInstance

open fun <T : Task?> injectIntoNewInstance(project: ProjectInternal, identity: TaskIdentity<T>, factory: Callable<T>): T

isCompatibleWithConfigurationCache

open fun isCompatibleWithConfigurationCache(): Boolean

open fun isEnabled(): Boolean

isHasCustomActions

open fun isHasCustomActions(): Boolean

isIgnoreExitValue

open fun isIgnoreExitValue(): Boolean

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

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String)

open fun onlyIf(spec: Spec<in Task>)

prependParallelSafeAction

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

open fun property(propertyName: String): Any

open fun setActions(replacements: List<Action<in Task>>)

open fun setArgs(@Nullable arguments: Iterable<out Any>): Exec

open fun setArgs(arguments: List<String>): Exec

abstract fun setArgs(args: List<String>): ExecSpec

open fun setCommandLine(args: List<String>)

open fun setDependsOn(dependsOn: Iterable<out Any>)

open fun setDidWork(didWork: Boolean)

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

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

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

open fun setErrorOutput(outputStream: OutputStream): Exec

abstract fun setErrorOutput(outputStream: OutputStream): BaseExecSpec

open fun setExecutable(executable: String)

open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)

setIgnoreExitValue

open fun setIgnoreExitValue(ignoreExitValue: Boolean): Exec

abstract fun setIgnoreExitValue(ignoreExitValue: Boolean): BaseExecSpec

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)

open fun setOnlyIf(spec: Spec<in Task>)

open fun setProperty(name: String, value: Any)

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)

setStandardInput

open fun setStandardInput(inputStream: InputStream): Exec

abstract fun setStandardInput(inputStream: InputStream): BaseExecSpec

setStandardOutput

open fun setStandardOutput(outputStream: OutputStream): Exec

abstract fun setStandardOutput(outputStream: OutputStream): BaseExecSpec

open fun setWorkingDir(dir: File)

open fun shouldRunAfter(paths: Array<Any>): TaskDependency

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.

open fun usesService(service: Provider<out BuildService<out Any>>)

open fun workingDir(dir: Any): T

abstract fun workingDir(dir: Any): ProcessForkOptions