Build Launcher
A BuildLauncher allows you to configure and execute a Gradle build.
Instances of BuildLauncher are not thread-safe. You use a BuildLauncher as follows:
- Create an instance of
BuildLauncherby calling newBuild. - Configure the launcher as appropriate.
- Call either run or run to execute the build.
- Optionally, you can reuse the launcher to launch additional builds.
ProjectConnection connection = GradleConnector.newConnector()
.forProjectDirectory(new File("some-folder"))
.connect();
try {
BuildLauncher build = connection.newBuild();
//select tasks to run:
build.forTasks("clean", "test");
//include some build arguments:
build.withArguments("-i", "--project-dir", "some-project-dir");
//configure the standard input:
build.setStandardInput(new ByteArrayInputStream("consume this!".getBytes()));
//in case you want the build to use java different than default:
build.setJavaHome(new File("/path/to/java"));
//if your build needs crazy amounts of memory:
build.setJvmArguments("-Xmx2048m", "-XX:MaxPermSize=512m");
//if you want to listen to the progress events:
ProgressListener listener = null; // use your implementation
build.addProgressListener(listener);
//kick the build off:
build.run();
} finally {
connection.close();
}
Content copied to clipboard
If the target Gradle version is >=6.8 then you can use BuildLauncher to execute tasks from included builds. You can target tasks from included builds by specifying the task identity path (i.e. ':included-build-name:subproject-name:taskName').
Since
1.0-milestone-3
Functions
Link copied to clipboard
Appends new command line arguments to the existing list.
Link copied to clipboard
Appends Java VM arguments to the existing list.
Link copied to clipboard
Adds a progress listener which will receive progress events as the operation runs.
Adds a progress listener which will receive progress events of all types as the operation runs.
abstract fun addProgressListener(listener: ProgressListener, operationTypes: Array<OperationType>): T
abstract fun addProgressListener(listener: ProgressListener, operationTypes: Set<OperationType>): LongRunningOperation
abstract fun addProgressListener(listener: ProgressListener, operationTypes: Array<OperationType>): LongRunningOperation
Adds a progress listener which will receive progress events as the operations of the requested type run.
Link copied to clipboard
Sets the launchables to execute.
Link copied to clipboard
Sets the tasks to be executed.
Link copied to clipboard
Executes the build, blocking until it is complete.
Launches the build.
Link copied to clipboard
Specifies whether to generate colored (ANSI encoded) output for logging.
Link copied to clipboard
abstract fun setEnvironmentVariables(@Nullable envVariables: @Nullable Map<String, String>): LongRunningOperation
Specifies the environment variables to use for this operation.
Link copied to clipboard
Specifies the Java home directory to use for this operation.
Link copied to clipboard
abstract fun setJvmArguments(@Nullable jvmArguments: @Nullable Iterable<String>): LongRunningOperation
Specifies the Java VM arguments to use for this operation.
Link copied to clipboard
Sets the which should receive standard error logging generated while running the operation.
Sets the OutputStream which should receive standard error logging generated while running the operation.
Link copied to clipboard
Sets the that will be used as standard input for this operation.
Sets the java.io.InputStream that will be used as standard input for this operation.
Link copied to clipboard
Sets the which should receive standard output logging generated while running the operation.
Sets the java.io.OutputStream which should receive standard output logging generated while running the operation.
Link copied to clipboard
Specify the command line build arguments.
Link copied to clipboard
Sets the cancellation token to use to cancel the operation if required.
Link copied to clipboard
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.
Adds more detailed information about the build failure to the GradleConnectionException that provides insights into the reasons for the failure, making it easier to diagnose and fix issues.
Link copied to clipboard
Sets system properties to pass to the build.