ProcessInstance (Sponge - API 1.16.0 API)

```
public interface ProcessInstance
```
A process instance.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`destroy()` Kills the subprocess.
`boolean`	`destroy(long timeout, TimeUnit unit)` Kills the subprocess.
`ProcessConfiguration`	`getConfiguration()` Returns the process configuration.
`InputStream`	`getError()` Returns the process error output.
`String`	`getErrorString()` Returns the process error output as a string.
`int`	`getExitCode()` Returns the exit value for the subprocess.
`OutputStream`	`getInput()` Returns the process standard input.
`Process`	`getInternalProcess()` Returns the underlying process.
`InputStream`	`getOutput()` Returns the process standard output.
`byte[]`	`getOutputBinary()` Returns the process standard output as bytes.
`String`	`getOutputString()` Returns the process standard output as a string.
`Instant`	`getStartTime()` Returns the process start time.
`boolean`	`isAlive()` Tests whether the subprocess is alive.
`boolean`	`isWaitSecondsTimedOut()` Returns `true` if the process exited before the waiting time specified by ProcessConfiguration.getWaitSeconds() elapsed.
`ProcessInstance`	`run()` Runs a new process synchronously.
`ProcessInstance`	`runAsync()` Runs a new process asynchronously.
`void`	`setErrorString(String errorString)` Sets the process error output as a string.
`void`	`setOutputBinary(byte[] outputBinary)` Sets the process standard output as bytes.
`void`	`setOutputString(String outputString)` Sets the process standard output as a string.
`void`	`setStartTime(Instant startTime)` Sets the process start time.
`void`	`setWaitSecondsTimedOut(boolean waitSecondsTimedOut)` Sets the info that tells if the process exited before the waiting time specified by ProcessConfiguration.getWaitSeconds() elapsed.
`int`	`waitFor()` Invokes `waitFor()` in the underlying process.
`boolean`	`waitFor(long timeout, TimeUnit unit)` Invokes `waitFor(timeout, unit)` in the underlying process.
`void`	`waitForReady()` Waits until the process is ready.

- Method Detail
  - getInternalProcess
```
Process getInternalProcess()
```
    Returns the underlying process.
    
    Returns:
    
    the process.
  - getConfiguration
```
ProcessConfiguration getConfiguration()
```
    Returns the process configuration.
    
    Returns:
    
    the process configuration.
  - getOutputString
```
String getOutputString()
```
    Returns the process standard output as a string.
    
    Returns:
    
    the process standard output as a string.
  - setOutputString
```
void setOutputString(String outputString)
```
    Sets the process standard output as a string.
    
    Parameters:
    
    outputString - the process standard output as a string.
  - getOutputBinary
```
byte[] getOutputBinary()
```
    Returns the process standard output as bytes.
    
    Returns:
    
    the process standard output as bytes.
  - setOutputBinary
```
void setOutputBinary(byte[] outputBinary)
```
    Sets the process standard output as bytes.
    
    Parameters:
    
    outputBinary - the process standard output as bytes.
  - getErrorString
```
String getErrorString()
```
    Returns the process error output as a string.
    
    Returns:
    
    the process error output as a string.
  - setErrorString
```
void setErrorString(String errorString)
```
    Sets the process error output as a string.
    
    Parameters:
    
    errorString - the process error output as a string.
  - getStartTime
```
Instant getStartTime()
```
    Returns the process start time.
    
    Returns:
    
    the process start time.
  - setStartTime
```
void setStartTime(Instant startTime)
```
    Sets the process start time.
    
    Parameters:
    
    startTime - the process start time.
  - isWaitSecondsTimedOut
```
boolean isWaitSecondsTimedOut()
```
    Returns true if the process exited before the waiting time specified by ProcessConfiguration.getWaitSeconds() elapsed.
    
    Returns:
    
    the timeout info.
  - setWaitSecondsTimedOut
```
void setWaitSecondsTimedOut(boolean waitSecondsTimedOut)
```
    Sets the info that tells if the process exited before the waiting time specified by ProcessConfiguration.getWaitSeconds() elapsed.
    
    Parameters:
    
    waitSecondsTimedOut - true if the timeout happened.
  - getInput
```
OutputStream getInput()
```
    Returns the process standard input.
    
    Returns:
    
    the process standard input.
  - getOutput
```
InputStream getOutput()
```
    Returns the process standard output.
    
    Returns:
    
    the process standard output.
  - getError
```
InputStream getError()
```
    Returns the process error output.
    
    Returns:
    
    the process error output.
  - run
```
ProcessInstance run()
             throws InterruptedException
```
    Runs a new process synchronously. Should be invoked only once. Waits for the process exit.
    If the input redirect type is STREAM you should invoke ProcessInstance.runAsync().
    
    Returns:
    
    this process instance.
    
    Throws:
    
    InterruptedException - on interrupted.
  - runAsync
```
ProcessInstance runAsync()
                  throws InterruptedException
```
    Runs a new process asynchronously. Should be invoked only once. Waits for the process exit only if necessary (in compliance with the configuration).
    If the input redirect type is STREAM you should invoke manually ProcessInstance.waitForReady() after writing to and closing the subprocess standard input ProcessInstance.getInput().
    
    Returns:
    
    this process instance.
    
    Throws:
    
    InterruptedException - on interrupted.
  - waitForReady
```
void waitForReady()
           throws InterruptedException
```
    Waits until the process is ready. A process readiness depends on the configuration. In most cases this method is invoked automatically after the start of the process and doesn't have to be invoked explicitly.
    
    Throws:
    
    InterruptedException - on interrupted.
  - waitFor
```
int waitFor()
     throws InterruptedException
```
    Invokes waitFor() in the underlying process. If not run previously, invokes waitForReady() first.
    
    Returns:
    
    the exit value of the subprocess.
    
    Throws:
    
    InterruptedException - on interrupted.
  - waitFor
```
boolean waitFor(long timeout,
                TimeUnit unit)
         throws InterruptedException
```
    Invokes waitFor(timeout, unit) in the underlying process. If not run previously, invokes waitForReady() first.
    
    Parameters:
    
    timeout - the maximum time to wait.
    
    unit - the time unit of the timeout argument.
    
    Returns:
    
    true if the subprocess has exited and false if the waiting time elapsed before the subprocess has exited.
    
    Throws:
    
    InterruptedException - on interrupted.
  - isAlive
```
boolean isAlive()
```
    Tests whether the subprocess is alive.
    
    Returns:
    
    true if the subprocess is alive.
  - destroy
```
void destroy()
      throws InterruptedException
```
    Kills the subprocess.
    
    Throws:
    
    InterruptedException - on interrupted.
  - destroy
```
boolean destroy(long timeout,
                TimeUnit unit)
         throws InterruptedException
```
    Kills the subprocess.
    
    Parameters:
    
    timeout - the maximum time to wait.
    
    unit - the time unit of the timeout argument.
    
    Returns:
    
    true if the subprocess has exited and false if the waiting time elapsed before the subprocess has exited.
    
    Throws:
    
    InterruptedException - on interrupted.
  - getExitCode
```
int getExitCode()
```
    Returns the exit value for the subprocess.
    
    Returns:
    
    the exit value for the subprocess.

Interface ProcessInstance

Method Summary

Method Detail

getInternalProcess

getConfiguration

getOutputString

setOutputString

getOutputBinary

setOutputBinary

getErrorString

setErrorString

getStartTime

setStartTime

isWaitSecondsTimedOut

setWaitSecondsTimedOut

getInput

getOutput

getError

run

runAsync

waitForReady

waitFor

waitFor

isAlive

destroy

destroy

getExitCode