CommandLine (docs 0.5.0-930919a0 API)

```
public interface CommandLine
```
A command line is composed of a tool with zero or more arguments. The execution of the command can proceed in two ways:
- Configure the invocation before proceeding with the execution, see newInvocation()
- Proceed with the execution right now (provided for convenience), see execute(CommandLineToolExecutionEngine)
Since:

0.4

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`ProcessBuilderEngine.Handle`	`execute()`
`<T extends CommandLineToolExecutionHandle> T`	`execute(CommandLineToolExecutionEngine<T> engine)` Convenience for `newInvocation().build().submit(engine)`.
`ProcessBuilderEngine.Handle`	`execute(List<?> env, File workingDirectory)` Convenience for `newInvocation().withEnvironmentVariables(CommandLineToolInvocationEnvironmentVariables.from(env)).workingDirectory(workingDirectory).build().submit(new ProcessBuilderEngine())`.
`CommandLineToolArguments`	`getArguments()` Returns the arguments of the current command line.
`CommandLineTool`	`getTool()` Returns the tool of the current command line.
`CommandLineToolInvocationBuilder`	`newInvocation()` Prepares a new invocation via the `CommandLineToolInvocationBuilder`.
`static CommandLine`	`of(@NonNull List<?> commandLine)` Creates a `CommandLine` instance from the command line elements specified.
`static CommandLine`	`of(Object... commandLine)` Creates a `CommandLine` instance from the command line elements specified.
`static CommandLine`	`script(Object... commandLine)` Creates a `CommandLine` instance using the scripting environment to execute the specified command line.

- Method Detail
  - getTool
```
CommandLineTool getTool()
```
    Returns the tool of the current command line.
    
    Returns:
    
    a CommandLineTool instance representing the tool to execute, never null.
  - getArguments
```
CommandLineToolArguments getArguments()
```
    Returns the arguments of the current command line.
    
    Returns:
    
    a CommandLineToolArguments instance representing all the arguments, never null.
  - newInvocation
```
CommandLineToolInvocationBuilder newInvocation()
```
    Prepares a new invocation via the CommandLineToolInvocationBuilder. The invocation is responsible for configuring the working directory, environment variables, standard stream manipulation, etc.
    
    Returns:
    
    a CommandLineToolInvocationBuilder instance, never null.
  - execute
```
<T extends CommandLineToolExecutionHandle> T execute(CommandLineToolExecutionEngine<T> engine)
```
    Convenience for newInvocation().build().submit(engine).
    
    Parameters:
    
    engine - the executing engine to use, cannot be null
    
    Returns:
    
    a CommandLineToolExecutionHandle representing the execution in progress, never null.
  - execute
```
ProcessBuilderEngine.Handle execute(@Nullable
                                    List<?> env,
                                    File workingDirectory)
```
    Convenience for newInvocation().withEnvironmentVariables(CommandLineToolInvocationEnvironmentVariables.from(env)).workingDirectory(workingDirectory).build().submit(new ProcessBuilderEngine()). This API behave similarly to the Groovy API.
    
    Parameters:
    
    env - the environment variable to invoke the process with, null means inherited.
    
    workingDirectory - the working directory to invoke the process in, null means inherited.
    
    Returns:
    
    a ProcessBuilderEngine.Handle representing the execution in progress, never null.
    
    Since:
    
    0.5
  - execute
```
ProcessBuilderEngine.Handle execute()
```
  - of
```
static CommandLine of(Object... commandLine)
```
    Creates a CommandLine instance from the command line elements specified.
    
    Parameters:
    
    commandLine - the command line elements, cannot be empty or contains null values.
    
    Returns:
    
    a CommandLine instance representing the specified command line, never null.
  - of
```
static CommandLine of(@NonNull
                      @NonNull List<?> commandLine)
```
    Creates a CommandLine instance from the command line elements specified.
    
    Parameters:
    
    commandLine - the command line elements, cannot be empty or contains null values.
    
    Returns:
    
    a CommandLine instance representing the specified command line, never null.
  - script
```
static CommandLine script(Object... commandLine)
```
    Creates a CommandLine instance using the scripting environment to execute the specified command line. The scripting environment will be cmd /c on Windows or bash -c on *nix.
    
    Parameters:
    
    commandLine - the command line elements, cannot be empty or contains null values.
    
    Returns:
    
    a CommandLine instance representing the specified command line executing in the scripting environment, never null.

Interface CommandLine

Method Summary

Method Detail

getTool

getArguments

newInvocation

execute

execute

execute

of

of

script