api / org.gradle.tooling / BuildActionExecuter / Builder

Builder

@Incubating interface Builder

Builder for a a build action that hooks into different phases of the build.

A single BuildAction is allowed per build phase. Use composite actions if needed.

Since
4.8

Functions

build

abstract fun build(): BuildActionExecuter<Void>

Builds the executer from the added actions.

buildFinished

abstract fun <T : Any> buildFinished(buildAction: BuildAction<T>, handler: IntermediateResultHandler<in T>): Builder

Executes the given action after tasks are run and sends its result to the given result handler.

If the operation fails, build will fail with the appropriate exception. Handler won't be notified in case of failure.

projectsLoaded

abstract fun <T : Any> projectsLoaded(buildAction: BuildAction<T>, handler: IntermediateResultHandler<in T>): Builder

Executes the given action after projects are loaded and sends its result to the given result handler.

Action will be executed after projects are loaded and Gradle will configure projects as necessary for the models requested.

If the operation fails, build will fail with the appropriate exception. Handler won't be notified in case of failure.