AbstractExecTask (grolifant 0.4 API)

org.ysb33r.gradle.olifant.exec.AbstractExecTask

A base class to use for developing execution tasks for wrapping execution tools
Since:
0.3

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

Constructor Summary

Constructors
Constructor and description
`protected AbstractExecTask ()` Creates class and sets default environment to be that of Gradle,

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected T`	`createExecSpec(Project project)` Factory method for creating an execution specification
	`B`	`environment(java.util.Map<String, ?> map)` Add additional environment variables for use with the process.
	`B`	`environment(String envVar, Object value)` Add additional environment variable for use with the process.
	`B`	`errorOutput(OutputStream outputStream)` Set the stream where error output should be sent to for this process when executing.
	`void`	`exeArgs(Iterable<?> args)` Add more tool-specific arguments.
	`void`	`exeArgs(Object... args)` Add more tool-specific arguments.
	`void`	`exec()` Runs this process against an internal execution specification.
	`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.Map<String, Object>`	`getEnvironment()` Returns the environment to be used for the process.
	`OutputStream`	`getErrorOutput()` Where error output is sent to during execution.
	`java.util.List<String>`	`getExeArgs()` Any arguments specific to the tool in use
	`ExecResult`	`getExecResult()` Returns the result for the execution, that was run by this task.
	`protected T`	`getExecSpec()` Provides access to the execution specification that is associated with this task
	`String`	`getExecutable()` The executable used in this specification as a String.
	`InputStream`	`getStandardInput()` Where input is read from during execution.
	`OutputStream`	`getStandardOutput()` Where standard output is sent to during execution.
	`File`	`getWorkingDir()` Obtain the working directory for this process.
	`B`	`ignoreExitValue(boolean flag)` Determine whether the exit value should be ignored.
	`boolean`	`isIgnoreExitValue()` State of exit value monitoring.
	`void`	`setEnvironment(java.util.Map<String, ?> map)` Set the environment variables to use for the process.
	`B`	`setErrorOutput(OutputStream outputStream)` Set the stream where error output should be sent to for this process when executing.
	`void`	`setExeArgs(Iterable<?> args)` Replace the tool-specific arguments with a new set.
	`B`	`setIgnoreExitValue(boolean flag)` Determine whether the exit value should be ignored.
	`B`	`setStandardInput(InputStream inputStream)` Set the stream where standard input should be read from for this process when executing.
	`B`	`setStandardOutput(OutputStream outputStream)` Set the stream where standard output should be sent to for this process when executing.
	`protected void`	`setToolExecutable(Object exe)` Sets the executable to use for this task
	`void`	`setWorkingDir(Object workDir)` Set the working directory for the execution.
	`B`	`standardInput(InputStream inputStream)` Set the stream where standard input should be read from for this process when executing.
	`B`	`standardOutput(OutputStream outputStream)` Set the stream where standard output should be sent to for this process when executing.
	`B`	`workingDir(Object workDir)` Set the working directory for the execution.

Inherited Methods Summary

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

- Constructor Detail
  - protected AbstractExecTask()
    
    Creates class and sets default environment to be that of Gradle,
- Method Detail
  - protected T createExecSpec(Project project)
    
    Factory method for creating an execution specification
    Returns:
    Execution Specification
    Parameters:
    project - Project that the execution speciofication should be associated to.
  - B environment(java.util.Map<String, ?> map)
    
    Add additional environment variables for use with the process.
    Returns:
    this.
    Parameters:
    map - Environmental variables as key-value pairs.
  - B environment(String envVar, Object value)
    
    Add additional environment variable for use with the process.
    Returns:
    this.
    Parameters:
    envVar - Name of environmental variable.
    value - Value of environmental variable.
  - B errorOutput(OutputStream outputStream)
    
    Set the stream where error output should be sent to for this process when executing.
    Returns:
    this.
    Parameters:
    outputStream - Output stream to use.
  - 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
  - @TaskAction void exec()
    
    Runs this process against an internal execution specification. If a failure occurs and isIgnoreExitValue is not set, an exception will be raised.
  - @Internal 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
  - @Internal java.util.Map<String, Object> getEnvironment()
    
    Returns the environment to be used for the process. Defaults to the environment of this process.
    Returns:
    Key-value pairing of environmental variables.
  - @Internal OutputStream getErrorOutput()
    
    Where error output is sent to during execution.
    Returns:
    Output stream.
  - @java.util.Optional @Input java.util.List<String> getExeArgs()
    
    Any arguments specific to the tool in use
    Returns:
    Arguments to the tool. Can be empty, but never null.
  - @Internal ExecResult getExecResult()
    
    Returns the result for the execution, that was run by this task.
    Returns:
    The result of the execution. Returns null if this task has not been executed yet.
  - protected T getExecSpec()
    
    Provides access to the execution specification that is associated with this task
    Returns:
    Execution specification
  - @java.util.Optional @Input String getExecutable()
    
    The executable used in this specification as a String.
    Returns:
    Executable name if set (else null).
  - @Internal InputStream getStandardInput()
    
    Where input is read from during execution.
    Returns:
    Input stream.
  - @Internal OutputStream getStandardOutput()
    
    Where standard output is sent to during execution.
    Returns:
    Output stream.
  - @Internal File getWorkingDir()
    
    Obtain the working directory for this process. This call will evaluate the lazily-set working directory for setWorkingDir0
    Returns:
    A java.io.File object.
  - B ignoreExitValue(boolean flag)
    
    Determine whether the exit value should be ignored.
    Returns:
    this.
    Parameters:
    flag - Whether exit value should be ignored.
  - @Input boolean isIgnoreExitValue()
    
    State of exit value monitoring.
    Returns:
    Whether return value shoul dbe ignored.
  - void setEnvironment(java.util.Map<String, ?> map)
    
    Set the environment variables to use for the process.
    Parameters:
    map - Environmental variables as key-value pairs.
  - B setErrorOutput(OutputStream outputStream)
    
    Set the stream where error output should be sent to for this process when executing.
    Returns:
    this.
    Parameters:
    outputStream - Output stream to use.
  - void setExeArgs(Iterable<?> args)
    
    Replace the tool-specific arguments with a new set.
    Parameters:
    args - New list of tool-specific arguments
  - B setIgnoreExitValue(boolean flag)
    
    Determine whether the exit value should be ignored.
    Returns:
    this.
    Parameters:
    flag - Whether exit value should be ignored.
  - B setStandardInput(InputStream inputStream)
    
    Set the stream where standard input should be read from for this process when executing.
    Returns:
    this.
    Parameters:
    inputStream - Inout stream to use.
  - B setStandardOutput(OutputStream outputStream)
    
    Set the stream where standard output should be sent to for this process when executing.
    Returns:
    this.
    Parameters:
    outputStream - Output stream to use.
  - protected void setToolExecutable(Object exe)
    
    Sets the executable to use for this task
    Parameters:
    exe - Anything resolvable via org.ysb33r.gradle.olifant.StringUtils.stringize
  - void setWorkingDir(Object workDir)
    
    Set the working directory for the execution.
    Parameters:
    workDir - Any object that is convertiable using Gradle's project.file.
  - B standardInput(InputStream inputStream)
    
    Set the stream where standard input should be read from for this process when executing.
    Returns:
    this.
    Parameters:
    inputStream - Inout stream to use.
  - B standardOutput(OutputStream outputStream)
    
    Set the stream where standard output should be sent to for this process when executing.
    Returns:
    this.
    Parameters:
    outputStream - Output stream to use.
  - B workingDir(Object workDir)
    
    Set the working directory for the execution.
    Returns:
    This object as ProcessForkOptions
    Parameters:
    workDir - Any object that is convertible using Gradle's project.file.

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractExecTask<B extends AbstractExecTask, T extends AbstractToolExecSpec>

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

protected AbstractExecTask()

Method Detail

protected T createExecSpec(Project project)

B environment(java.util.Map<String, ?> map)

B environment(String envVar, Object value)

B errorOutput(OutputStream outputStream)

void exeArgs(Iterable<?> args)

void exeArgs(Object... args)

@TaskAction void exec()

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

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

@Internal OutputStream getErrorOutput()

@java.util.Optional @Input java.util.List<String> getExeArgs()

@Internal ExecResult getExecResult()

protected T getExecSpec()

@java.util.Optional @Input String getExecutable()

@Internal InputStream getStandardInput()

@Internal OutputStream getStandardOutput()

@Internal File getWorkingDir()

B ignoreExitValue(boolean flag)

@Input boolean isIgnoreExitValue()

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

B setErrorOutput(OutputStream outputStream)

void setExeArgs(Iterable<?> args)

B setIgnoreExitValue(boolean flag)

B setStandardInput(InputStream inputStream)

B setStandardOutput(OutputStream outputStream)

protected void setToolExecutable(Object exe)

void setWorkingDir(Object workDir)

B standardInput(InputStream inputStream)

B standardOutput(OutputStream outputStream)

B workingDir(Object workDir)