ksubprocess/ksubprocess/ExecArgumentsBuilder

ExecArgumentsBuilder

class ExecArgumentsBuilder : ProcessArgumentBuilder

Builder for the exec method.

Inherits from ProcessArgumentBuilder to define launch settings.

Constructors

constructor()

Properties

arguments

val arguments: MutableList<String>

Command line, including executable as first element.

check

var check: Boolean

Set to true to throw a ProcessExitException if the process doesn't terminate normally.

environment

val environment: MutableMap<String, String>

Subprocess environment.

input

var input: String

stdin pipe input. Ignored if stdin isn't a pipe.

isEnvironmentModified

val isEnvironmentModified: Boolean

Check if environment was modified at all.

killTimeout

var killTimeout: Duration?

If timeout triggers, an optional additional wait time before the child process is killed.

stderr

var stderr: Redirect

stderr redirection, defaults to Pipe.

stdin

var stdin: Redirect

stdin redirection, defaults to Pipe.

stdout

var stdout: Redirect

stdout redirection, defaults to Pipe.

timeout

var timeout: Duration?

Timeout for the child process. Set to null to run without timeout.

workingDirectory

var workingDirectory: String?

Subprocess working directory or null to inherit from parent.

Functions

arg

fun arg(arg: String)

Append one argument to command line.

args

fun args(vararg args: String)

Append multiple arguments to command line.

fun args(args: Collection<String>)

Append a collection of arguments to command line.

build

fun build(): ProcessArguments

Create ProcessArguments from builder.

input

inline fun input(builder: StringBuilder.() -> Unit)

Fill input using a string builder.

stderr

fun stderr(file: String, append: Boolean = false)

Write stderr to file.

stdin

fun stdin(file: String)

Read stdin from file.

stdout

fun stdout(file: String, append: Boolean = false)

Write stdout to file.