Executor (com.hfg API Documentation)

java.lang.Object
- com.hfg.util.Executor

```
public class Executor
extends Object
```
More robust wrapper for Process.exec().

Constructor Summary

Constructors
Constructor and Description
`Executor()` Default constructor.
`Executor(String inCommand)` Constructor specifying the command to execute.
`Executor(String[] inCommand)` Constructor specifying the command to execute.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEnvVar(String inName, String inValue)` Adds the specified environment variable to the list to be set when executing the command.
`void`	`clearEnvVars()` Clears the list of environment variables to be set when executing the command.
`int`	`exec()` Executes the command.
`String`	`getCommand()` Returns the command to execute.
`long`	`getExecutionTimeMillis()` Returns the execution time in milliseconds of executed command.
`File`	`getShell()` Returns the shell to be used for command execution.
`String`	`getSTDERR()` Returns the STDERR output produced by the executed command.
`String`	`getSTDOUT()` Returns the STDOUT output produced by the executed command.
`File`	`getWorkingDir()` Returns the working directory for command execution.
`void`	`setCommand(String inCommand)` Sets the command to execute.
`void`	`setShell(File inValue)` Sets the shell to be used for command execution.
`void`	`setSTDIN(InputStream inValue)` Sets the STDIN content for the command to be executed.
`void`	`setSTDIN(String inValue)` Sets the STDIN content for the command to be executed.
`void`	`setWorkingDir(File inValue)` Sets the working directory for command execution.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Executor
```
public Executor()
```
    Default constructor.
  - Executor
```
public Executor(String inCommand)
```
    Constructor specifying the command to execute.
  - Executor
```
public Executor(String[] inCommand)
```
    Constructor specifying the command to execute.
- Method Detail
  - setCommand
```
public void setCommand(String inCommand)
```
    Sets the command to execute.
  - getCommand
```
public String getCommand()
```
    Returns the command to execute.
  - clearEnvVars
```
public void clearEnvVars()
```
    Clears the list of environment variables to be set when executing the command. IMPORTANT! If the environment variables are cleared it does NOT mean that no environment variables are present, but rather that the parent process' environment variables are inherited.
  - addEnvVar
```
public void addEnvVar(String inName,
                      String inValue)
```
    Adds the specified environment variable to the list to be set when executing the command. IMPORTANT! If environment variables are specified they are specified IN PLACE OF the parent process' environment variables and NOT in addition to them.
  - setShell
```
public void setShell(File inValue)
```
    Sets the shell to be used for command execution. The default is '/bin/csh'. To run the command without a <shell> -c '<cmd>' construct, set the shell to null.
  - getShell
```
public File getShell()
```
    Returns the shell to be used for command execution.
  - setWorkingDir
```
public void setWorkingDir(File inValue)
```
    Sets the working directory for command execution.
  - getWorkingDir
```
public File getWorkingDir()
```
    Returns the working directory for command execution.
  - setSTDIN
```
public void setSTDIN(String inValue)
```
    Sets the STDIN content for the command to be executed.
  - setSTDIN
```
public void setSTDIN(InputStream inValue)
```
    Sets the STDIN content for the command to be executed.
  - getSTDOUT
```
public String getSTDOUT()
```
    Returns the STDOUT output produced by the executed command.
  - getSTDERR
```
public String getSTDERR()
```
    Returns the STDERR output produced by the executed command.
  - getExecutionTimeMillis
```
public long getExecutionTimeMillis()
```
    Returns the execution time in milliseconds of executed command. This is wall time, not CPU time.
  - exec
```
public int exec()
         throws ExecutorException
```
    Executes the command.
    
    Returns:
    
    the exit value of the executed command.
    
    Throws:
    
    ExecutorException

Class Executor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Executor

Executor

Executor

Method Detail

setCommand

getCommand

clearEnvVars

addEnvVar

setShell

getShell

setWorkingDir

getWorkingDir

setSTDIN

setSTDIN

getSTDOUT

getSTDERR

getExecutionTimeMillis

exec