Interface LongRunningOperation
- All Known Subinterfaces:
- BuildActionExecuter<T>,- BuildLauncher,- ConfigurableLauncher<T>,- ModelBuilder<T>,- TestLauncher
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.
- Since:
- 1.0-milestone-7
- 
Method SummaryModifier and TypeMethodDescriptionaddArguments(Iterable<String> arguments) Appends new command line arguments to the existing list.addArguments(String... arguments) Appends new command line arguments to the existing list.addJvmArguments(Iterable<String> jvmArguments) Appends Java VM arguments to the existing list.addJvmArguments(String... jvmArguments) Appends Java VM arguments to the existing list.addProgressListener(ProgressListener listener) Adds a progress listener which will receive progress events of all types as the operation runs.addProgressListener(ProgressListener listener, Set<OperationType> operationTypes) Adds a progress listener which will receive progress events as the operations of the requested type run.addProgressListener(ProgressListener listener, OperationType... operationTypes) Adds a progress listener which will receive progress events as the operations of the requested type run.addProgressListener(ProgressListener listener) Adds a progress listener which will receive progress events as the operation runs.setColorOutput(boolean colorOutput) Specifies whether to generate colored (ANSI encoded) output for logging.setEnvironmentVariables(Map<String, String> envVariables) Specifies the environment variables to use for this operation.setJavaHome(File javaHome) Specifies the Java home directory to use for this operation.setJvmArguments(Iterable<String> jvmArguments) Specifies the Java VM arguments to use for this operation.setJvmArguments(String... jvmArguments) Specifies the Java VM arguments to use for this operation.setStandardError(OutputStream outputStream) Sets theOutputStreamwhich should receive standard error logging generated while running the operation.setStandardInput(InputStream inputStream) Sets theInputStreamthat will be used as standard input for this operation.setStandardOutput(OutputStream outputStream) Sets theOutputStreamwhich should receive standard output logging generated while running the operation.withArguments(Iterable<String> arguments) Specify the command line build arguments.withArguments(String... arguments) Specify the command line build arguments.withCancellationToken(CancellationToken cancellationToken) Sets the cancellation token to use to cancel the operation if required.Adds more detailed information about the build failure to theGradleConnectionExceptionthat provides insights into the reasons for the failure, making it easier to diagnose and fix issues.withSystemProperties(Map<String, String> systemProperties) Sets system properties to pass to the build.
- 
Method Details- 
setStandardOutputSets theOutputStreamwhich should receive standard output logging generated while running the operation. The default is to discard the output.- Parameters:
- outputStream- The output stream. The system default character encoding will be used to encode characters written to this stream.
- Returns:
- this
- Since:
- 1.0-milestone-7
 
- 
setStandardErrorSets theOutputStreamwhich should receive standard error logging generated while running the operation. The default is to discard the output.- Parameters:
- outputStream- The output stream. The system default character encoding will be used to encode characters written to this stream.
- Returns:
- this
- Since:
- 1.0-milestone-7
 
- 
setColorOutputSpecifies whether to generate colored (ANSI encoded) output for logging. The default is to not generate color output.Supported by Gradle 2.3 or later. Ignored for older versions. - Parameters:
- colorOutput-- trueto request color output (using ANSI encoding).
- Returns:
- this
- Since:
- 2.3
 
- 
setStandardInputSets theInputStreamthat will be used as standard input for this operation. Defaults to an empty input stream.- Parameters:
- inputStream- The input stream
- Returns:
- this
- Since:
- 1.0-milestone-8
 
- 
setJavaHomeSpecifies the Java home directory to use for this operation.BuildEnvironmentmodel 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. - Parameters:
- javaHome- to use for the Gradle process
- Returns:
- this
- Throws:
- IllegalArgumentException- when supplied javaHome is not a valid folder.
- Since:
- 1.0-milestone-8
 
- 
setJvmArgumentsSpecifies the Java VM arguments to use for this operation.BuildEnvironmentmodel 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. The jvm argument set by this method is independent of arguments set by { addJvmArguments} methods. The daemon JVM arguments list will always have the arguments from the {setJvmArguments} at the beginning of the list, and then have the {addJvmArguments} configuration appended.- Parameters:
- jvmArguments- to use for the Gradle process
- Returns:
- this
- Since:
- 1.0-milestone-8
 
- 
addJvmArgumentsAppends Java VM arguments to the existing list.The jvm argument set by this method is independent of arguments set by { setJvmArguments} methods. The daemon JVM arguments list will always have the arguments from the {setJvmArguments} at the beginning of the list, and then have the {addJvmArguments} configuration appended.- Parameters:
- jvmArguments- the argument to use for the Gradle process
- Returns:
- this
- Since:
- 5.0
 
- 
withSystemPropertiesSets system properties to pass to the build.By default, the Tooling API passes all system properties defined in the client to the build. If called, this method limits the system properties that are passed to the build, except for immutable system properties that need to match on both sides. System properties can be also defined in the build scripts (and in the gradle.properties file), or with a JVM argument. In case of an overlapping system property definition the precedence is as follows: - withSystemProperties(...)(highest)
- addJvmArguments(...)and- setJvmArguments(...)
- build scripts
 Note: this method has "setter" behavior, so the last invocation will overwrite previously set values. - Parameters:
- systemProperties- the system properties add to the Gradle process. Passing- nullresets to the default behavior.
- Returns:
- this
- Since:
- 7.6
 
