Groovy Documentation

org.gradle.process
[Java] Interface BaseExecSpec

org.gradle.process.ProcessForkOptions
  org.gradle.process.BaseExecSpec
All Superinterfaces:
ProcessForkOptions

public interface BaseExecSpec
extends ProcessForkOptions

Specifies options for launching a child process.


Method Summary
List getCommandLine()

Returns the full command line, including the executable plus its arguments.

OutputStream getErrorOutput()

Returns the output stream to consume standard error from the process executing the command.

InputStream getStandardInput()

Returns the standard input stream for the process executing the command.

OutputStream getStandardOutput()

Returns the output stream to consume standard output from the process executing the command.

boolean isIgnoreExitValue()

Tells whether a non-zero exit value is ignored, or an exception thrown.

BaseExecSpec setErrorOutput(OutputStream outputStream)

Sets the output stream to consume standard error from the process executing the command.

BaseExecSpec setIgnoreExitValue(boolean ignoreExitValue)

Sets whether a non-zero exit value is ignored, or an exception thrown.

BaseExecSpec setStandardInput(InputStream inputStream)

Sets the standard input stream for the process executing the command.

BaseExecSpec setStandardOutput(OutputStream outputStream)

Sets the output stream to consume standard output from the process executing the command.

 
Methods inherited from interface ProcessForkOptions
copyTo, environment, environment, executable, getEnvironment, getExecutable, getWorkingDir, setEnvironment, setExecutable, setWorkingDir, workingDir
 

Method Detail

getCommandLine

public List getCommandLine()
Returns the full command line, including the executable plus its arguments.
Returns:
The full command line, including the executable plus its arguments


getErrorOutput

public OutputStream getErrorOutput()
Returns the output stream to consume standard error from the process executing the command. Default to System.err.
Returns:
The error output stream.


getStandardInput

public InputStream getStandardInput()
Returns the standard input stream for the process executing the command. The stream is closed after the process completes. Defaults to an empty stream.
Returns:
The standard input stream.


getStandardOutput

public OutputStream getStandardOutput()
Returns the output stream to consume standard output from the process executing the command. Defaults to System.out.
Returns:
The output stream


isIgnoreExitValue

public boolean isIgnoreExitValue()
Tells whether a non-zero exit value is ignored, or an exception thrown. Defaults to false.
Returns:
whether a non-zero exit value is ignored, or an exception thrown


setErrorOutput

public BaseExecSpec setErrorOutput(OutputStream outputStream)
Sets the output stream to consume standard error from the process executing the command. The stream is closed after the process completes.
Parameters:
outputStream - The standard output error stream for the process. Must not be null.
Returns:
this


setIgnoreExitValue

public BaseExecSpec setIgnoreExitValue(boolean ignoreExitValue)
Sets whether a non-zero exit value is ignored, or an exception thrown.
Parameters:
ignoreExitValue - whether a non-zero exit value is ignored, or an exception thrown
Returns:
this


setStandardInput

public BaseExecSpec setStandardInput(InputStream inputStream)
Sets the standard input stream for the process executing the command. The stream is closed after the process completes.
Parameters:
inputStream - The standard input stream for the process. Must not be null.
Returns:
this


setStandardOutput

public BaseExecSpec setStandardOutput(OutputStream outputStream)
Sets the output stream to consume standard output from the process executing the command. The stream is closed after the process completes.
Parameters:
outputStream - The standard output stream for the process. Must not be null.
Returns:
this


 

Gradle API 1.12