public abstract class GradleConnector extends Object
A GradleConnector is the main entry point to the Gradle tooling API. You use this API as follows:
newConnector() to create a new connector instance.forProjectDirectory(java.io.File) to specify which project you wish to connect to. Other methods are optional.connect() to create the connection to a project.ProjectConnection.close() to clean up.Example:
ProjectConnection connection = GradleConnector.newConnector()
.forProjectDirectory(new File("someProjectFolder"))
.connect();
try {
connection.newBuild().forTasks("tasks").run();
} finally {
connection.close();
}
The connection will use the version of Gradle that the target build is configured to use, for example in the Gradle wrapper properties file. When no Gradle version is defined for the build, the connection will use the tooling API's version as the Gradle version to run the build. Generally, you should avoid configuring a Gradle distribution or version and instead use the default provided by the tooling API.
Similarly, the connection will use the JVM and JVM arguments that the target build is configured to use, for example in the gradle.properties file. When no JVM or JVM arguments are defined for the build, the connection will use the current JVM and some default JVM arguments.
GradleConnector instances are not thread-safe. If you want to use a GradleConnector concurrently you must always create a
new instance for each thread using newConnector(). Note, however, the ProjectConnection instances that a connector creates are completely thread-safe.
The Tooling API is both forwards and backwards compatible with other versions of Gradle. It supports execution of Gradle builds that use older or newer versions of Gradle.
The current version of the Tooling API supports running builds using Gradle versions 1.2.
You should note that not all features of the Tooling API are available for all versions of Gradle. For example, build cancellation is only available for builds using Gradle 2.1 and later. Refer to the documentation for each class and method for more details.
The current Gradle version can be used from Tooling API versions 2.0 or later.
The Tooling API requires Java 8 or later. The Gradle version used by builds may have additional Java version requirements.
| Constructor | Description |
|---|---|
GradleConnector() |
| Modifier and Type | Method | Description |
|---|---|---|
abstract ProjectConnection |
connect() |
Creates a connection to the project in the specified project directory.
|
abstract GradleConnector |
forProjectDirectory(File projectDir) |
Specifies the working directory to use.
|
static CancellationTokenSource |
newCancellationTokenSource() |
Creates a new
CancellationTokenSource that can be used to cancel one or more LongRunningOperation executions. |
static GradleConnector |
newConnector() |
Creates a new connector instance.
|
abstract GradleConnector |
useBuildDistribution() |
Specifies to use the Gradle distribution defined by the target Gradle build.
|
abstract GradleConnector |
useDistribution(URI gradleDistribution) |
Specifies which Gradle distribution to use.
|
abstract GradleConnector |
useGradleUserHomeDir(File gradleUserHomeDir) |
Specifies the user's Gradle home directory to use.
|
abstract GradleConnector |
useGradleVersion(String gradleVersion) |
Specifies which Gradle version to use.
|
abstract GradleConnector |
useInstallation(File gradleHome) |
Specifies which Gradle installation to use.
|
public static GradleConnector newConnector()
public static CancellationTokenSource newCancellationTokenSource()
CancellationTokenSource that can be used to cancel one or more LongRunningOperation executions.null.public abstract GradleConnector useInstallation(File gradleHome)
useDistribution(URI), useGradleVersion(String), or useBuildDistribution().
Defaults to a project-specific Gradle version.gradleHome - The Gradle installation directory.public abstract GradleConnector useGradleVersion(String gradleVersion)
useInstallation(File), useDistribution(URI), or useBuildDistribution(). Defaults to a project-specific Gradle version.gradleVersion - The version to use.public abstract GradleConnector useDistribution(URI gradleDistribution)
useInstallation(File), useGradleVersion(String), or useBuildDistribution(). Defaults to a project-specific Gradle version.gradleDistribution - The distribution to use.public abstract GradleConnector useBuildDistribution()
useInstallation(File), useDistribution(URI), or useGradleVersion(String). Acts as the default behavior.public abstract GradleConnector forProjectDirectory(File projectDir)
projectDir - The working directory.public abstract GradleConnector useGradleUserHomeDir(File gradleUserHomeDir)
~/.gradle.gradleUserHomeDir - The user's Gradle home directory to use.public abstract ProjectConnection connect() throws GradleConnectionException
ProjectConnection.close() when you are finished with the connection.UnsupportedVersionException - When the target Gradle version does not support this version of the tooling API.GradleConnectionException - On failure to establish a connection with the target Gradle version.