- 
addJvmArgumentsAppends Java VM arguments to the existing list.The jvm argument set by this method is independent of arguments set by { setJvmArguments} methods. The daemon JVM arguments list will always have the arguments from the {setJvmArguments} at the beginning of the list, and then have the {addJvmArguments} configuration appended.- Parameters:
- jvmArguments- the argument to use for the Gradle process
- Returns:
- this
- Since:
- 5.0
 
- 
setJvmArgumentsSpecifies the Java VM arguments to use for this operation.BuildEnvironmentmodel 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 list is passed, then the reasonable default will be used. The jvm argument set by this method is independent of arguments set by { addJvmArguments} methods. The daemon JVM arguments list will always have the arguments from the {setJvmArguments} at the beginning of the list, and then have the {addJvmArguments} configuration appended.- Parameters:
- jvmArguments- to use for the Gradle process
- Returns:
- this
- Since:
- 2.6
 
- 
withArgumentsSpecify the command line build arguments. Useful mostly for running tasks viaBuildLauncher.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', '-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, UnsupportedBuildArgumentExceptionwill be thrown at the time the operation is executed viaBuildLauncher.run()orModelBuilder.get().For the list of all Gradle command line options please refer to the User Manual or take a look at the output of the 'gradle -?' command. Majority of arguments modeled by StartParameterare 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 byBuildLauncher.forTasks(String...)can be overridden if you happen to specify other tasks via the build arguments.See the example in the docs for BuildLauncherIf not configured, null, or an empty array is passed, then the reasonable default will be used.Requires Gradle 1.0 or later. - Parameters:
- arguments- Gradle command line arguments
- Returns:
- this
- Since:
- 1.0
 
- 
withArgumentsSpecify the command line build arguments. Useful mostly for running tasks viaBuildLauncher.If not configured, null, or an empty list is passed, then the reasonable default will be used. Requires Gradle 1.0 or later. - Parameters:
- arguments- Gradle command line arguments
- Returns:
- this
- Since:
- 2.6
 
- 
addArgumentsAppends new command line arguments to the existing list. Useful mostly for running tasks viaBuildLauncher.- Parameters:
- arguments- Gradle command line arguments
- Returns:
- this
- Since:
- 5.0
 
- 
addArgumentsAppends new command line arguments to the existing list. Useful mostly for running tasks viaBuildLauncher.- Parameters:
- arguments- Gradle command line arguments
- Returns:
- this
- Since:
- 5.0
 
- 
setEnvironmentVariablesSpecifies the environment variables to use for this operation.BuildEnvironmentmodel 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 reasonable default will be used. - Parameters:
- envVariables- environment variables
- Returns:
- this
- Since:
- 3.5
 
- 
addProgressListenerAdds a progress listener which will receive progress events as the operation runs.This method is intended to be replaced by addProgressListener(org.gradle.tooling.events.ProgressListener). The new progress listener type provides much richer information and much better handling of parallel operations that run during the build, such as tasks that run in parallel. You should prefer using the new listener interface where possible. Note, however, that the new interface is supported only for Gradle 2.5.- Parameters:
- listener- The listener
- Returns:
- this
- Since:
- 1.0-milestone-7
 
- 
addProgressListenerAdds a progress listener which will receive progress events of all types as the operation runs.This method is intended to replace addProgressListener(ProgressListener). You should prefer using the new progress listener method where possible, as the new interface provides much richer information and much better handling of parallel operations that run during the build.Supported by Gradle 2.5 or later. Gradle 2.4 supports OperationType.TESToperations only. Ignored for older versions.- Parameters:
- listener- The listener
- Returns:
- this
- Since:
- 2.5
 
- 
addProgressListenerLongRunningOperation addProgressListener(ProgressListener listener, Set<OperationType> operationTypes) Adds a progress listener which will receive progress events as the operations of the requested type run.This method is intended to replace addProgressListener(ProgressListener). You should prefer using the new progress listener method where possible, as the new interface provides much richer information and much better handling of parallel operations that run during the build.Supported by Gradle 2.5 or later. Gradle 2.4 supports OperationType.TESToperations only. Ignored for older versions.- Parameters:
- listener- The listener
- operationTypes- The types of operations to receive progress events for.
- Returns:
- this
- Since:
- 2.5
 
- 
addProgressListenerLongRunningOperation addProgressListener(ProgressListener listener, OperationType... operationTypes) Adds a progress listener which will receive progress events as the operations of the requested type run.This method is intended to replace addProgressListener(ProgressListener). You should prefer using the new progress listener method where possible, as the new interface provides much richer information and much better handling of parallel operations that run during the build.Supported by Gradle 2.5 or later. Gradle 2.4 supports OperationType.TESToperations only. Ignored for older versions.- Parameters:
- listener- The listener
- operationTypes- The types of operations to receive progress events for.
- Returns:
- this
- Since:
- 2.6
 
- 
withCancellationTokenSets the cancellation token to use to cancel the operation if required.Supported by Gradle 2.1 or later. Ignored for older versions. - Since:
- 2.1
 
- 
withDetailedFailureAdds more detailed information about the build failure to theGradleConnectionExceptionthat provides insights into the reasons for the failure, making it easier to diagnose and fix issues.- Returns:
- this
- Since:
- 8.12
 
 
-