gradle/org.gradle.process/BaseExecSpec

BaseExecSpec

interface BaseExecSpec : ProcessForkOptions(source)

Specifies options for launching a child process.

Inheritors

JavaExecSpec

ExecSpec

Functions

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.

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.

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.