AbstractExecSpec (docs 1.0.1 API)

org.ysb33r.grolifant.api.v4.exec.AbstractExecSpec

All Implemented Interfaces and Traits:

BaseExecSpec, MutableBaseExecSpec
```
@groovy.transform.CompileStatic
@SuppressWarnings('AbstractClassWithoutAbstractMethod')
abstract class AbstractExecSpec
```
Abstract base class that implements BaseExecSpec.
Since:
0.17.0

Field Summary

Fields
Modifiers	Name	Description
`protected java.util.Map<String, Object>`	`env`
`protected Object`	`workingDir`

Properties Summary

Properties
Type	Name and description
`java.util.Map<String, Object>`	`environment`
`OutputStream`	`errorOutput`
`boolean`	`ignoreExitValue`
`InputStream`	`standardInput`
`OutputStream`	`standardOutput`
`File`	`workingDir`
`File`	`workingDir`

Constructor Summary

Constructors
Constructor and description
`protected AbstractExecSpec (Project project)`
`protected AbstractExecSpec (ProjectOperations project)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`ProcessForkOptions`	`environment(java.util.Map<String, ?> map)` Add additional environment variables for use with the process.
	`ProcessForkOptions`	`environment(String envVar, Object value)` Add additional environment variable for use with the process.
	`BaseExecSpec`	`errorOutput(OutputStream outputStream)` Set the stream where error output should be sent to for this process when executing.
	`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.
	`protected Project`	`getProject()` @return Project if items was created in legacy mode, otherwise `null`.
	`protected ProjectOperations`	`getProjectOperations()` @return ProjectOperations
	`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.
	`BaseExecSpec`	`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.
	`BaseExecSpec`	`setErrorOutput(OutputStream outputStream)` Set the stream where error output should be sent to for this process when executing.
	`BaseExecSpec`	`setIgnoreExitValue(boolean flag)`
	`BaseExecSpec`	`setStandardInput(InputStream inputStream)` Set the stream where standard input should be read from for this process when executing.
	`BaseExecSpec`	`setStandardOutput(OutputStream outputStream)` Set the stream where standard output should be sent to for this process when executing.
	`void`	`setWorkingDir(Object workDir)` Set the working directory for the execution.
	`void`	`setWorkingDir(File workDir)` Set the working directory for the execution.
	`BaseExecSpec`	`standardInput(InputStream inputStream)` Set the stream where standard input should be read from for this process when executing.
	`BaseExecSpec`	`standardOutput(OutputStream outputStream)` Set the stream where standard output should be sent to for this process when executing.
	`ProcessForkOptions`	`workingDir(Object workDir)` Set the working directory for the execution.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Field Detail
  - protected final java.util.Map<String, Object> env
  - protected Object workingDir
- Property Detail
  - java.util.Map<String, Object> environment
  - OutputStream errorOutput
  - boolean ignoreExitValue
  - InputStream standardInput
  - OutputStream standardOutput
  - File workingDir
  - File workingDir
- Constructor Detail
  - @Deprecated protected AbstractExecSpec(Project project)
  - protected AbstractExecSpec(ProjectOperations project)
