org.gradle.tooling.internal.consumer

Class DefaultGradleConnector

java.lang.Object

org.gradle.tooling.GradleConnector

org.gradle.tooling.internal.consumer.DefaultGradleConnector

public class DefaultGradleConnector
extends GradleConnector

Constructor Summary

Constructors

Constructor and Description
DefaultGradleConnector(ConnectionFactory connectionFactory, DistributionFactory distributionFactory)

Method Summary

Methods

Modifier and Type	Method and Description
ProjectConnection	connect() Creates a connection to the project in the specified project directory.
GradleConnector	daemonMaxIdleTime(int timeoutValue, TimeUnit timeoutUnits)
GradleConnector	embedded(boolean embedded)
GradleConnector	forProjectDirectory(File projectDir) Specifies the working directory to use.
GradleConnector	searchUpwards(boolean searchUpwards)
DefaultGradleConnector	setVerboseLogging(boolean verboseLogging) If true then debug log statements will be shown
GradleConnector	useClasspathDistribution()
GradleConnector	useDefaultDistribution()
GradleConnector	useDistribution(URI gradleDistribution) Specifies which Gradle distribution to use.
GradleConnector	useGradleUserHomeDir(File gradleUserHomeDir) Specifies the user's Gradle home directory to use.
GradleConnector	useGradleVersion(String gradleVersion) Specifies which Gradle version to use.
GradleConnector	useInstallation(File gradleHome) Specifies which Gradle installation to use.

Methods inherited from class org.gradle.tooling.GradleConnector

newConnector

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultGradleConnector

public DefaultGradleConnector(ConnectionFactory connectionFactory,
                      DistributionFactory distributionFactory)

Method Detail

useInstallation

public GradleConnector useInstallation(File gradleHome)

Description copied from class: GradleConnector

Specifies which Gradle installation to use. This replaces any value specified using GradleConnector.useDistribution(java.net.URI) or GradleConnector.useGradleVersion(String). Defaults to a project-specific Gradle version.

Specified by:

useInstallation in class GradleConnector

Parameters:

gradleHome - The Gradle installation directory.

Returns:

this

useGradleVersion

public GradleConnector useGradleVersion(String gradleVersion)

Description copied from class: GradleConnector

Specifies which Gradle version to use. The appropriate distribution is downloaded and installed into the user's Gradle home directory. This replaces any value specified using GradleConnector.useInstallation(java.io.File) or GradleConnector.useDistribution(java.net.URI). Defaults to a project-specific Gradle version.

Specified by:

useGradleVersion in class GradleConnector

Parameters:

gradleVersion - The version to use.

Returns:

this

useDistribution

public GradleConnector useDistribution(URI gradleDistribution)

Description copied from class: GradleConnector

Specifies which Gradle distribution to use. The appropriate distribution is downloaded and installed into the user's Gradle home directory. This replaces any value specified using GradleConnector.useInstallation(java.io.File) or GradleConnector.useGradleVersion(String). Defaults to a project-specific Gradle version.

Specified by:

useDistribution in class GradleConnector

Parameters:

gradleDistribution - The distribution to use.

Returns:

this

useClasspathDistribution

public GradleConnector useClasspathDistribution()

useDefaultDistribution

public GradleConnector useDefaultDistribution()

forProjectDirectory

public GradleConnector forProjectDirectory(File projectDir)

Description copied from class: GradleConnector

Specifies the working directory to use.

Specified by:

forProjectDirectory in class GradleConnector

Parameters:

projectDir - The working directory.

Returns:

this

useGradleUserHomeDir

public GradleConnector useGradleUserHomeDir(File gradleUserHomeDir)

Description copied from class: GradleConnector

Specifies the user's Gradle home directory to use. Defaults to ~/.gradle.

Specified by:

useGradleUserHomeDir in class GradleConnector

Parameters:

gradleUserHomeDir - The user's Gradle home directory to use.

Returns:

this

searchUpwards

public GradleConnector searchUpwards(boolean searchUpwards)

embedded

public GradleConnector embedded(boolean embedded)

daemonMaxIdleTime

public GradleConnector daemonMaxIdleTime(int timeoutValue,
                                TimeUnit timeoutUnits)

setVerboseLogging

public DefaultGradleConnector setVerboseLogging(boolean verboseLogging)

If true then debug log statements will be shown

Parameters:

verboseLogging -

Returns:

connect

public ProjectConnection connect()
                          throws GradleConnectionException

Description copied from class: GradleConnector

Creates a connection to the project in the specified project directory. You should call ProjectConnection.close() when you are finished with the connection.

Specified by:

connect in class GradleConnector

Returns:

The connection. Never return null.

Throws:

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.