gradle/org.gradle.tooling/ConfigurableLauncher

ConfigurableLauncher

interface ConfigurableLauncher<T : ConfigurableLauncher<T>?> : LongRunningOperation(source)

A ConfigurableLauncher allows you to configure a long running operation.

Since

2.6

Parameters

<T>

the ConfigurableLauncher implementation to return as part of the fluent API.

Inheritors

BuildActionExecuter

Functions

abstract fun addArguments(arguments: Iterable<String>): T

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

Appends new command line arguments to the existing list.

addJvmArguments

abstract fun addJvmArguments(jvmArguments: Iterable<String>): T

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

Appends Java VM arguments to the existing list.

addProgressListener

abstract fun addProgressListener(listener: ProgressListener): T

Adds a progress listener which will receive progress events as the operation runs.

abstract fun addProgressListener(listener: ProgressListener): T

Adds a progress listener which will receive progress events of all types as the operation runs.

abstract fun addProgressListener(listener: ProgressListener, eventTypes: Set<OperationType>): T

abstract fun addProgressListener(listener: ProgressListener, operationTypes: Array<OperationType>): T

Adds a progress listener which will receive progress events as the operations of the requested type run.

abstract fun setColorOutput(colorOutput: Boolean): T

Specifies whether to generate colored (ANSI encoded) output for logging.

setEnvironmentVariables

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

Specifies the environment variables to use for this operation.

abstract fun setJavaHome(javaHome: File): T

Specifies the Java home directory to use for this operation.

setJvmArguments

abstract fun setJvmArguments(jvmArguments: Iterable<String>): T

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

Specifies the Java VM arguments to use for this operation.

setStandardError

abstract fun setStandardError(outputStream: OutputStream): T

Sets the which should receive standard error logging generated while running the operation.

setStandardInput

abstract fun setStandardInput(inputStream: InputStream): T

Sets the that will be used as standard input for this operation.

setStandardOutput

abstract fun setStandardOutput(outputStream: OutputStream): T

Sets the which should receive standard output logging generated while running the operation.

abstract fun withArguments(arguments: Iterable<String>): T

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

Specify the command line build arguments.

withCancellationToken

abstract fun withCancellationToken(cancellationToken: CancellationToken): T

Sets the cancellation token to use to cancel the operation if required.

withDetailedFailure

abstract fun withDetailedFailure(): T

Adds more detailed information about the build failure to the that provides insights into the reasons for the failure, making it easier to diagnose and fix issues.

withSystemProperties

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

Sets system properties to pass to the build.