org.gradle.tooling
Interface LongRunningOperation

All Known Subinterfaces:

BuildLauncher, ModelBuilder<T>

public interface LongRunningOperation

Offers ways to communicate both ways with a gradle operation, be it building a model or running tasks.

Enables tracking progress via listeners that will receive events from the gradle operation.

Allows providing standard output streams that will receive output if the gradle operation writes to standard streams.

Allows providing standard input that can be consumed by the gradle operation (useful for interactive builds).

setStandardOutput

LongRunningOperation setStandardOutput(OutputStream outputStream)

Sets the OutputStream which should receive standard output logging generated while running the operation. The default is to discard the output.

Parameters:

outputStream - The output stream.

Returns:

this

setStandardError

LongRunningOperation setStandardError(OutputStream outputStream)

Sets the OutputStream which should receive standard error logging generated while running the operation. The default is to discard the output.

Parameters:

outputStream - The output stream.

Returns:

this

setStandardInput

LongRunningOperation setStandardInput(InputStream inputStream)

If the target gradle version supports it you can use this setting to set the standard InputStream that will be used by builds. Useful when the tooling api drives interactive builds.

If the target gradle version does not support it the long running operation will fail eagerly with UnsupportedMethodException when the operation is started.

If not configured or null passed the dummy input stream with zero bytes is used to avoid the build hanging problems.

Parameters:

inputStream - The input stream

Returns:

this

Since:

1.0-milestone-8

setJavaHome

LongRunningOperation setJavaHome(File javaHome)
                                 throws IllegalArgumentException

If the target gradle version supports it you can use this setting to specify the java home directory to use for the long running operation.

If the target gradle version does not support it the long running operation will fail eagerly with UnsupportedMethodException when the operation is started.

BuildEnvironment model contains information such as java or gradle environment. If you want to get hold of this information you can ask tooling API to build this model.

If not configured or null passed the sensible default will be used.

Parameters:

javaHome - to use for the gradle process

Returns:

this

Throws:

IllegalArgumentException - when supplied javaHome is not a valid folder. Also when javaHome does not seem to be a valid jdk or jre folder.

Since:

1.0-milestone-8

setJvmArguments

LongRunningOperation setJvmArguments(String... jvmArguments)

If the target gradle version supports it you can use this setting to specify the java vm arguments to use for the long running operation.

If the target gradle version does not support it the long running operation will fail eagerly with UnsupportedMethodException when the operation is started.

BuildEnvironment model contains information such as java or gradle environment. If you want to get hold of this information you can ask tooling API to build this model.

If not configured, null an empty array passed then the reasonable default will be used.

Parameters:

jvmArguments - to use for the gradle process

Returns:

this

Since:

1.0-milestone-9

addProgressListener

LongRunningOperation addProgressListener(ProgressListener listener)

Adds a progress listener which will receive progress events as the operation runs.

Parameters:

listener - The listener

Returns:

this