T - the ConfigurableLauncher implementation to return as part of the fluent API.LongRunningOperationBuildActionExecuter<T>, BuildLauncher, ModelBuilder<T>, TestLauncherpublic interface ConfigurableLauncher<T extends ConfigurableLauncher<T>> extends LongRunningOperation
ConfigurableLauncher allows you to configure a long running operation.| Modifier and Type | Method | Description |
|---|---|---|
T |
addArguments(java.lang.Iterable<java.lang.String> arguments) |
Appends new command line arguments to the existing list.
|
T |
addArguments(java.lang.String... arguments) |
Appends new command line arguments to the existing list.
|
T |
addJvmArguments(java.lang.Iterable<java.lang.String> jvmArguments) |
Appends Java VM arguments to the existing list.
|
T |
addJvmArguments(java.lang.String... jvmArguments) |
Appends Java VM arguments to the existing list.
|
T |
addProgressListener(ProgressListener listener) |
Adds a progress listener which will receive progress events of all types as the operation runs.
|
T |
addProgressListener(ProgressListener listener,
java.util.Set<OperationType> eventTypes) |
Adds a progress listener which will receive progress events as the operations of the requested type run.
|
T |
addProgressListener(ProgressListener listener,
OperationType... operationTypes) |
Adds a progress listener which will receive progress events as the operations of the requested type run.
|
T |
addProgressListener(ProgressListener listener) |
Adds a progress listener which will receive progress events as the operation runs.
|
T |
setColorOutput(boolean colorOutput) |
Specifies whether to generate colored (ANSI encoded) output for logging.
|
T |
setEnvironmentVariables(java.util.Map<java.lang.String,java.lang.String> envVariables) |
Specifies the environment variables to use for this operation.
|
T |
setJavaHome(java.io.File javaHome) |
Specifies the Java home directory to use for this operation.
|
T |
setJvmArguments(java.lang.Iterable<java.lang.String> jvmArguments) |
Specifies the Java VM arguments to use for this operation.
|
T |
setJvmArguments(java.lang.String... jvmArguments) |
Specifies the Java VM arguments to use for this operation.
|
T |
setStandardError(java.io.OutputStream outputStream) |
Sets the
OutputStream which should receive standard error logging generated while running the operation. |
T |
setStandardInput(java.io.InputStream inputStream) |
Sets the
InputStream that will be used as standard input for this operation. |
T |
setStandardOutput(java.io.OutputStream outputStream) |
Sets the
OutputStream which should receive standard output logging generated while running the operation. |
T |
withArguments(java.lang.Iterable<java.lang.String> arguments) |
Specify the command line build arguments.
|
T |
withArguments(java.lang.String... arguments) |
Specify the command line build arguments.
|
T |
withCancellationToken(CancellationToken cancellationToken) |
Sets the cancellation token to use to cancel the operation if required.
|
T |
withSystemProperties(java.util.Map<java.lang.String,java.lang.String> systemProperties) |
Sets system properties to pass to the build.
|
T withArguments(java.lang.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', '-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 Manual
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.
Requires Gradle 1.0 or later.
withArguments in interface LongRunningOperationarguments - Gradle command line argumentsT withArguments(java.lang.Iterable<java.lang.String> arguments)
BuildLauncher.
If not configured, null, or an empty list is passed, then the reasonable default will be used.
Requires Gradle 1.0 or later.
withArguments in interface LongRunningOperationarguments - Gradle command line argumentsT addArguments(java.lang.String... arguments)
BuildLauncher.addArguments in interface LongRunningOperationarguments - Gradle command line argumentsT addArguments(java.lang.Iterable<java.lang.String> arguments)
BuildLauncher.addArguments in interface LongRunningOperationarguments - Gradle command line argumentsT setStandardOutput(java.io.OutputStream outputStream)
OutputStream which should receive standard output logging generated while running the operation.
The default is to discard the output.setStandardOutput in interface LongRunningOperationoutputStream - The output stream. The system default character encoding will be used to encode characters written to this stream.T setStandardError(java.io.OutputStream outputStream)
OutputStream which should receive standard error logging generated while running the operation.
The default is to discard the output.setStandardError in interface LongRunningOperationoutputStream - The output stream. The system default character encoding will be used to encode characters written to this stream.T setColorOutput(boolean colorOutput)
Supported by Gradle 2.3 or later. Ignored for older versions.
setColorOutput in interface LongRunningOperationcolorOutput - true to request color output (using ANSI encoding).T setStandardInput(java.io.InputStream inputStream)
InputStream that will be used as standard input for this operation.
Defaults to an empty input stream.setStandardInput in interface LongRunningOperationinputStream - The input streamT setJavaHome(java.io.File javaHome)
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.
setJavaHome in interface LongRunningOperationjavaHome - to use for the Gradle processT setJvmArguments(java.lang.String... jvmArguments)
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.
setJvmArguments in interface LongRunningOperationjvmArguments - to use for the Gradle processT setJvmArguments(java.lang.Iterable<java.lang.String> jvmArguments)
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 list is passed, then the reasonable default will be used.
setJvmArguments in interface LongRunningOperationjvmArguments - to use for the Gradle processT addJvmArguments(java.lang.String... jvmArguments)
addJvmArguments in interface LongRunningOperationjvmArguments - the argument to use for the Gradle processT withSystemProperties(java.util.Map<java.lang.String,java.lang.String> systemProperties)
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(...)Note: this method has "setter" behavior, so the last invocation will overwrite previously set values.
withSystemProperties in interface LongRunningOperationsystemProperties - the system properties add to the Gradle process. Passing null resets to the default behavior.T addJvmArguments(java.lang.Iterable<java.lang.String> jvmArguments)
addJvmArguments in interface LongRunningOperationjvmArguments - the argument to use for the Gradle processT setEnvironmentVariables(java.util.Map<java.lang.String,java.lang.String> envVariables)
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 reasonable default will be used.
setEnvironmentVariables in interface LongRunningOperationenvVariables - environment variablesT addProgressListener(ProgressListener listener)
This method is intended to be replaced by LongRunningOperation.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.
addProgressListener in interface LongRunningOperationlistener - The listenerT addProgressListener(ProgressListener listener)
This method is intended to replace LongRunningOperation.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.TEST operations only. Ignored for older versions.
addProgressListener in interface LongRunningOperationlistener - The listenerT addProgressListener(ProgressListener listener, java.util.Set<OperationType> eventTypes)
This method is intended to replace LongRunningOperation.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.TEST operations only. Ignored for older versions.
addProgressListener in interface LongRunningOperationlistener - The listenereventTypes - The types of operations to receive progress events for.T addProgressListener(ProgressListener listener, OperationType... operationTypes)
This method is intended to replace LongRunningOperation.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.TEST operations only. Ignored for older versions.
addProgressListener in interface LongRunningOperationlistener - The listeneroperationTypes - The types of operations to receive progress events for.T withCancellationToken(CancellationToken cancellationToken)
Supported by Gradle 2.1 or later. Ignored for older versions.
withCancellationToken in interface LongRunningOperation