com.emphysic.myriad.core.data.util

Class ExternalProcess

java.lang.Object

com.emphysic.myriad.core.data.util.ExternalProcess

public class ExternalProcess
extends java.lang.Object

ExternalProcess - wrapper class for execution and interaction with an external process

Constructor Summary

Constructors

Constructor and Description
ExternalProcess() Empty constructor for serialization
ExternalProcess(ExternalProcess orig) Copy constructor
ExternalProcess(java.lang.String cmd) Creates a new ExternalProcess with no command line arguments, default working folder, and the current environment variables.
ExternalProcess(java.lang.String cmd, java.util.List<java.lang.String> args) Creates a new ExternalProcess with the default working folder and the current environment variables.
ExternalProcess(java.lang.String cmd, java.util.List<java.lang.String> args, java.util.Map<java.lang.String,java.lang.String> environment, java.io.File workingFolder) Creates a new ExternalProcess

Method Summary

Modifier and Type	Method and Description
void	addArgument(java.lang.String arg) Appends a command line argument to the end of the current list.
void	addArgument(java.lang.String arg, int index) Adds a command line argument
void	addEnvironmentVariable(java.lang.String key, java.lang.String value) Adds/overwrites an environment variable.
void	delArgument(java.lang.String arg) Removes a command line argument if it exists.
void	delEnvironmentVariable(java.lang.String key) Removes an environment variable if it exists.
java.util.List<java.lang.String>	getArgs() Returns the list of arguments, where the first element is the command to run i.e.
java.lang.String	getCmd() Gets the current command
java.util.Map<java.lang.String,java.lang.String>	getEnv() Returns the environment variable settings for the external process.
java.lang.Process	getProcess() Returns a handle to the external process
java.io.File	getWorkingFolder() Gets the current working folder for the external process.
void	setArgs(java.util.List<java.lang.String> args) Sets the command line arguments.
void	setCmd(java.lang.String cmd) Sets the command to execute.
void	setEnv(java.util.Map<java.lang.String,java.lang.String> env) Sets the environment for the external process.
void	setWorkingFolder(java.io.File workingFolder) Sets the working folder for the external process.
void	start() Starts the external process

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalProcess

public ExternalProcess()

Empty constructor for serialization

ExternalProcess

public ExternalProcess(java.lang.String cmd,
                       java.util.List<java.lang.String> args,
                       java.util.Map<java.lang.String,java.lang.String> environment,
                       java.io.File workingFolder)

Creates a new ExternalProcess

Parameters:

cmd - command to execute

args - command line arguments

environment - environment variables

workingFolder - working folder

ExternalProcess

public ExternalProcess(java.lang.String cmd)

Creates a new ExternalProcess with no command line arguments, default working folder, and the current environment variables.

Parameters:

cmd - command

ExternalProcess

public ExternalProcess(java.lang.String cmd,
                       java.util.List<java.lang.String> args)

Creates a new ExternalProcess with the default working folder and the current environment variables.

Parameters:

cmd - command

args - command line arguments

ExternalProcess

public ExternalProcess(ExternalProcess orig)

Copy constructor

Parameters:

orig - original ExternalProcess to copy

Method Detail

addEnvironmentVariable

public void addEnvironmentVariable(java.lang.String key,
                                   java.lang.String value)

Adds/overwrites an environment variable.

Parameters:

key - environment variable name

value - environment variable value

delEnvironmentVariable

public void delEnvironmentVariable(java.lang.String key)

Removes an environment variable if it exists.

Parameters:

key - key to remove

addArgument

public void addArgument(java.lang.String arg,
                        int index)

Adds a command line argument

Parameters:

arg - argument to add

index - position of the argument

addArgument

public void addArgument(java.lang.String arg)

Appends a command line argument to the end of the current list.

Parameters:

arg - argument to append

delArgument

public void delArgument(java.lang.String arg)

Removes a command line argument if it exists.

Parameters:

arg - argument to remove

start

public void start()
           throws java.io.IOException

Starts the external process

Throws:

java.io.IOException - if an error occurs

java.lang.NullPointerException - if the command or any argument was passed as null

getEnv

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

Returns the environment variable settings for the external process.

Returns:

process' environment

setEnv

public void setEnv(java.util.Map<java.lang.String,java.lang.String> env)

Sets the environment for the external process.

Parameters:

env - new environment

getArgs

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

Returns the list of arguments, where the first element is the command to run i.e. args.get(0) = cmd.

Returns:

command line arguments

setArgs

public void setArgs(java.util.List<java.lang.String> args)

Sets the command line arguments.

Parameters:

args - arguments

setWorkingFolder

public void setWorkingFolder(java.io.File workingFolder)

Sets the working folder for the external process.

Parameters:

workingFolder - new working folder

getWorkingFolder

public java.io.File getWorkingFolder()

Gets the current working folder for the external process.

Returns:

working folder

getCmd

public java.lang.String getCmd()

Gets the current command

Returns:

command

setCmd

public void setCmd(java.lang.String cmd)

Sets the command to execute.

Parameters:

cmd - command

getProcess

public java.lang.Process getProcess()

Returns a handle to the external process

Returns:

handle, or null if the process is not running @see #ExternalProcess.start()