CommandLineTool 17.0.0 API

All Implemented Interfaces:
```
public interface CommandLineTool

                    
```
An interface to implement by classes that are backed by a command line tool.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`CommandLineTool.Companion`

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract String`	`command(File workingDir)`	Return the name of the executable command.
`String`	`getVersionArguments()`	Get the arguments to pass to the command in order to get its version.
`String`	`transformVersion(String output)`	Transform the command's version output to a string that only contains the version.
`RangesList`	`getVersionRequirement()`	Return the requirement for the version of the command.
`Boolean`	`isInPath()`	Return whether the executable for this command is available in the system PATH.
`ProcessCapture`	`run(CharSequence args, File workingDir, Map<String, String> environment)`	Run the command in the workingDir directory with arguments as specified by args and the given environment.
`ProcessCapture`	`run(File workingDir, CharSequence args)`	Run the command in the workingDir directory with arguments as specified by args.
`String`	`getVersion(File workingDir)`	Get the version of the command by parsing its output.
`Unit`	`checkVersion(File workingDir)`	Run a command to check its version against the required version.

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

- Constructor Detail
- Method Detail
  - command
```
 abstract String command(File workingDir)
```
    Return the name of the executable command. As the preferred command might depend on the directory to operate in the workingDir can be provided.
  - getVersionArguments
```
 String getVersionArguments()
```
    Get the arguments to pass to the command in order to get its version.
  - transformVersion
```
 String transformVersion(String output)
```
    Transform the command's version output to a string that only contains the version.
  - getVersionRequirement
```
 RangesList getVersionRequirement()
```
    Return the requirement for the version of the command. Defaults to any version.
  - isInPath
```
 Boolean isInPath()
```
    Return whether the executable for this command is available in the system PATH.
  - run
```
 ProcessCapture run(CharSequence args, File workingDir, Map<String, String> environment)
```
    Run the command in the workingDir directory with arguments as specified by args and the given environment.
  - run
```
 ProcessCapture run(File workingDir, CharSequence args)
```
    Run the command in the workingDir directory with arguments as specified by args.
  - getVersion
```
 String getVersion(File workingDir)
```
    Get the version of the command by parsing its output.
  - checkVersion
```
 Unit checkVersion(File workingDir)
```
    Run a command to check its version against the required version.