BuildActionExecuter (Gradle API 2.5)

Type Parameters:
T - The type of result produced by this executer.

All Superinterfaces:

LongRunningOperation
```
@Incubating
public interface BuildActionExecuter<T>
extends LongRunningOperation
```
Used to execute a BuildAction in the build process.

Since:

1.8

Method Summary

Methods
Modifier and Type	Method and Description
`BuildActionExecuter<T>`	`addProgressListener(ProgressListener listener)` Adds a progress listener which will receive progress events as the operation runs.
`BuildActionExecuter<T>`	`addProgressListener(ProgressListener listener)` Adds a progress listener which will receive progress events of all types as the operation runs.
`BuildActionExecuter<T>`	`addProgressListener(ProgressListener listener, Set<OperationType> eventTypes)` Adds a progress listener which will receive progress events as the operations of the requested type run.
`T`	`run()` Runs the action, blocking until its result is available.
`void`	`run(ResultHandler<? super T> handler)` Starts executing the action, passing the result to the given handler when complete.
`BuildActionExecuter<T>`	`setColorOutput(boolean colorOutput)` Specifies whether to generate colored (ANSI encoded) output for logging.
`BuildActionExecuter<T>`	`setJavaHome(File javaHome)` Specifies the Java home directory to use for this operation.
`BuildActionExecuter<T>`	`setJvmArguments(String... jvmArguments)` Specifies the Java VM arguments to use for this operation.
`BuildActionExecuter<T>`	`setStandardError(OutputStream outputStream)` Sets the `OutputStream` which should receive standard error logging generated while running the operation.
`BuildActionExecuter<T>`	`setStandardInput(InputStream inputStream)` Sets the `InputStream` that will be used as standard input for this operation.
`BuildActionExecuter<T>`	`setStandardOutput(OutputStream outputStream)` Sets the `OutputStream` which should receive standard output logging generated while running the operation.
`BuildActionExecuter<T>`	`withArguments(String... arguments)` Specify the command line build arguments.
`BuildActionExecuter<T>`	`withCancellationToken(CancellationToken cancellationToken)` Sets the cancellation token to use to cancel the operation if required.

- Method Detail
  - withArguments
```
BuildActionExecuter<T> withArguments(String... arguments)
```
    Specify the command line build arguments. Useful mostly for running tasks via 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.
    
    Specified by:
    
    withArguments in interface LongRunningOperation
    
    Parameters:
    arguments - Gradle command line arguments
    
    Returns:
    this
    Since:
    
    2.3
  - setStandardOutput
```
BuildActionExecuter<T> setStandardOutput(OutputStream outputStream)
```
    Sets the OutputStream which should receive standard output logging generated while running the operation. The default is to discard the output.
    
    Specified by:
    
    setStandardOutput in interface LongRunningOperation
    
    Parameters:
    outputStream - The output stream. The system default character encoding will be used to encode characters written to this stream.
    
    Returns:
    this
    Since:
    
    2.3
  - setStandardError
```
BuildActionExecuter<T> setStandardError(OutputStream outputStream)
```
    Sets the OutputStream which should receive standard error logging generated while running the operation. The default is to discard the output.
    
    Specified by:
    
    setStandardError in interface LongRunningOperation
    
    Parameters:
    outputStream - The output stream. The system default character encoding will be used to encode characters written to this stream.
    
    Returns:
    this
    Since:
    
    2.3
  - setColorOutput
```
@Incubating
BuildActionExecuter<T> setColorOutput(boolean colorOutput)
```
    Specifies whether to generate colored (ANSI encoded) output for logging. The default is to not generate color output.
    
    Specified by:
    
    setColorOutput in interface LongRunningOperation
    
    Parameters:
    colorOutput - true to request color output (using ANSI encoding).
    
    Returns:
    this
    Since:
    
    2.3
  - setStandardInput
```
BuildActionExecuter<T> setStandardInput(InputStream inputStream)
```
    Sets the 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.
    
    Specified by:
    
    setStandardInput in interface LongRunningOperation
    
    Parameters:
    inputStream - The input stream
    
    Returns:
    this
    Since:
    
    2.3
  - setJavaHome
