T
- The type of result produced by this executer.ConfigurableLauncher<BuildActionExecuter<T>>
, LongRunningOperation
@Incubating public interface BuildActionExecuter<T> extends ConfigurableLauncher<BuildActionExecuter<T>>
BuildAction
in the build process.Modifier and Type | Method | Description |
---|---|---|
BuildActionExecuter<T> |
forTasks(Iterable<String> tasks) |
Specifies the tasks to execute before executing the BuildAction.
|
BuildActionExecuter<T> |
forTasks(String... tasks) |
Specifies the tasks to execute before executing the BuildAction.
|
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.
|
addProgressListener, addProgressListener, addProgressListener, addProgressListener, setColorOutput, setEnvironmentVariables, setJavaHome, setJvmArguments, setJvmArguments, setStandardError, setStandardInput, setStandardOutput, withArguments, withArguments, withCancellationToken
@Incubating BuildActionExecuter<T> forTasks(String... tasks)
tasks
- The paths of the tasks to be executed. Relative paths are evaluated relative to the project for which this launcher was created.@Incubating BuildActionExecuter<T> forTasks(Iterable<String> tasks)
tasks
- The paths of the tasks to be executed. Relative paths are evaluated relative to the project for which this launcher was created.T run() throws GradleConnectionException, IllegalStateException
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.UnsupportedBuildArgumentException
- When there is a problem with build arguments provided by ConfigurableLauncher.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.void run(ResultHandler<? super T> handler) throws IllegalStateException
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.
handler
- The handler to supply the result to.IllegalStateException
- When the connection has been closed or is closing.