public interface LongRunningOperation
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).
Enables configuring the build run / model request with options like the Java home or JVM arguments. Those settings might not be supported by the target Gradle version. Refer to Javadoc for those methods to understand what kind of exception throw and when is it thrown.
| Modifier and Type | Method and Description |
|---|---|
LongRunningOperation |
addProgressListener(ProgressListener listener)
Adds a progress listener which will receive progress events as the operation runs.
|
LongRunningOperation |
addProgressListener(ProgressListener listener)
Adds a progress listener which will receive progress events of all types as the operation runs.
|
LongRunningOperation |
addProgressListener(ProgressListener listener,
Set<OperationType> operationTypes)
Adds a progress listener which will receive progress events as the operations of the requested type run.
|
LongRunningOperation |
setColorOutput(boolean colorOutput)
Specifies whether to generate colored (ANSI encoded) output for logging.
|
LongRunningOperation |
setJavaHome(File javaHome)
Specifies the Java home directory to use for this operation.
|
LongRunningOperation |
setJvmArguments(String... jvmArguments)
Specifies the Java VM arguments to use for this operation.
|
LongRunningOperation |
setStandardError(OutputStream outputStream)
Sets the
OutputStream which should receive standard error logging generated while running the operation. |
LongRunningOperation |
setStandardInput(InputStream inputStream)
Sets the
InputStream that will be used as standard input for this operation. |
LongRunningOperation |
setStandardOutput(OutputStream outputStream)
Sets the
OutputStream which should receive standard output logging generated while running the operation. |
LongRunningOperation |
withArguments(String... arguments)
Specify the command line build arguments.
|
LongRunningOperation |
withCancellationToken(CancellationToken cancellationToken)
Sets the cancellation token to use to cancel the operation if required.
|
LongRunningOperation setStandardOutput(OutputStream outputStream)
OutputStream which should receive standard output logging generated while running the operation.
The default is to discard the output.outputStream - The output stream. The system default character encoding will be used to encode characters written to this stream.LongRunningOperation setStandardError(OutputStream outputStream)
OutputStream which should receive standard error logging generated while running the operation.
The default is to discard the output.outputStream - The output stream. The system default character encoding will be used to encode characters written to this stream.@Incubating LongRunningOperation setColorOutput(boolean colorOutput)
colorOutput - true to request color output (using ANSI encoding).LongRunningOperation setStandardInput(InputStream inputStream)
InputStream that will be used as standard input for this operation.
Defaults to an empty input stream.
If the target Gradle version does not support it the long running operation will fail with
UnsupportedOperationConfigurationException when the operation is started.
inputStream - The input streamLongRunningOperation setJavaHome(File javaHome) throws IllegalArgumentException
If the target Gradle version does not support it the long running operation will fail eagerly with
UnsupportedOperationConfigurationException 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 is passed, then the sensible default will be used.
javaHome - to use for the Gradle processIllegalArgumentException - when supplied javaHome is not a valid folder.LongRunningOperation setJvmArguments(String... jvmArguments)
If the target Gradle version does not support it the long running operation will fail eagerly with
UnsupportedOperationConfigurationException 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, or an empty array is passed, then the reasonable default will be used.
jvmArguments - to use for the Gradle processLongRunningOperation withArguments(String... arguments)
BuildLauncher.
Be aware that not all of the Gradle command line options are supported!
Only the build arguments that configure the build execution are supported.
They are modelled in the Gradle API via StartParameter.
Examples of supported build arguments: '--info', '-u', '-p'.
The command line instructions that are actually separate commands (like '-?' and '-v') are not supported.
Some other instructions like '--daemon' are also not supported - the tooling API always runs with the daemon.
If an unknown or unsupported command line option is specified, UnsupportedBuildArgumentException
will be thrown at the time the operation is executed via BuildLauncher.run() or ModelBuilder.get().
For the list of all Gradle command line options please refer to the user guide
or take a look at the output of the 'gradle -?' command. Majority of arguments modeled by
StartParameter are supported.
The arguments can potentially override some other settings you have configured.
For example, the project directory or Gradle user home directory that are configured
in the GradleConnector.
Also, the task names configured by BuildLauncher.forTasks(String...) can be overridden
if you happen to specify other tasks via the build arguments.
See the example in the docs for BuildLauncher
If not configured, null, or an empty array is passed, then the reasonable default will be used.
arguments - Gradle command line argumentsLongRunningOperation addProgressListener(ProgressListener listener)
listener - The listener@Incubating LongRunningOperation addProgressListener(ProgressListener listener)
listener - The listener@Incubating LongRunningOperation addProgressListener(ProgressListener listener, Set<OperationType> operationTypes)
listener - The listeneroperationTypes - The types of operations to receive progress events for.@Incubating LongRunningOperation withCancellationToken(CancellationToken cancellationToken)