AbstractScriptExecSpec (grolifant 0.17.0 API)

org.ysb33r.grolifant.api.exec.AbstractScriptExecSpec

Tool execution specification aimed at script-line tools which takes a script as one of the arguments.
deprecated:
USeAbstractScriptExecSpec instead.

Since:
0.3

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

Properties Summary

Properties
Type	Name and description
`String`	`script`
`Iterable<?>`	`scriptArgs`

Constructor Summary

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

Methods Summary

Methods
Type Params	Return Type	Name and description
	`String`	`getScript()` The script used in this specification as a String.
	`java.util.List<String>`	`getScriptArgs()` Any arguments specific to the script.
	`protected String`	`getToolInstruction()` A specific instruction passed to a tool.
	`void`	`script(Object cmd)` Set the exe to use.
	`void`	`scriptArgs(Iterable<?> args)` Add more script-specific arguments.
	`void`	`scriptArgs(Object... args)` Add more script-specific arguments.
	`void`	`setScript(Object cmd)` Set the exe to use.
	`void`	`setScriptArgs(Iterable<?> args)` Replace the script-specific arguments with a new set.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractToolExecSpec`	`buildCommandLine, configure, configure, copyTo, copyToExecSpec, exeArgs, exeArgs, executable, executable, executable, executable, getCommandLine, getExeArgs, getExecutable, getExecutableResolver, getInstructionsArgs, getResolvableExecutable, getToolInstruction, instructionArgs, instructionArgs, setExeArgs, setExecutable, setExecutable, setExecutable, setExecutable, setExecutable, setInstructionArgs`
`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
  - String script
  - Iterable<?> scriptArgs
- Constructor Detail
  - protected AbstractScriptExecSpec(Project project, ExternalExecutable registry)
    
    Construct class and attach it to specific project.
    Parameters:
    project - Project this exec spec is attached.
    registry - Registry used to resolve executables.
- Method Detail
  - String getScript()
    
    The script used in this specification as a String.
    Returns:
    Command if set (else null).
  - java.util.List<String> getScriptArgs()
    
    Any arguments specific to the script.
    Returns:
    Arguments to the commands. Can be empty, but never null.
  - @Override protected String getToolInstruction()
    
    A specific instruction passed to a tool. Instruction can be empty or null, which means that by default implementation getToolInstruction will be ignored.
    Returns:
    Instruction as string
  - void script(Object cmd)
    
    Set the exe to use.
    Parameters:
    exe - Anything that can be resolved via StringUtils.stringize
  - void scriptArgs(Iterable<?> args)
    
    Add more script-specific arguments.
    Parameters:
    args - Additional list of arguments
  - void scriptArgs(Object... args)
    
    Add more script-specific arguments.
    Parameters:
    args - Additional list of arguments
  - void setScript(Object cmd)
    
    Set the exe to use.
    Parameters:
    cmd - Anything that can be resolved via StringUtils.stringize
  - @SuppressWarnings('UnnecessarySetter') void setScriptArgs(Iterable<?> args)
    
    Replace the script-specific arguments with a new set.
    Parameters:
    args - New list of tool-specific arguments

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractScriptExecSpec

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

String script

Iterable<?> scriptArgs

Constructor Detail

protected AbstractScriptExecSpec(Project project, ExternalExecutable registry)

Method Detail

String getScript()

java.util.List<String> getScriptArgs()

@Override protected String getToolInstruction()

void script(Object cmd)

void scriptArgs(Iterable<?> args)

void scriptArgs(Object... args)

void setScript(Object cmd)

@SuppressWarnings('UnnecessarySetter') void setScriptArgs(Iterable<?> args)