CommandLineTool (docs 0.5.0-930919a0 API)

All Known Subinterfaces:

MetadataAwareCommandLineTool
```
public interface CommandLineTool
```
A command line tool represent a executable component that can be used as a tool. The tool may be a executable, a script (batch, bash, python, etc.), executable JAR, etc. The requirements of the tool will be processed by the invocation before submitting to the execution engine.

Since:

0.4

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`<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())`.
`static Optional<CommandLineTool>`	`fromPath(String executable)`
`String`	`getExecutable()`
`CommandLineToolInvocationBuilder`	`newInvocation()` Prepares a new invocation via the `CommandLineToolInvocationBuilder`.
`static CommandLineTool`	`of(File executable)`
`static CommandLineTool`	`of(Object executable)`
`CommandLine`	`withArguments(Iterable<?> arguments)` Creates a command line from this tool and the specified arguments.
`CommandLine`	`withArguments(Object... arguments)` Creates a command line from this tool and the specified arguments.

- Method Detail
  - fromPath
```
static Optional<CommandLineTool> fromPath(String executable)
```
  - of
```
static CommandLineTool of(File executable)
```
  - of
```
static CommandLineTool of(Object executable)
```
  - getExecutable
```
@Internal
String getExecutable()
```
  - withArguments
```
CommandLine withArguments(Object... arguments)
```
    Creates a command line from this tool and the specified arguments.
    
    Parameters:
    
    arguments - the arguments forming a CommandLine with this tool.
    
    Returns:
    
    a CommandLine instance of this tool with the specified arguments, never null.
  - withArguments
```
CommandLine withArguments(Iterable<?> arguments)
```
    Creates a command line from this tool and the specified arguments.
    
    Parameters:
    
    arguments - the arguments forming a CommandLine with this tool.
    
    Returns:
    
    a CommandLine instance of this tool with the specified arguments, never null.
    
    Since:
    
    0.5
  - 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.
    
    Since:
    
    0.5
  - 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.
    
    Since:
    
    0.5
  - 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

Interface CommandLineTool

Method Summary

Method Detail

fromPath

of

of

getExecutable

withArguments

withArguments

newInvocation

execute

execute