AbstractCommandExecSpec (docs 1.1.0 API)

org.ysb33r.grolifant.api.v4.exec.AbstractCommandExecSpec

Tool execution specification aimed at command-line tools which takes a command as one of the arguments.
deprecated:
Use org.ysb33r.grolifant.api.v4.runnable.AbstractExecCommandSpec.

Since:
0.17.0

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

Properties Summary

Properties
Type	Name and description
`Iterable<?>`	`cmdArgs`
`String`	`command`

Constructor Summary

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

Methods Summary

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

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractToolExecSpec`	`buildCommandLine, configure, configure, copyTo, copyToExecSpec, exeArgs, exeArgs, executable, executable, executable, getCommandLine, getExeArgs, getExecutable, getExecutableResolver, getInstructionsArgs, getResolvableExecutable, getToolInstruction, instructionArgs, instructionArgs, setExeArgs, setExecutable, setExecutable, setExecutable, setExecutable, setInstructionArgs`
`class AbstractExecSpec`	`environment, environment, errorOutput, getEnvironment, getErrorOutput, getProject, getProjectOperations, getStandardInput, getStandardOutput, getWorkingDir, ignoreExitValue, isIgnoreExitValue, setEnvironment, setErrorOutput, setIgnoreExitValue, setStandardInput, setStandardOutput, setWorkingDir, setWorkingDir, standardInput, standardOutput, workingDir`

- Property Detail
  - Iterable<?> cmdArgs
  - String command
- Constructor Detail
  - @Deprecated protected AbstractCommandExecSpec(Project project, ExternalExecutable registry)
    
    Construct class and attach it to specific project.
    deprecated:
    
    Parameters:
    project - Project this exec spec is attached.
    registry - Registry used to resolve executables.
  - protected AbstractCommandExecSpec(ProjectOperations projectOperations, ExternalExecutable registry)
    
    Construct class and attach it to specific project.
    Parameters:
    project - Project this exec spec is attached.
    registry - Registry used to resolve executables.
    Since:
    1.0
- Method Detail
  - void cmdArgs(Iterable<?> args)
    
    Add more command-specific arguments.
    Parameters:
    args - Additional list of arguments
  - void cmdArgs(Object... args)
    
    Add more command-specific arguments.
    Parameters:
    args - Additional list of arguments
  - void command(Object cmd)
    
    Set the command to use.
    Parameters:
    cmd - Anything that can be resolved via StringUtils#stringize(Object)#stringize(Object)
  - @Input java.util.List<String> getCmdArgs()
    
    Any arguments specific to the command.
    Returns:
    Arguments to the commands. Can be empty, but never null.
  - String getCommand()
    
    The script used in this specification as a String.
    Returns:
    Command if set (else null).
  - @Override @Internal 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
  - @SuppressWarnings('UnnecessarySetter') void setCmdArgs(Iterable<?> args)
    
    Replace the command-specific arguments with a new set.
    Parameters:
    args - New list of command-specific arguments
  - void setCommand(Object cmd)
    
    Set the command to use.
    Parameters:
    cmd - Anything that can be resolved via StringUtils#stringize(Object)#stringize(Object)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractCommandExecSpec

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

Iterable<?> cmdArgs

String command

Constructor Detail

@Deprecated protected AbstractCommandExecSpec(Project project, ExternalExecutable registry)

protected AbstractCommandExecSpec(ProjectOperations projectOperations, ExternalExecutable registry)

Method Detail

void cmdArgs(Iterable<?> args)

void cmdArgs(Object... args)

void command(Object cmd)

@Input java.util.List<String> getCmdArgs()

String getCommand()

@Override @Internal protected String getToolInstruction()

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

void setCommand(Object cmd)