gradle/org.gradle.process/ExecSpec

ExecSpec

interface ExecSpec : BaseExecSpec(source)

Specified the options for executing some command.

Inheritors

AbstractExecTask

Functions

args

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

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

Adds arguments for the command to be executed.

commandLine

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.

copyTo

abstract fun copyTo(options: ProcessForkOptions): ProcessForkOptions

Copies these options to the given target options.

environment

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

Adds some environment variables to the environment for this process.

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

Adds an environment variable to the environment for this process.

executable

abstract fun executable(executable: Any): ProcessForkOptions

Sets the name of the executable to use.

getArgs

abstract fun getArgs(): List<String>

Returns the arguments for the command to be executed.

getArgumentProviders

abstract fun getArgumentProviders(): List<CommandLineArgumentProvider>

Argument providers for the application.

getCommandLine

abstract fun getCommandLine(): List<String>

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

getEnvironment

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

The environment variables to use for the process.

getErrorOutput

abstract fun getErrorOutput(): OutputStream

Returns the output stream to consume standard error from the process executing the command.

getExecutable

abstract fun getExecutable(): String

Returns the name of the executable to use.

getStandardInput

abstract fun getStandardInput(): InputStream

Returns the standard input stream for the process executing the command.

getStandardOutput

abstract fun getStandardOutput(): OutputStream

Returns the output stream to consume standard output from the process executing the command.

getWorkingDir

abstract fun getWorkingDir(): File

Returns the working directory for the process.

isIgnoreExitValue

abstract fun isIgnoreExitValue(): Boolean

Tells whether a non-zero exit value is ignored, or an exception thrown.

setArgs

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

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

Sets the arguments for the command to be executed.

setCommandLine

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

abstract fun setCommandLine(args: Array<Any>)

abstract fun setCommandLine(args: List<String>)

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

setEnvironment

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

Sets the environment variable to use for the process.

setErrorOutput

abstract fun setErrorOutput(outputStream: OutputStream): BaseExecSpec

Sets the output stream to consume standard error from the process executing the command.

setExecutable

abstract fun setExecutable(executable: Any)

abstract fun setExecutable(executable: String)

Sets the name of the executable to use.

setIgnoreExitValue

abstract fun setIgnoreExitValue(ignoreExitValue: Boolean): BaseExecSpec

Sets whether a non-zero exit value is ignored, or an exception thrown.

setStandardInput

abstract fun setStandardInput(inputStream: InputStream): BaseExecSpec

Sets the standard input stream for the process executing the command.

setStandardOutput

abstract fun setStandardOutput(outputStream: OutputStream): BaseExecSpec

Sets the output stream to consume standard output from the process executing the command.

setWorkingDir

abstract fun setWorkingDir(dir: File)

abstract fun setWorkingDir(dir: Any)

Sets the working directory for the process.

workingDir

abstract fun workingDir(dir: Any): ProcessForkOptions

Sets the working directory for the process.