ProcBuilder (jproc VERSION API)

java.lang.Object
- org.buildobjects.process.ProcBuilder

```
public class ProcBuilder
extends Object
```
A builder to construct a new process. The process gets configured by the withXXX-methods and spawned by the run() method

Constructor Summary

Constructors
Constructor and Description

ProcBuilder(String command, String... args)
Creates a new ProcBuilder

Constructors
Constructor and Description
`ProcBuilder(String command, String... args)` Creates a new ProcBuilder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static String`	`filter(String input, String cmd, String... args)` Static helper to filter a string through a process
`ProcBuilder`	`ignoreExitStatus()` Ignore the error status returned from this command
`ProcResult`	`run()` Spawn the actual execution.
`static String`	`run(String cmd, String... args)` Static helper to run a process
`ProcBuilder`	`withArg(String arg)` Adds another argument
`ProcBuilder`	`withArgs(String... args)` Add multiple args
`ProcBuilder`	`withExitStatuses(int[] exitstatuses)` Deprecated. Please use the variants with a set or vargs parameters
`ProcBuilder`	`withExpectedExitStatuses(int... expectedExitStatuses)` Define the valid exit status codes for the command Convenience method taking varargs.
`ProcBuilder`	`withExpectedExitStatuses(Set<Integer> expectedExitStatuses)` Define the valid exit status codes for the command
`ProcBuilder`	`withInputStream(InputStream stdin)` Take the input for the program from a given InputStream
`ProcBuilder`	`withNoTimeout()` Disable timeout for the operation.
`ProcBuilder`	`withOutputConsumer(StreamConsumer outputConsumer)` Process the standard output with the given consumer object
`ProcBuilder`	`withOutputStream(OutputStream stdout)` Redirecting the standard output.
`ProcBuilder`	`withTimeoutMillis(long timeoutMillis)` Specify a timeout for the operation.
`ProcBuilder`	`withVar(String var, String value)` Add a variable to the processes environment
`ProcBuilder`	`withWorkingDirectory(File directory)` Override the wokring directory

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

- Constructor Detail
  - ProcBuilder
```
public ProcBuilder(String command,
                   String... args)
```
    Creates a new ProcBuilder
    
    Parameters:
    
    command - The command to run
    
    args - The command line arguments
- Method Detail
  - withArg
```
public ProcBuilder withArg(String arg)
```
    Adds another argument
    
    Parameters:
    
    arg - to add
    
    Returns:
    
    this, for chaining
  - withOutputStream
```
public ProcBuilder withOutputStream(OutputStream stdout)
```
    Redirecting the standard output. If it is not redirected the output gets captured in memory and is available on the @see ProcResult
    
    Parameters:
    
    stdout - stream to redirect the output to. \
    
    Returns:
    
    this, for chaining
  - withTimeoutMillis
```
public ProcBuilder withTimeoutMillis(long timeoutMillis)
```
    Specify a timeout for the operation. If not specified the default is 5 seconds.
    
    Parameters:
    
    timeoutMillis - time that the process gets to run
    
    Returns:
    
    this, for chaining
  - withNoTimeout
```
public ProcBuilder withNoTimeout()
```
    Disable timeout for the operation.
    
    Returns:
    
    this, for chaining
  - withInputStream
```
public ProcBuilder withInputStream(InputStream stdin)
```
    Take the input for the program from a given InputStream
    
    Parameters:
    
    stdin - stream to read the input from
    
    Returns:
    
    this, for chaining
  - withWorkingDirectory
```
public ProcBuilder withWorkingDirectory(File directory)
```
    Override the wokring directory
    
    Parameters:
    
    directory - the working directory for the process
    
    Returns:
    
    this, for chaining
  - withArgs
```
public ProcBuilder withArgs(String... args)
```
    Add multiple args
    
    Parameters:
    
    args - the arguments add
    
    Returns:
    
    this, for chaining
  - withExitStatuses
```
public ProcBuilder withExitStatuses(int[] exitstatuses)
```
    Deprecated. Please use the variants with a set or vargs parameters
    
    Define the valid exit status codes for the command
    
    Parameters:
    
    exitstatuses - array containing the exit codes that are valid
    
    Returns:
    
    the ProcBuilder object; permits chaining.
  - withExpectedExitStatuses
```
public ProcBuilder withExpectedExitStatuses(Set<Integer> expectedExitStatuses)
```
    Define the valid exit status codes for the command
    
    Parameters:
    
    expectedExitStatuses - array containing the exit codes that are valid
    
    Returns:
    
    the ProcBuilder object; permits chaining.
  - withExpectedExitStatuses
```
public ProcBuilder withExpectedExitStatuses(int... expectedExitStatuses)
```
    Define the valid exit status codes for the command Convenience method taking varargs.
    
    Parameters:
    
    expectedExitStatuses - varargs parameter containing the exit codes that are valid
    
    Returns:
    
    the ProcBuilder object; permits chaining.
  - ignoreExitStatus
```
public ProcBuilder ignoreExitStatus()
```
    Ignore the error status returned from this command
    
    Returns:
    
    the ProcBuilder object; permits chaining.
  - run
```
public ProcResult run()
               throws StartupException,
                      TimeoutException,
                      ExternalProcessFailureException
```
    Spawn the actual execution. This will block until the process terminates.
    
    Returns:
    
    the result of the successful execution
    
    Throws:
    
    StartupException - if the process can't be started
    
    TimeoutException - if the timeout kicked in
    
    ExternalProcessFailureException - if the external process returned a non-null exit value
  - run
```
public static String run(String cmd,
                         String... args)
```
    Static helper to run a process
    
    Parameters:
    
    cmd - the command
    
    args - the arguments
    
    Returns:
    
    the standard output
    
    Throws:
    
    StartupException - if the process can't be started
    
    TimeoutException - if the timeout kicked in
    
    ExternalProcessFailureException - if the external process returned a non-null exit value
  - filter
```
public static String filter(String input,
                            String cmd,
                            String... args)
```
    Static helper to filter a string through a process
    
    Parameters:
    
    input - the input to be fed into the process
    
    cmd - the command
    
    args - the arguments
    
    Returns:
    
    the standard output
    
    Throws:
    
    StartupException - if the process can't be started
    
    TimeoutException - if the timeout kicked in
    
    ExternalProcessFailureException - if the external process returned a non-null exit value
  - withVar
```
public ProcBuilder withVar(String var,
                           String value)
```
    Add a variable to the processes environment
    
    Parameters:
    
    var - variable name
    
    value - the value to be passed in
    
    Returns:
    
    this, for chaining
  - withOutputConsumer
```
public ProcBuilder withOutputConsumer(StreamConsumer outputConsumer)
```
    Process the standard output with the given consumer object
    
    Parameters:
    
    outputConsumer - an object that defines how to process the standard output stream
    
    Returns:
    
    this, for chaining

Class ProcBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProcBuilder

Method Detail

withArg

withOutputStream

withTimeoutMillis

withNoTimeout

withInputStream

withWorkingDirectory

withArgs

withExitStatuses

withExpectedExitStatuses

withExpectedExitStatuses

ignoreExitStatus

run

run

filter

withVar

withOutputConsumer