org.gradle.process.internal

Class AbstractExecHandleBuilder

java.lang.Object

org.gradle.process.internal.DefaultProcessForkOptions

org.gradle.process.internal.AbstractExecHandleBuilder

All Implemented Interfaces:

BaseExecSpec, ProcessForkOptions

Direct Known Subclasses:

ExecHandleBuilder, JavaExecHandleBuilder

public abstract class AbstractExecHandleBuilder
extends DefaultProcessForkOptions
implements BaseExecSpec

Author:

Hans Dockter

Constructor Summary

Constructors

Constructor and Description
AbstractExecHandleBuilder(FileResolver fileResolver)

Method Summary

Methods

Modifier and Type	Method and Description
ExecHandle	build()
abstract List<String>	getAllArguments()
List<String>	getCommandLine() Returns the full command line, including the executable plus its arguments.
String	getDisplayName()
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.
AbstractExecHandleBuilder	listener(ExecHandleListener listener)
void	setDisplayName(String displayName)
AbstractExecHandleBuilder	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.
AbstractExecHandleBuilder	setStandardInput(InputStream inputStream) Sets the standard input stream for the process executing the command.
AbstractExecHandleBuilder	setStandardOutput(OutputStream outputStream) Sets the output stream to consume standard output from the process executing the command.

Methods inherited from class org.gradle.process.internal.DefaultProcessForkOptions

copyTo, environment, environment, executable, getActualEnvironment, getEnvironment, getExecutable, getResolver, getWorkingDir, setEnvironment, setExecutable, setWorkingDir, workingDir

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gradle.process.ProcessForkOptions

copyTo, environment, environment, executable, getEnvironment, getExecutable, getWorkingDir, setEnvironment, setExecutable, setWorkingDir, workingDir

Constructor Detail

AbstractExecHandleBuilder

public AbstractExecHandleBuilder(FileResolver fileResolver)

Method Detail

getAllArguments

public abstract List<String> getAllArguments()

getCommandLine

public List<String> getCommandLine()

Description copied from interface: BaseExecSpec

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

Specified by:

getCommandLine in interface BaseExecSpec

Returns:

The full command line, including the executable plus its arguments

setStandardInput

public AbstractExecHandleBuilder setStandardInput(InputStream inputStream)

Description copied from interface: BaseExecSpec

Sets the standard input stream for the process executing the command. The stream is closed after the process completes.

Specified by:

setStandardInput in interface BaseExecSpec

Parameters:

inputStream - The standard input stream for the process. Must not be null.

Returns:

this

getStandardInput

public InputStream getStandardInput()

Description copied from interface: BaseExecSpec

Returns the standard input stream for the process executing the command. The stream is closed after the process completes. Defaults to an empty stream.

Specified by:

getStandardInput in interface BaseExecSpec

Returns:

The standard input stream.

setStandardOutput

public AbstractExecHandleBuilder setStandardOutput(OutputStream outputStream)

Description copied from interface: BaseExecSpec

Sets the output stream to consume standard output from the process executing the command. The stream is closed after the process completes.

Specified by:

setStandardOutput in interface BaseExecSpec

Parameters:

outputStream - The standard output stream for the process. Must not be null.

Returns:

this

getStandardOutput

public OutputStream getStandardOutput()

Description copied from interface: BaseExecSpec

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

Specified by:

getStandardOutput in interface BaseExecSpec

Returns:

The output stream

setErrorOutput

public AbstractExecHandleBuilder setErrorOutput(OutputStream outputStream)

Description copied from interface: BaseExecSpec

Sets the output stream to consume standard error from the process executing the command. The stream is closed after the process completes.

Specified by:

setErrorOutput in interface BaseExecSpec

Parameters:

outputStream - The standard output error stream for the process. Must not be null.

Returns:

this

getErrorOutput

public OutputStream getErrorOutput()

Description copied from interface: BaseExecSpec

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

Specified by:

getErrorOutput in interface BaseExecSpec

Returns:

The error output stream.

isIgnoreExitValue

public boolean isIgnoreExitValue()

Description copied from interface: BaseExecSpec

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

Specified by:

isIgnoreExitValue in interface BaseExecSpec

Returns:

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

setIgnoreExitValue

public BaseExecSpec setIgnoreExitValue(boolean ignoreExitValue)

Description copied from interface: BaseExecSpec

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

Specified by:

setIgnoreExitValue in interface BaseExecSpec

Parameters:

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

Returns:

this

getDisplayName

public String getDisplayName()

setDisplayName

public void setDisplayName(String displayName)

listener

public AbstractExecHandleBuilder listener(ExecHandleListener listener)

build

public ExecHandle build()