```
BuildActionExecuter<T> setJavaHome(File javaHome)
```
    Specifies the Java home directory to use for this operation.
    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.
    
    Specified by:
    
    setJavaHome in interface LongRunningOperation
    
    Parameters:
    javaHome - to use for the Gradle process
    
    Returns:
    this
    Since:
    
    2.3
  - setJvmArguments
```
BuildActionExecuter<T> setJvmArguments(String... jvmArguments)
```
    Specifies the Java VM arguments to use for this operation.
    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.
    
    Specified by:
    
    setJvmArguments in interface LongRunningOperation
    
    Parameters:
    jvmArguments - to use for the Gradle process
    
    Returns:
    this
    Since:
    
    2.3
  - addProgressListener
```
BuildActionExecuter<T> addProgressListener(ProgressListener listener)
```
    Adds a progress listener which will receive progress events as the operation runs.
    
    Specified by:
    
    addProgressListener in interface LongRunningOperation
    
    Parameters:
    listener - The listener
    
    Returns:
    this
    Since:
    
    2.3
  - addProgressListener
```
@Incubating
BuildActionExecuter<T> addProgressListener(ProgressListener listener)
```
    Adds a progress listener which will receive progress events of all types as the operation runs.
    
    Specified by:
    
    addProgressListener in interface LongRunningOperation
    
    Parameters:
    listener - The listener
    
    Returns:
    this
    Since:
    
    2.5
  - addProgressListener
```
@Incubating
BuildActionExecuter<T> addProgressListener(ProgressListener listener,
                                                    Set<OperationType> eventTypes)
```
    Adds a progress listener which will receive progress events as the operations of the requested type run.
    
    Specified by:
    
    addProgressListener in interface LongRunningOperation
    
    Parameters:
    listener - The listener
    eventTypes - The types of operations to receive progress events for.
    
    Returns:
    this
    Since:
    
    2.5
  - withCancellationToken
```
@Incubating
BuildActionExecuter<T> withCancellationToken(CancellationToken cancellationToken)
```
    Sets the cancellation token to use to cancel the operation if required.
    
    Specified by:
    
    withCancellationToken in interface LongRunningOperation
    
    Since:
    
    2.3
  - run
```
T run()
      throws GradleConnectionException,
             IllegalStateException
```
    Runs the action, blocking until its result is available.
    
    Throws:
    
    UnsupportedVersionException - When the target Gradle version does not support build action execution.
    
    UnsupportedOperationConfigurationException - When the target Gradle version does not support some requested configuration option such as setStandardInput(java.io.InputStream), setJavaHome(java.io.File), setJvmArguments(String...).
    
    UnsupportedBuildArgumentException - When there is a problem with build arguments provided by withArguments(String...).
    
    BuildActionFailureException - When the build action fails with an exception.
    
    BuildCancelledException - When the operation was cancelled before it completed successfully.
    
    BuildException - On some failure executing the Gradle build.
    
    GradleConnectionException - On some other failure using the connection.
    
    IllegalStateException - When the connection has been closed or is closing.
    Since:
    
    1.8
  - run
```
void run(ResultHandler<? super T> handler)
         throws IllegalStateException
```
    Starts executing the action, passing the result to the given handler when complete. This method returns immediately, and the result is later passed to the given handler's ResultHandler.onComplete(Object) method.
    If the operation fails, the handler's ResultHandler.onFailure(GradleConnectionException) method is called with the appropriate exception. See run() for a description of the various exceptions that the operation may fail with.
    
    Parameters:
    handler - The handler to supply the result to.
    
    Throws:
    
    IllegalStateException - When the connection has been closed or is closing.
    Since:
    
    1.8

Interface BuildActionExecuter<T>

Method Summary

Method Detail

withArguments

setStandardOutput

setStandardError

setColorOutput

setStandardInput

setJavaHome

setJvmArguments

addProgressListener

addProgressListener

addProgressListener

withCancellationToken

run

run