ExecTools (Grolifant Core API)

```
public interface ExecTools
```
Various tools to deal with non-JVM, out-of-process executables.
Authors:
Schalk W. Cronjé
Since:
2.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`enum`	`ExecTools.OutputType`	Manage the output of external processes

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public AppRunnerSpec`	`appRunnerSpec()` Creates a AppRunnerSpec.
	`public CommandEntryPoint`	`commandEntryPoint()` Returns an implementation that is optimised for the running version of Gradle.
	`public Downloader`	`downloader(String distributionName)` Creates a new downloader for downloading packages / distributions.
	`public ExecOutput`	`exec(Action<? super ExecSpec> action)` Executes the specified external process.
	`public ExecOutput`	`exec(ExecTools.OutputType stdout, ExecTools.OutputType stderr, Action<? super ExecSpec> action)` Executes the specified external process.
	`public ExecSpec`	`execSpec()` Returns something that looks like an ExecSpec.
	`public ExecOutput`	`javaexec(Action<? super JavaExecSpec> action)` Executes the specified external java process.
	`public ExecOutput`	`javaexec(ExecTools.OutputType stdout, ExecTools.OutputType stderr, Action<? super JavaExecSpec> action)` Executes the specified external process.
	`public String`	`parseVersionFromOutput(Iterable<String> argsForVersion, File executablePath, java.util.function.Function<String, String> versionParser)` Simplifies running an executable to obtain a version.
	`public String`	`parseVersionFromOutput(Iterable<String> argsForVersion, File executablePath, java.util.function.Function<String, String> versionParser, Action<ExecSpec> configurator)` Simplifies running an executable to obtain a version.
	`public ExecOutput`	`provideExec(Action<? super ExecSpec> action)` Executes the specified external process on-demand.
	`public ExecOutput`	`provideJavaExec(Action<? super JavaExecSpec> action)` Executes the specified external java process on-demand.

- Method Detail
  - public AppRunnerSpec appRunnerSpec()
    
    Creates a AppRunnerSpec.
    This is primarily used internally by classes that implements execution specifications for non-JVM processes.
    
    Returns:
    Implementation of AppRunnerSpec
  - public CommandEntryPoint commandEntryPoint()
    
    Returns an implementation that is optimised for the running version of Gradle.
    Returns:
    Instance of CommandEntryPoint. Never null
  - public Downloader downloader(String distributionName)
    
    Creates a new downloader for downloading packages / distributions.
    Parameters:
    distributionName - Name of distribution to be downloaded.
    Returns:
    Instance of Downloader that is optimised for the running Gradle version.
  - public ExecOutput exec(Action<? super ExecSpec> action)
    
    Executes the specified external process.
    Accepts whatever is already configured on the outputs. Typically this will output both standard error and standard out, and captures nothing.
    
    Parameters:
    action - Configures an ExecSpec
    Returns:
    ExecOutput that can be used to check if the execution worked.
    Since:
    5.0
  - public ExecOutput exec(ExecTools.OutputType stdout, ExecTools.OutputType stderr, Action<? super ExecSpec> action)
    
    Executes the specified external process.
    Parameters:
    stdout - How to capture standard output.
    stderr - How to capture error output.
    action - Configures an ExecSpec
    Returns:
    ExecResult that can be used to check if the execution worked.
    Since:
    5.0
  - public ExecSpec execSpec()
    
    Returns something that looks like an ExecSpec.
    Returns:
    Instance of an executable specification.
  - public ExecOutput javaexec(Action<? super JavaExecSpec> action)
    
    Executes the specified external java process.
    Outputs both standard error and standard out, but captures nothing.
    
    Parameters:
    action - Configures a JavaExecSpec
    Returns:
    ExecOutput that can be used to check if the execution worked.
    Since:
    5.0
  - public ExecOutput javaexec(ExecTools.OutputType stdout, ExecTools.OutputType stderr, Action<? super JavaExecSpec> action)
    
    Executes the specified external process.
    Parameters:
    stdout - How to capture standard output.
    stderr - How to capture error output.
    action - Configures an ExecSpec
    Returns:
    ExecOutput that can be used to check if the execution worked.
    Since:
    5.0
  - public String parseVersionFromOutput(Iterable<String> argsForVersion, File executablePath, java.util.function.Function<String, String> versionParser)
    
    Simplifies running an executable to obtain a version. This is primarily used to implement a runExecutableAndReturnVersion method.
    Parameters:
    argsForVersion - Arguments required to obtain a version
    executablePath - Location of the executable
    versionParser - A parser for the output of running the executable which could extract the version.
    Returns:
    The version string.
  - public String parseVersionFromOutput(Iterable<String> argsForVersion, File executablePath, java.util.function.Function<String, String> versionParser, Action<ExecSpec> configurator)
    
    Simplifies running an executable to obtain a version. This is primarily used to implement a runExecutableAndReturnVersion method.
    Parameters:
    argsForVersion - Arguments required to obtain a version
    executablePath - Location of the executable
    versionParser - A parser for the output of running the executable which could extract the version.
    configurator - Additional configurator to customise the execution specification.
    Returns:
    The version string.
  - public ExecOutput provideExec(Action<? super ExecSpec> action)
    
    Executes the specified external process on-demand.
    Parameters:
    action - Configures an ExecSpec
    Returns:
    ExecOutput that can be used to check if the execution worked.
    Since:
    5.0
  - public ExecOutput provideJavaExec(Action<? super JavaExecSpec> action)
    
    Executes the specified external java process on-demand.
    Parameters:
    action - Configures a JavaExecSpec
    Returns:
    ExecOutput that can be used to check if the execution worked.
    Since:
    5.0

Summary:
Nested
Method

| Detail:
Method

Groovy Documentation

[Java] Interface ExecTools

Nested Class Summary

Methods Summary

Method Detail

public AppRunnerSpec appRunnerSpec()

public CommandEntryPoint commandEntryPoint()

public Downloader downloader(String distributionName)

public ExecOutput exec(Action<? super ExecSpec> action)

public ExecOutput exec(ExecTools.OutputType stdout, ExecTools.OutputType stderr, Action<? super ExecSpec> action)

public ExecSpec execSpec()

public ExecOutput javaexec(Action<? super JavaExecSpec> action)

public ExecOutput javaexec(ExecTools.OutputType stdout, ExecTools.OutputType stderr, Action<? super JavaExecSpec> action)

public String parseVersionFromOutput(Iterable<String> argsForVersion, File executablePath, java.util.function.Function<String, String> versionParser)

public String parseVersionFromOutput(Iterable<String> argsForVersion, File executablePath, java.util.function.Function<String, String> versionParser, Action<ExecSpec> configurator)

public ExecOutput provideExec(Action<? super ExecSpec> action)

public ExecOutput provideJavaExec(Action<? super JavaExecSpec> action)