AbstractToolExecSpec (grolifant 0.17.0 API)

org.ysb33r.grolifant.api.exec.AbstractToolExecSpec

All Implemented Interfaces and Traits:

ToolExecSpecGroovy
```
@Deprecated
@groovy.transform.CompileStatic
abstract class AbstractToolExecSpec
extends AbstractExecSpec
```
A base class to aid plugin developers create their own ExecSpec implementations.
deprecated:
UseAbstractToolExecSpec instead.

Since:
0.3

Inherited fields
Fields inherited from class	Fields
`class AbstractExecSpec`	`env, project, workingDir`

Properties Summary

Properties
Type	Name and description
`Iterable<?>`	`exeArgs`
`String`	`executable`
`String`	`executable`
`String`	`executable`
`String`	`executable`
`String`	`executable`

Constructor Summary

Constructors
Constructor and description
`protected AbstractToolExecSpec (Project project, ExternalExecutable executableResolver)` Construct class and attach it to specific project.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected java.util.List<String>`	`buildCommandLine()` Builds up the command line.
	`AbstractToolExecSpec`	`configure(Action<? extends AbstractToolExecSpec> action)` Configure this spec from an Action
	`AbstractToolExecSpec`	`configure(groovy.lang.Closure cfg)` Configure this spec from a closure.
	`ProcessForkOptions`	`copyTo(ProcessForkOptions processForkOptions)` Copies options from this Spec to the given target.
	`void`	`copyToExecSpec(ExecSpec execSpec)` Copies settings from this execution specification to a standard ExecSpec
	`void`	`exeArgs(Iterable<?> args)` Add more tool-specific arguments.
	`void`	`exeArgs(Object... args)` Add more tool-specific arguments.
	`ProcessForkOptions`	`executable(Object exe)` Set the exe to use.
	`ProcessForkOptions`	`executable(ResolvableExecutable resolver)` Set the exe to use.
	`ProcessForkOptions`	`executable(ResolvableExecutable resolver)`
	`void`	`executable(java.util.Map<String, Object> exe)` Use a key-value approach to setting the exe.
	`java.util.List<String>`	`getCommandLine()` Returns the full script line, including the exe, it's specific arguments, tool specific instruction and the arguments specific to the instruction.
	`java.util.List<String>`	`getExeArgs()` Any arguments specific to the tool in use
	`String`	`getExecutable()` The exe used in this specification as a String.
	`protected ExternalExecutable`	`getExecutableResolver()` Access to the object that can resolve exe location from property maps.
	`protected java.util.List<String>`	`getInstructionsArgs()` List of arguments specific to the tool instruction.
	`ResolvableExecutable`	`getResolvableExecutable()` Lazy-evaluated version of the exe
	`protected String`	`getToolInstruction()` A specific instruction passed to a tool.
	`protected void`	`instructionArgs(Iterable<?> args)` Add more instruction-specific arguments.
	`protected void`	`instructionArgs(Object... args)` Add more instruction-specific arguments.
	`void`	`setExeArgs(Iterable<?> args)` Replace the tool-specific arguments with a new set.
	`void`	`setExecutable(Object exe)` Set the exe to use.
	`void`	`setExecutable(ResolvableExecutable resolver)` Set the exe to use.
	`void`	`setExecutable(ResolvableExecutable resolver)` Set the exe to use.
	`void`	`setExecutable(String exe)` Set the exe to use.
	`void`	`setExecutable(java.util.Map<String, Object> exe)` Use a key-value approach to setting the exe.
	`protected void`	`setInstructionArgs(Iterable<?> args)` Replace the instruction-specific arguments with a new set.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractExecSpec`	`environment, environment, errorOutput, getEnvironment, getErrorOutput, getStandardInput, getStandardOutput, getWorkingDir, ignoreExitValue, isIgnoreExitValue, setEnvironment, setErrorOutput, setIgnoreExitValue, setStandardInput, setStandardOutput, setWorkingDir, setWorkingDir, standardInput, standardOutput, workingDir`
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Property Detail
  - Iterable<?> exeArgs
  - String executable
  - String executable
  - String executable
  - String executable
  - String executable