- Method Detail
  - @Override ProcessForkOptions environment(java.util.Map<String, ?> map)
    
    Add additional environment variables for use with the process.
    Parameters:
    map - Environmental variables as key-value pairs.
    Returns:
    This object as an instance of ProcessForkOptions
  - @Override ProcessForkOptions environment(String envVar, Object value)
    
    Add additional environment variable for use with the process.
    Parameters:
    envVar - Name of environmental variable.
    value - Value of environmental variable.
    Returns:
    This object as an instance of ProcessForkOptions
  - @SuppressWarnings('UnnecessarySetter') @Override BaseExecSpec errorOutput(OutputStream outputStream)
    
    Set the stream where error output should be sent to for this process when executing.
    Parameters:
    outputStream - Output stream to use.
    Returns:
    This object as an instance of BaseExecSpec
  - @Override java.util.Map<String, Object> getEnvironment()
    
    Returns the environment to be used for the process.
    Returns:
    Key-value pairing of environmental variables.
  - @Override OutputStream getErrorOutput()
    
    Where error output is sent to during execution.
    Returns:
    Output stream.
  - @Deprecated protected Project getProject()
    
    deprecated:
    This method is not safe when configuration cache is active. Use getProjectOperations() instead.
    
    Returns:
    Project if items was created in legacy mode, otherwise null.
  - protected ProjectOperations getProjectOperations()
    
    Returns:
    ProjectOperations
    Since:
    1.0
  - @Override InputStream getStandardInput()
    
    Where input is read from during execution.
    Returns:
    Input stream.
  - @Override OutputStream getStandardOutput()
    
    Where standard output is sent to during execution.
    Returns:
    Output stream.
  - @Override File getWorkingDir()
    
    Obtain the working directory for this process. This call will evaluate the lazily-set working directory for setWorkingDir0
    Returns:
    Ajava.io.File object.
  - @Override BaseExecSpec ignoreExitValue(boolean flag)
    
    Determine whether the exit value should be ignored.
    Parameters:
    flag - Whether exit value should be ignored.
    Returns:
    This object as an instance of BaseExecSpec
  - @Override boolean isIgnoreExitValue()
    
    State of exit value monitoring.
    Returns:
    Whether return value should be ignored.
  - @Override void setEnvironment(java.util.Map<String, ?> map)
    
    Set the environment variables to use for the process.
    Parameters:
    map - Environmental variables as key-value pairs.
  - @Override BaseExecSpec setErrorOutput(OutputStream outputStream)
    
    Set the stream where error output should be sent to for this process when executing.
    Parameters:
    outputStream - Output stream to use.
    Returns:
    This object as an instance of BaseExecSpec
  - @Override BaseExecSpec setIgnoreExitValue(boolean flag)
  - @Override BaseExecSpec setStandardInput(InputStream inputStream)
    
    Set the stream where standard input should be read from for this process when executing.
    Parameters:
    inputStream - Inout stream to use.
    Returns:
    This object as an instance of BaseExecSpec
  - @Override BaseExecSpec setStandardOutput(OutputStream outputStream)
    
    Set the stream where standard output should be sent to for this process when executing.
    Parameters:
    outputStream - Output stream to use.
    Returns:
    This object as an instance of BaseExecSpec
  - @Override void setWorkingDir(Object workDir)
    
    Set the working directory for the execution.
    Parameters:
    workDir - Any object that is convertible using Gradle's project.file.
  - @Override void setWorkingDir(File workDir)
    
    Set the working directory for the execution.
    This version has been introduced to deal with the API change in Gradle 4.0.
    Parameters:
    workDir - Working directory as a java.io.File instance.
    Since:
    0.3
  - @SuppressWarnings('UnnecessarySetter') @Override BaseExecSpec standardInput(InputStream inputStream)
    
    Set the stream where standard input should be read from for this process when executing.
    Parameters:
    inputStream - Inout stream to use.
    Returns:
    This object as an instance of BaseExecSpec
  - @SuppressWarnings('UnnecessarySetter') @Override BaseExecSpec standardOutput(OutputStream outputStream)
    
    Set the stream where standard output should be sent to for this process when executing.
    Parameters:
    outputStream - Output stream to use.
    Returns:
    This object as an instance of BaseExecSpec
  - @Override ProcessForkOptions workingDir(Object workDir)
    
    Set the working directory for the execution.
    Parameters:
    workDir - Any object that is convertible using Gradle's project.file.
    Returns:
    This object as ProcessForkOptions

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractExecSpec

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected final java.util.Map<String, Object> env

protected Object workingDir

Property Detail

java.util.Map<String, Object> environment

OutputStream errorOutput

boolean ignoreExitValue

InputStream standardInput

OutputStream standardOutput

File workingDir

File workingDir

Constructor Detail

@Deprecated protected AbstractExecSpec(Project project)

protected AbstractExecSpec(ProjectOperations project)

Method Detail

@Override ProcessForkOptions environment(java.util.Map<String, ?> map)

@Override ProcessForkOptions environment(String envVar, Object value)

@SuppressWarnings('UnnecessarySetter') @Override BaseExecSpec errorOutput(OutputStream outputStream)

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

@Override OutputStream getErrorOutput()

@Deprecated protected Project getProject()

protected ProjectOperations getProjectOperations()

@Override InputStream getStandardInput()

@Override OutputStream getStandardOutput()

@Override File getWorkingDir()

@Override BaseExecSpec ignoreExitValue(boolean flag)

@Override boolean isIgnoreExitValue()

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

@Override BaseExecSpec setErrorOutput(OutputStream outputStream)

@Override BaseExecSpec setIgnoreExitValue(boolean flag)

@Override BaseExecSpec setStandardInput(InputStream inputStream)

@Override BaseExecSpec setStandardOutput(OutputStream outputStream)

@Override void setWorkingDir(Object workDir)

@Override void setWorkingDir(File workDir)

@SuppressWarnings('UnnecessarySetter') @Override BaseExecSpec standardInput(InputStream inputStream)

@SuppressWarnings('UnnecessarySetter') @Override BaseExecSpec standardOutput(OutputStream outputStream)

@Override ProcessForkOptions workingDir(Object workDir)