net.covers1624.quack.io

Class ProcessExecutor

java.lang.Object

net.covers1624.quack.io.ProcessExecutor

public class ProcessExecutor
extends java.lang.Object

A simple wrapper around Java's ProcessBuilder / Process system, with a better interface for IO.

Created by covers1624 on 12/01/19.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProcessExecutor.IO The IO holder for a ProcessExecutor instance.
static class	ProcessExecutor.ProcessException Generic exception for ProcessExecutor.
static class	ProcessExecutor.RunningProcess Represents a Process that has been started and is or was running.

Constructor Summary

Constructors

Constructor and Description
ProcessExecutor() Construct a blank one.
ProcessExecutor(java.lang.ProcessBuilder from) Construct from an existing ProcessBuilder.

Method Summary

Modifier and Type	Method and Description
ProcessExecutor	addCmdArg(java.lang.String arg) Adds a single argument to the command.
ProcessExecutor	addCmdArgs(java.util.List<java.lang.String> args) Adds a List of args to the command.
ProcessExecutor	addCmdArgs(java.lang.String... args) Adds an array of args to the command.
ProcessExecutor	addEnvVar(java.lang.String key, java.lang.String value) Adds an EnvVar to the ProcessExecutor.
ProcessExecutor	addEnvVars(java.util.Map<java.lang.String,java.lang.String> envVars) Adds a Map of env vars to the ProcessExecutor.
ProcessExecutor	addPreStartCallback(java.util.function.Consumer<ProcessExecutor> callback) Adds a callback that will be executed just before the Process is started.
ProcessExecutor	clearCallbacks() Clears all callbacks.
ProcessExecutor	clone() Copies the ProcessExecutor.
java.util.List<java.lang.String>	getCmd() Gets an unmodifiable list of command arguments.
java.util.Map<java.lang.String,java.lang.String>	getEnvVars() Gets this ProcessExecutors env vars.
ProcessExecutor.IO	getIO() Gets the IO holder for this ProcessExecutor.
java.io.File	getWorkingDir() Gets the working directory for the ProcessExecutor.
ProcessExecutor	setCmd(java.util.List<java.lang.String> args) Sets the command to the specified List of args.
ProcessExecutor	setCmd(java.lang.String... args) Sets the command to the specified array of args.
ProcessExecutor	setEnvVars(java.util.Map<java.lang.String,java.lang.String> envVars) Sets the Env vars for the ProcessExecutor
ProcessExecutor	setWorkingDir(java.io.File dir) Sets the working directory for the ProcessExecutor.
ProcessExecutor.RunningProcess	start() Starts the process with the current state of this ProcessExecutor.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProcessExecutor

public ProcessExecutor()

Construct a blank one.

ProcessExecutor

public ProcessExecutor(java.lang.ProcessBuilder from)

Construct from an existing ProcessBuilder. Only copies the command, working dir, and envVars.

Parameters:

from - The ProcessBuilder

Method Detail

addCmdArg

public ProcessExecutor addCmdArg(java.lang.String arg)

Adds a single argument to the command.

Parameters:

arg - The arg.

Returns:

The same ProcessExecutor.

addCmdArgs

public ProcessExecutor addCmdArgs(java.lang.String... args)

Adds an array of args to the command.

Parameters:

args - The args.

Returns:

The same ProcessExecutor

addCmdArgs

public ProcessExecutor addCmdArgs(java.util.List<java.lang.String> args)

Adds a List of args to the command.

Parameters:

args - The args.

Returns:

The same ProcessExecutor.

setCmd

public ProcessExecutor setCmd(java.lang.String... args)

Sets the command to the specified array of args.

Parameters:

args - The args.

Returns:

The same ProcessExecutor.

setCmd

public ProcessExecutor setCmd(java.util.List<java.lang.String> args)

Sets the command to the specified List of args.

Parameters:

args - The args.

Returns:

The same ProcessExecutor.

getCmd

public java.util.List<java.lang.String> getCmd()

Gets an unmodifiable list of command arguments.

Returns:

The args.

setWorkingDir

public ProcessExecutor setWorkingDir(java.io.File dir)

Sets the working directory for the ProcessExecutor.

Parameters:

dir - The dir.

Returns:

The same ProcessExecutor.

getWorkingDir

public java.io.File getWorkingDir()

Gets the working directory for the ProcessExecutor.

Returns:

The working directory.

addEnvVar

public ProcessExecutor addEnvVar(java.lang.String key,
                                 java.lang.String value)

Adds an EnvVar to the ProcessExecutor.

Parameters:

key - The key.

value - The value.

Returns:

The same ProcessExecutor.

addEnvVars

public ProcessExecutor addEnvVars(java.util.Map<java.lang.String,java.lang.String> envVars)

Adds a Map of env vars to the ProcessExecutor.

Parameters:

envVars - The env vars.

Returns:

The same ProcessExecutor.

setEnvVars

public ProcessExecutor setEnvVars(java.util.Map<java.lang.String,java.lang.String> envVars)

Sets the Env vars for the ProcessExecutor

Parameters:

envVars - The env vars.

Returns:

The same ProcessExecutor.

getEnvVars

public java.util.Map<java.lang.String,java.lang.String> getEnvVars()

Gets this ProcessExecutors env vars.

Returns:

The vars.

addPreStartCallback

public ProcessExecutor addPreStartCallback(java.util.function.Consumer<ProcessExecutor> callback)

Adds a callback that will be executed just before the Process is started.

Parameters:

callback - The callback.

Returns:

The same ProcessExecutor.

clearCallbacks

public ProcessExecutor clearCallbacks()

Clears all callbacks.

Returns:

The same ProcessExecutor.

getIO

public ProcessExecutor.IO getIO()

Gets the IO holder for this ProcessExecutor.

Returns:

The IO holder.

start

public ProcessExecutor.RunningProcess start()
                                     throws ProcessExecutor.ProcessException

Starts the process with the current state of this ProcessExecutor.

Returns:

The RunningProcess.

Throws:

ProcessExecutor.ProcessException - If the Process could not be started.

clone

public ProcessExecutor clone()

Copies the ProcessExecutor. Only copies the command arguments, working dir, env vars and callbacks. IO is completely stock on the new ProcessExecutor.

Overrides:

clone in class java.lang.Object

Returns:

The new ProcessExecutor.