AbstractToolExecSpec (grolifant 0.4 API)

org.ysb33r.gradle.olifant.exec.AbstractToolExecSpec

A base class to aid plugin developers create their own ExecSpec implementations.
Since:
0.3

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

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 executable to use.
	`ProcessForkOptions`	`executable(ResolvableExecutable resolver)` Set the executable to use.
	`void`	`executable(java.util.Map<String, Object> exe)` Use a key-value approach to setting the executable.
	`java.util.List<String>`	`getCommandLine()` Returns the full script line, including the executable, it's specific arguments, tool specific instruction and the arguments spefic to the instruction.
	`java.util.List<String>`	`getExeArgs()` Any arguments specific to the tool in use
	`String`	`getExecutable()` The executable used in this specification as a String.
	`protected ExternalExecutable`	`getExecutableResolver()` Access to the object that can resolve executable 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 executable
	`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 executable to use.
	`void`	`setExecutable(ResolvableExecutable resolver)` Set the executable to use.
	`void`	`setExecutable(String exe)` Set the executable to use.
	`void`	`setExecutable(java.util.Map<String, Object> exe)` Use a key-value approach to setting the executable.
	`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`

- 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:
```
   executable 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 executable which do not form part of the script/command customisation.
    Returns:
    List of command line parts
    Throws:
    GradleException if executable is not set.
  - AbstractToolExecSpec configure(Action<? extends AbstractToolExecSpec> action)
    
    Configure this spec from an Action
    Returns:
    this.
    Parameters:
    action - Configurating action.
  - AbstractToolExecSpec configure(@groovy.lang.DelegatesTo(AbstractToolExecSpec) groovy.lang.Closure cfg)
    
    Configure this spec from a closure.
    Returns:
    Parameters:
    cfg - Closure to use.
  - @Override ProcessForkOptions copyTo(ProcessForkOptions processForkOptions)
    
    Copies options from this Spec to the given target. If the target is not an instance of AbstractToolExecSpec and the executable is of type ResolvableExecutable then it will be processed before copying.
    Returns:
    This object as a ProcessForkOptions
    Parameters:
    processForkOptions - Copy to this target.
  - 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 executable.
    Parameters:
    execSpec - Exec spec to configure.
  - void exeArgs(Iterable<?> args)
    
    Add more tool-specific arguments.
    Parameters:
    args - Additional list of arguments
  - void exeArgs(Object... args)
    
    Add more tool-specific arguments.
    Parameters:
    args - Additional list of arguments
  - @Override ProcessForkOptions executable(Object exe)
    
    Set the executable to use. If you need to search the system path, to find the executable use the search : 'exeName' form instead.
    Returns:
    This object as an instance of org
    Parameters:
    exe - Anything that can be resolved via org.ysb33r.gradle.olifant.StringUtils.stringize(Object) or an implementation of ResolvableExecutable
  - ProcessForkOptions executable(ResolvableExecutable resolver)
    
    Set the executable to use.
    Returns:
    This object as an instance of org
    Parameters:
    exe - An implementation of ResolvableExecutable
  - void executable(java.util.Map<String, Object> exe)
    
    Use a key-value approach to setting the executable. In the default implementation only path and search are supported as a declarative keys. Implementations should use registerExecutableKeyAction to add more keys.
    Parameters:
    exe - Key-value setting executable (with optional extra keys)
  - @Override java.util.List<String> getCommandLine()
    
    Returns the full script line, including the executable, it's specific arguments, tool specific instruction and the arguments spefic to the instruction.
    Returns:
    Command-line as a list of items
  - 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 executable used in this specification as a String.
    Returns:
    Executable name if set (else null).
  - protected ExternalExecutable getExecutableResolver()
    
    Access to the object that can resolve executable 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.
  - ResolvableExecutable getResolvableExecutable()
    
    Lazy-evaluated version of the executable
    Returns:
    Lazy-evaluated version of the executable 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 getToolInstructionArgs() 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
  - 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 executable to use. If you need to search the system path, to find the executable use the search : 'exeName' form instead.
    Parameters:
    exe - Anything that can be resolved via org.ysb33r.gradle.olifant.StringUtils.stringize(Object) or an implementation of ResolvableExecutable
  - void setExecutable(ResolvableExecutable resolver)
    
    Set the executable to use.
    Parameters:
    exe - An implementation of ResolvableExecutable
  - void setExecutable(String exe)
    
    Set the executable 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
  - void setExecutable(java.util.Map<String, Object> exe)
    
    Use a key-value approach to setting the executable. In the default implementation only path and search are supported as a declarative keys. Implementations should use registerExecutableKeyAction to add more keys.
    Parameters:
    exe - Key-value setting executable (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:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractToolExecSpec

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

protected AbstractToolExecSpec(Project project, ExternalExecutable executableResolver)

Method Detail

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

AbstractToolExecSpec configure(Action<? extends AbstractToolExecSpec> action)

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

@Override ProcessForkOptions copyTo(ProcessForkOptions processForkOptions)

void copyToExecSpec(ExecSpec execSpec)

void exeArgs(Iterable<?> args)

void exeArgs(Object... args)

@Override ProcessForkOptions executable(Object exe)

ProcessForkOptions executable(ResolvableExecutable resolver)

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

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

java.util.List<String> getExeArgs()

@Override String getExecutable()

protected ExternalExecutable getExecutableResolver()

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

ResolvableExecutable getResolvableExecutable()

protected String getToolInstruction()

protected void instructionArgs(Iterable<?> args)

protected void instructionArgs(Object... args)

void setExeArgs(Iterable<?> args)

@Override void setExecutable(Object exe)

void setExecutable(ResolvableExecutable resolver)

void setExecutable(String exe)

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

protected void setInstructionArgs(Iterable<?> args)