DefaultExecTools (grolifant5-90 5.3.0-milestone.1 API)

org.ysb33r.grolifant5.loadable.v9.DefaultExecTools

All Implemented Interfaces and Traits:

org.ysb33r.grolifant5.api.core.ExecTools
```
@groovy.transform.CompileStatic
class DefaultExecTools
extends Object
implements org.ysb33r.grolifant5.api.core.ExecTools
```
Non-JVM process execution tools for Gradle 8.x.
Authors:
Schalk W. Cronjé
Since:
5.3

Constructor Summary

Constructors
Constructor and description
`DefaultExecTools(Project tempProjectReference, ObjectFactory objF, ProviderFactory pf, ProjectLayout pl, ExecOperations execOps)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`org.ysb33r.grolifant5.api.core.executable.AppRunnerSpec`	`appRunnerSpec()` Creates a org.ysb33r.grolifant5.api.core.executable.AppRunnerSpec.
	`org.ysb33r.grolifant5.api.core.executable.CommandEntryPoint`	`commandEntryPoint()` Returns an implementation that is optimised for the running version of Gradle.
	`org.ysb33r.grolifant5.api.core.downloader.Downloader`	`downloader(String distributionName)` Creates a new downloader for downloading packages / distributions.
	`org.ysb33r.grolifant5.api.core.runnable.ExecOutput`	`exec(OutputType stdout, OutputType stderr, Action<? super ExecSpec> action)` Executes the specified external process.
	`ExecSpec`	`execSpec()` Returns something that looks like an ExecSpec.
	`org.ysb33r.grolifant5.api.core.runnable.ExecOutput`	`javaexec(OutputType stdout, OutputType stderr, Action<? super JavaExecSpec> action)` Executes the specified external process.
	`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.
	`org.ysb33r.grolifant5.api.core.runnable.ExecOutput`	`provideExec(Action<? super ExecSpec> action)` Executes the specified external process on-demand.
	`org.ysb33r.grolifant5.api.core.runnable.ExecOutput`	`provideJavaExec(Action<? super JavaExecSpec> action)` Executes the specified external java process on-demand.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Constructor Detail
  - @javax.inject.Inject
    DefaultExecTools(Project tempProjectReference, ObjectFactory objF, ProviderFactory pf, ProjectLayout pl, ExecOperations execOps)