- Constructor Detail
  - protected AbstractToolExecSpec(Project project, ExternalExecutable executableResolver)
    
    Construct class and attach it to specific project.
    Parameters:
    project - Project this exec spec is attached.
    executableResolver - A way to resolve executables.
- Method Detail
  - protected java.util.List<String> buildCommandLine()
    
    Builds up the command line.
    The default format in use is the following:
```
   exe exeArgs... toolInstruction instructionsArgs...
 
```
    toolInstruction is typically a command or a script and instructionArgs the arguments for that script of tool. exeArgs are any command-line arguments meant for the exe which do not form part of the script/command customisation.
    Returns:
    List of command line parts
    Throws:
    GradleException if exe is not set.
  - @Override AbstractToolExecSpec configure(Action<? extends AbstractToolExecSpec> action)
    
    Configure this spec from an Action
    Parameters:
    action - Configuration action.
    Returns:
    this.
  - @Override AbstractToolExecSpec configure(@groovy.lang.DelegatesTo(AbstractToolExecSpec) groovy.lang.Closure cfg)
    
    Configure this spec from a closure.
    Parameters:
    cfg - Closure to use.
    Returns:
  - @Override @SuppressWarnings('UnnecessarySetter') ProcessForkOptions copyTo(ProcessForkOptions processForkOptions)
    
    Copies options from this Spec to the given target. If the target is not an instance of AbstractToolExecSpec and the exe is of type ResolvableExecutable then it will be processed before copying.
    Parameters:
    processForkOptions - Copy to this target.
    Returns:
    This object as a ProcessForkOptions
  - @Override void copyToExecSpec(ExecSpec execSpec)
    
    Copies settings from this execution specification to a standard ExecSpec This method is intended to be called as late as possible by a project extension or a task which would want to delegate to project.exec project extension. It will cause arguments to be evaluated. The only items not immediately evaluated are workingDir and exe.
    Parameters:
    execSpec - Exec spec to configure.
  - @Override void exeArgs(Iterable<?> args)
    
    Add more tool-specific arguments.
    Parameters:
    args - Additional list of arguments
  - @Override void exeArgs(Object... args)
    
    Add more tool-specific arguments.
    Parameters:
    args - Additional list of arguments
  - @Override ProcessForkOptions executable(Object exe)
    
    Set the exe to use. If you need to search the system path, to find the exe use the search : 'exeName' form instead.
    Parameters:
    exe - Anything that can be resolved via StringUtils.stringize or an implementation of ResolvableExecutable
    Returns:
    This object as an instance of ProcessForkOptions
  - ProcessForkOptions executable(ResolvableExecutable resolver)
    
    Set the exe to use.
    Parameters:
    exe - An implementation of ResolvableExecutable
    Returns:
    This object as an instance of ProcessForkOptions
  - ProcessForkOptions executable(ResolvableExecutable resolver)
  - @Override void executable(java.util.Map<String, Object> exe)
    
    Use a key-value approach to setting the exe. In the default implementation only path and search are supported as a declarative keys. Implementations should use ResolverFactoryRegistry to add more keys.
    Parameters:
    exe - Key-value setting exe (with optional extra keys)
  - @Override java.util.List<String> getCommandLine()
    
    Returns the full script line, including the exe, it's specific arguments, tool specific instruction and the arguments specific to the instruction.
    Returns:
    Command-line as a list of items
  - @Override java.util.List<String> getExeArgs()
    
    Any arguments specific to the tool in use
    Returns:
    Arguments to the tool. Can be empty, but never null.
  - @Override String getExecutable()
    
    The exe used in this specification as a String.
    Returns:
    Executable name if set (else null).
  - protected ExternalExecutable getExecutableResolver()
    
    Access to the object that can resolve exe location from property maps.
    Returns:
    Resolver.
  - protected java.util.List<String> getInstructionsArgs()
    
    List of arguments specific to the tool instruction.
    Returns:
    List of arguments. Can be empty, but not null.
  - @Override ResolvableExecutable getResolvableExecutable()
    
    Lazy-evaluated version of the exe
    Returns:
    Lazy-evaluated version of the exe or null if not configured.
  - protected String getToolInstruction()
    
    A specific instruction passed to a tool. * Instruction can be empty or null. In the default implementation getToolInstruction will be ignored.
    Returns:
    Instruction as string
  - protected void instructionArgs(Iterable<?> args)
    
    Add more instruction-specific arguments.
    Parameters:
    args - Additional list of arguments
  - protected void instructionArgs(Object... args)
    
    Add more instruction-specific arguments.
    Parameters:
    args - Additional list of arguments
  - @Override void setExeArgs(Iterable<?> args)
    
    Replace the tool-specific arguments with a new set.
    Parameters:
    args - New list of tool-specific arguments
  - @Override void setExecutable(Object exe)
    
    Set the exe to use. If you need to search the system path, to find the exe use the search : 'exeName' form instead.
    Parameters:
    exe - Anything that can be resolved via StringUtils.stringize or an implementation of ResolvableExecutable
  - void setExecutable(ResolvableExecutable resolver)
    
    Set the exe to use.
    Parameters:
    exe - An implementation of ResolvableExecutable
  - void setExecutable(ResolvableExecutable resolver)
    
    Set the exe to use.
    Parameters:
    exe - An implementation of ResolvableExecutable
  - @Override void setExecutable(String exe)
    
    Set the exe to use.
    This variant of the method has been introduced to cope with the API change in Gradle 4.0.
    Parameters:
    exe - Executable as String representation
  - @Override void setExecutable(java.util.Map<String, Object> exe)
    
    Use a key-value approach to setting the exe. In the default implementation only path and search are supported as a declarative keys. Implementations should use ResolverFactoryRegistry to add more keys.
    Parameters:
    exe - Key-value setting exe (with optional extra keys)
  - protected void setInstructionArgs(Iterable<?> args)
    
    Replace the instruction-specific arguments with a new set.
    Parameters:
    args - New list of instruction-specific arguments

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractToolExecSpec

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

