gradle/org.gradle.tooling/BuildActionExecuter

BuildActionExecuter

interface BuildActionExecuter<T> : ConfigurableLauncher<T> (source)

Used to execute a BuildAction in the build process.

Since

1.8

Parameters

<T>

The type of result produced by this executer.

Types

Builder

interface Builder

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

Functions

addArguments

abstract fun addArguments(p: Array<String>): T

abstract fun addArguments(p: Array<String>): LongRunningOperation

addJvmArguments

abstract fun addJvmArguments(p: Array<String>): T

abstract fun addJvmArguments(p: Array<String>): LongRunningOperation

addProgressListener

abstract fun addProgressListener(p: ProgressListener): T

abstract fun addProgressListener(p: ProgressListener): LongRunningOperation

forTasks

abstract fun forTasks(tasks: Iterable<String>): BuildActionExecuter<T>

abstract fun forTasks(tasks: Array<String>): BuildActionExecuter<T>

Specifies the tasks to execute before executing the BuildAction.

run

abstract fun run(): T

Runs the action, blocking until its result is available.

abstract fun run(handler: ResultHandler<in T>)

Starts executing the action, passing the result to the given handler when complete.

setColorOutput

abstract fun setColorOutput(p: Boolean): T

abstract fun setColorOutput(p: Boolean): LongRunningOperation

setEnvironmentVariables

abstract fun setEnvironmentVariables(p: Map<String, String>): T

abstract fun setEnvironmentVariables(p: Map<String, String>): LongRunningOperation

setJavaHome

abstract fun setJavaHome(p: File): T

abstract fun setJavaHome(p: File): LongRunningOperation

setJvmArguments

abstract fun setJvmArguments(p: Array<String>): T

abstract fun setJvmArguments(p: Array<String>): LongRunningOperation

setStandardError

abstract fun setStandardError(p: OutputStream): T

abstract fun setStandardError(p: OutputStream): LongRunningOperation

setStandardInput

abstract fun setStandardInput(p: InputStream): T

abstract fun setStandardInput(p: InputStream): LongRunningOperation

setStandardOutput

abstract fun setStandardOutput(p: OutputStream): T

abstract fun setStandardOutput(p: OutputStream): LongRunningOperation

setStreamedValueListener

@Incubating

abstract fun setStreamedValueListener(listener: StreamedValueListener)

Sets the listener to use to streamed values sent from the action via send.

withArguments

abstract fun withArguments(p: Array<String>): T

abstract fun withArguments(p: Array<String>): LongRunningOperation

withCancellationToken

abstract fun withCancellationToken(p: CancellationToken): T

abstract fun withCancellationToken(p: CancellationToken): LongRunningOperation

withSystemProperties

abstract fun withSystemProperties(p: Map<String, String>): T

abstract fun withSystemProperties(p: Map<String, String>): LongRunningOperation