Represents a long-lived connection to a Gradle project. You obtain an instance of a ProjectConnection by using GradleConnector.connect.
ProjectConnection connection = GradleConnector.newConnector()
.forProjectDirectory(new File("someFolder"))
.connect();
try {
//obtain some information from the build
BuildEnvironment environment = connection.model(BuildEnvironment.class)
.get();
//run some tasks
connection.newBuild()
.forTasks("tasks")
.setStandardOutput(System.out)
.run();
} finally {
connection.close();
}
All implementations of ProjectConnection are thread-safe, and may be shared by any number of threads.
All notifications from a given ProjectConnection instance are delivered by a single thread at a time. Note, however, that the delivery thread may change over time.
| Type | Name and description |
|---|---|
BuildActionExecuter<T> |
action(BuildAction<T> buildAction)Creates an executer which can be used to run the given action. |
void |
close()Closes this connection. |
T |
getModel(Class<T> modelType)Fetches a snapshot of the model of the given type for this project. |
void |
getModel(Class<T> modelType, ResultHandler<? super T> handler)Starts fetching a snapshot of the given model, passing the result to the given handler when complete. |
ModelBuilder<T> |
model(Class<T> modelType)Creates a builder which can be used to query the model of the given type. |
BuildLauncher |
newBuild()Creates a launcher which can be used to execute a build. |
Creates an executer which can be used to run the given action. The action is serialized into the build process and executed, then its result is serialized back to the caller.
buildAction - The action to run.Closes this connection. Blocks until any pending operations are complete. Once this method has returned, no more notifications will be delivered by any threads.
Fetches a snapshot of the model of the given type for this project. This method blocks until the model is available.
This method is simply a convenience for calling model(modelType).get()
modelType - The model type.Starts fetching a snapshot of the given model, passing the result to the given handler when complete. This method returns immediately, and the result is later passed to the given handler's ResultHandler#onComplete(Object)#onComplete(Object) method.
If the operation fails, the handler's ResultHandler#onFailure(GradleConnectionException)#onFailure(GradleConnectionException) method is called with the appropriate exception. See getModel(Class) for a description of the various exceptions that the operation may fail with.
This method is simply a convenience for calling model(modelType).get(handler)
modelType - The model type.handler - The handler to pass the result to.Creates a builder which can be used to query the model of the given type.
Any of following models types may be available, depending on the version of Gradle being used by the target build:
A build may also expose additional custom tooling models. You can use this method to query these models.
modelType - The model typeCreates a launcher which can be used to execute a build.