- Method Detail
  - @Override
    org.ysb33r.grolifant5.api.core.executable.AppRunnerSpec appRunnerSpec()
    
    Creates a org.ysb33r.grolifant5.api.core.executable.AppRunnerSpec.
    This is primarily used internally by classes that implements execution specifications for non-JVM processes.
    
    Returns:
    Implementation of org.ysb33r.grolifant5.api.core.executable.AppRunnerSpec
  - @Override
    org.ysb33r.grolifant5.api.core.executable.CommandEntryPoint commandEntryPoint()
    
    Returns an implementation that is optimised for the running version of Gradle.
    Returns:
    Instance of org.ysb33r.grolifant5.api.core.executable.CommandEntryPoint. Never null
  - @Override
    org.ysb33r.grolifant5.api.core.downloader.Downloader downloader(String distributionName)
    
    Creates a new downloader for downloading packages / distributions.
    Parameters:
    distributionName - Name of distribution to be downloaded.
    Returns:
    Instance of org.ysb33r.grolifant5.api.core.downloader.Downloader that is optimised for the running Gradle version.
  - @Override
    org.ysb33r.grolifant5.api.core.runnable.ExecOutput exec(OutputType stdout, 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:
    org.ysb33r.grolifant5.api.core.runnable.ExecOutput that can be used to check if the execution worked.
  - @Override
    ExecSpec execSpec()
    
    Returns something that looks like an ExecSpec.
    Returns:
    Instance of an executable specification.
  - @Override
    org.ysb33r.grolifant5.api.core.runnable.ExecOutput javaexec(OutputType stdout, 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:
    org.ysb33r.grolifant5.api.core.runnable.ExecOutput that can be used to check if the execution worked.
  - @Override
    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.
  - @Override
    org.ysb33r.grolifant5.api.core.runnable.ExecOutput provideExec(Action<? super ExecSpec> action)
    
    Executes the specified external process on-demand.
    Parameters:
    action
    Returns:
    org.ysb33r.grolifant5.api.core.runnable.ExecOutput that can be used to check if the execution worked.
  - @Override
    org.ysb33r.grolifant5.api.core.runnable.ExecOutput provideJavaExec(Action<? super JavaExecSpec> action)
    
    Executes the specified external java process on-demand.
    Parameters:
    action - Configures a JavaExecSpec
    Returns:
    org.ysb33r.grolifant5.api.core.runnable.ExecOutput that can be used to check if the execution worked.

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class DefaultExecTools

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

@javax.inject.Inject
DefaultExecTools(Project tempProjectReference, ObjectFactory objF, ProviderFactory pf, ProjectLayout pl, ExecOperations execOps)

Method Detail

@Override
org.ysb33r.grolifant5.api.core.executable.AppRunnerSpec appRunnerSpec()

@Override
org.ysb33r.grolifant5.api.core.executable.CommandEntryPoint commandEntryPoint()

@Override
org.ysb33r.grolifant5.api.core.downloader.Downloader downloader(String distributionName)

@Override
org.ysb33r.grolifant5.api.core.runnable.ExecOutput exec(OutputType stdout, OutputType stderr, Action<? super ExecSpec> action)

@Override
ExecSpec execSpec()

@Override
org.ysb33r.grolifant5.api.core.runnable.ExecOutput javaexec(OutputType stdout, OutputType stderr, Action<? super JavaExecSpec> action)

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

@Override
org.ysb33r.grolifant5.api.core.runnable.ExecOutput provideExec(Action<? super ExecSpec> action)

@Override
org.ysb33r.grolifant5.api.core.runnable.ExecOutput provideJavaExec(Action<? super JavaExecSpec> action)

[Groovy] Class DefaultExecTools

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

@javax.inject.InjectDefaultExecTools(Project tempProjectReference, ObjectFactory objF, ProviderFactory pf, ProjectLayout pl, ExecOperations execOps)

Method Detail

@Overrideorg.ysb33r.grolifant5.api.core.executable.AppRunnerSpec appRunnerSpec()

@Overrideorg.ysb33r.grolifant5.api.core.executable.CommandEntryPoint commandEntryPoint()

@Overrideorg.ysb33r.grolifant5.api.core.downloader.Downloader downloader(String distributionName)

@Overrideorg.ysb33r.grolifant5.api.core.runnable.ExecOutput exec(OutputType stdout, OutputType stderr, Action<? super ExecSpec> action)

@OverrideExecSpec execSpec()

@Overrideorg.ysb33r.grolifant5.api.core.runnable.ExecOutput javaexec(OutputType stdout, OutputType stderr, Action<? super JavaExecSpec> action)

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

@Overrideorg.ysb33r.grolifant5.api.core.runnable.ExecOutput provideExec(Action<? super ExecSpec> action)

@Overrideorg.ysb33r.grolifant5.api.core.runnable.ExecOutput provideJavaExec(Action<? super JavaExecSpec> action)

@javax.inject.Inject
DefaultExecTools(Project tempProjectReference, ObjectFactory objF, ProviderFactory pf, ProjectLayout pl, ExecOperations execOps)

@Override
org.ysb33r.grolifant5.api.core.executable.AppRunnerSpec appRunnerSpec()

@Override
org.ysb33r.grolifant5.api.core.executable.CommandEntryPoint commandEntryPoint()

@Override
org.ysb33r.grolifant5.api.core.downloader.Downloader downloader(String distributionName)

@Override
org.ysb33r.grolifant5.api.core.runnable.ExecOutput exec(OutputType stdout, OutputType stderr, Action<? super ExecSpec> action)

@Override
ExecSpec execSpec()

@Override
org.ysb33r.grolifant5.api.core.runnable.ExecOutput javaexec(OutputType stdout, OutputType stderr, Action<? super JavaExecSpec> action)

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

@Override
org.ysb33r.grolifant5.api.core.runnable.ExecOutput provideExec(Action<? super ExecSpec> action)

@Override
org.ysb33r.grolifant5.api.core.runnable.ExecOutput provideJavaExec(Action<? super JavaExecSpec> action)