AbstractExecWrapperTask (grolifant 0.17.0 API)

org.ysb33r.grolifant.api.exec.AbstractExecWrapperTask

Base task class to wrap external tool executions without exposing command-line parameters directly.
T is the execution specification class
E is the extension class type that allows for configuration of the external tool.
deprecated:
UseAbstractExecWrapperTask instead.

Since:
0.4

Inherited fields
Fields inherited from class	Fields
`class DefaultTask`	`TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS`
`class AbstractTask`	`TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS`

Properties Summary

Properties
Type	Name and description
`java.util.Map<String, ?>`	`environment`

Constructor Summary

Constructors
Constructor and description
`protected AbstractExecWrapperTask ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected T`	`addEnvironmentToExecSpec(T execSpec)` Adds the configured environment to the execution specification.
	`protected T`	`addExecutableToExecSpec(T execSpec)` Adds the exe to the execution specification.
	`protected T`	`configureExecSpec(T execSpec)` Configures an execution specification from task properties
	`protected T`	`createExecSpec()` Creates a new execution specification.
	`void`	`environment(java.util.Map<String, ?> args)` Add environmental variables to be passed to the exe.
	`void`	`exec()` The default implementation will build an execution specification and run it.
	`java.util.Map<String, String>`	`getEnvironment()` Environment for running the exe
	`protected E`	`getToolExtension()` Returns the extension that is associated with the specific tool
	`protected ExecResult`	`runExecSpec(T execSpec)`
	`void`	`setEnvironment(java.util.Map<String, ?> args)` Replace current environment with new one.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class DefaultTask`	setDescription, getProject, getIdentityPath, getStandardOutputCapture, setGroup, getAnt, getConvention, getLogging, getLogging, getDidWork, getAsDynamicObject, setActions, getTaskDependencies, getTaskDependencies, getDependsOn, setDependsOn, dependsOn, onlyIf, onlyIf, setOnlyIf, setOnlyIf, setDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, getEnabled, getOutputs, getOutputs, getDestroyables, getLocalState, getTemporaryDir, mustRunAfter, setMustRunAfter, getMustRunAfter, finalizedBy, setFinalizedBy, getFinalizedBy, shouldRunAfter, setShouldRunAfter, getShouldRunAfter, getTaskIdentity, injectIntoNewInstance, getTaskActions, hasTaskActions, getOnlyIf, getImpliesSubProjects, setImpliesSubProjects, replaceLogger, getTemporaryDirFactory, prependParallelSafeAction, appendParallelSafeAction, isHasCustomActions, getLogger, getTimeout, isEnabled, configure, configure, getDescription, setEnabled, property, hasProperty, getGroup, getInputs, getInputs, setProperty, toString, compareTo, compareTo, getName, getActions, getState, getState, getPath, getExtensions, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll
`class AbstractTask`	setDescription, getProject, getIdentityPath, getStandardOutputCapture, setGroup, getAnt, getConvention, getLogging, getLogging, getDidWork, getAsDynamicObject, setActions, getTaskDependencies, getTaskDependencies, getDependsOn, setDependsOn, dependsOn, onlyIf, onlyIf, setOnlyIf, setOnlyIf, setDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, getEnabled, getOutputs, getOutputs, getDestroyables, getLocalState, getTemporaryDir, mustRunAfter, setMustRunAfter, getMustRunAfter, finalizedBy, setFinalizedBy, getFinalizedBy, shouldRunAfter, setShouldRunAfter, getShouldRunAfter, getTaskIdentity, injectIntoNewInstance, getTaskActions, hasTaskActions, getOnlyIf, getImpliesSubProjects, setImpliesSubProjects, replaceLogger, getTemporaryDirFactory, prependParallelSafeAction, appendParallelSafeAction, isHasCustomActions, getLogger, getTimeout, isEnabled, configure, configure, getDescription, setEnabled, property, hasProperty, getGroup, getInputs, getInputs, setProperty, toString, compareTo, compareTo, getName, getActions, getState, getState, getPath, getExtensions, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll

- Property Detail
  - java.util.Map<String, ?> environment
- Constructor Detail
  - protected AbstractExecWrapperTask()
- Method Detail
  - protected T addEnvironmentToExecSpec(T execSpec)
    
    Adds the configured environment to the execution specification.
    Parameters:
    execSpec
    Returns:
    execSpec
  - protected T addExecutableToExecSpec(T execSpec)
    
    Adds the exe to the execution specification.
    Parameters:
    execSpec
    Returns:
    execSpec
  - protected T configureExecSpec(T execSpec)
    
    Configures an execution specification from task properties
    Parameters:
    execSpec
    Returns:
  - protected T createExecSpec()
    
    Creates a new execution specification.
    Returns:
    New exec specification
  - void environment(java.util.Map<String, ?> args)
    
    Add environmental variables to be passed to the exe.
    Parameters:
    args - Environmental variable key-value map.
  - @TaskAction void exec()
    
    The default implementation will build an execution specification and run it.
  - @Input java.util.Map<String, String> getEnvironment()
    
    Environment for running the exe
    Calling this will resolve all lazy-values in the variable map.
    Returns:
    Map of environmental variables that will be passed.
  - protected E getToolExtension()
    
    Returns the extension that is associated with the specific tool
    Returns:
    Extension (project or task).
  - @groovy.transform.CompileDynamic protected ExecResult runExecSpec(T execSpec)
  - void setEnvironment(java.util.Map<String, ?> args)
    
    Replace current environment with new one.
    Parameters:
    args - New environment key-value map of properties.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractExecWrapperTask<T extends AbstractExecSpec, E extends AbstractToolExtension>

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.util.Map<String, ?> environment

Constructor Detail

protected AbstractExecWrapperTask()

Method Detail

protected T addEnvironmentToExecSpec(T execSpec)

protected T addExecutableToExecSpec(T execSpec)

protected T configureExecSpec(T execSpec)

protected T createExecSpec()

void environment(java.util.Map<String, ?> args)

@TaskAction void exec()

@Input java.util.Map<String, String> getEnvironment()

protected E getToolExtension()

@groovy.transform.CompileDynamic protected ExecResult runExecSpec(T execSpec)

void setEnvironment(java.util.Map<String, ?> args)