Iterable<?> exeArgs

String executable

String executable

String executable

String executable

String executable

Constructor Detail

protected AbstractToolExecSpec(Project project, ExternalExecutable executableResolver)

Method Detail

protected java.util.List<String> buildCommandLine()

@Override AbstractToolExecSpec configure(Action<? extends AbstractToolExecSpec> action)

@Override AbstractToolExecSpec configure(@groovy.lang.DelegatesTo(AbstractToolExecSpec) groovy.lang.Closure cfg)

@Override @SuppressWarnings('UnnecessarySetter') ProcessForkOptions copyTo(ProcessForkOptions processForkOptions)

@Override void copyToExecSpec(ExecSpec execSpec)

@Override void exeArgs(Iterable<?> args)

@Override void exeArgs(Object... args)

@Override ProcessForkOptions executable(Object exe)

ProcessForkOptions executable(ResolvableExecutable resolver)

ProcessForkOptions executable(ResolvableExecutable resolver)

@Override void executable(java.util.Map<String, Object> exe)

@Override java.util.List<String> getCommandLine()

@Override java.util.List<String> getExeArgs()

@Override String getExecutable()

protected ExternalExecutable getExecutableResolver()

protected java.util.List<String> getInstructionsArgs()

@Override ResolvableExecutable getResolvableExecutable()

protected String getToolInstruction()

protected void instructionArgs(Iterable<?> args)

protected void instructionArgs(Object... args)

@Override void setExeArgs(Iterable<?> args)

@Override void setExecutable(Object exe)

void setExecutable(ResolvableExecutable resolver)

void setExecutable(ResolvableExecutable resolver)

@Override void setExecutable(String exe)

@Override void setExecutable(java.util.Map<String, Object> exe)

protected void setInstructionArgs(Iterable<?> args)