org.gradle.tooling

インタフェース BuildController

@Incubating
public interface BuildController

Provides a BuildAction various ways to control a Gradle build and access information about the build.

導入されたバージョン:

1.8

メソッドの概要

修飾子とタイプ	メソッドと説明
<T> T	findModel(Class<T> modelType) Fetches a snapshot of the model of the given type, if available.
<T> T	findModel(Model target, Class<T> modelType) Fetches a snapshot of the model of the given type, if available.
GradleBuild	getBuildModel() Returns an overview of the Gradle build, including some basic details of the projects that make up the build.
<T> T	getModel(Class<T> modelType) Fetches a snapshot of the model of the given type for the default project.
<T> T	getModel(Model target, Class<T> modelType) Fetches a snapshot of the model of the given type for the given element, usually a Gradle project.

メソッドの詳細

getModel

<T> T getModel(Class<T> modelType)
        throws UnknownModelException

Fetches a snapshot of the model of the given type for the default project. The default project is generally the project referenced when a ProjectConnection is created.

Any of following models types may be available, depending on the version of Gradle being used by the target build:

• GradleBuild
• BuildEnvironment
• GradleProject
• BuildInvocations
• ProjectPublications
• IdeaProject
• BasicIdeaProject
• EclipseProject
• HierarchicalEclipseProject

A build may also expose additional custom tooling models. You can use this method to query these models.

型パラメータ:

T - The model type.

パラメータ:

modelType - The model type.

戻り値:

The model.

例外:

UnknownModelException - When the default project does not support the requested model.

導入されたバージョン:

1.8

findModel

@Nullable
<T> T findModel(Class<T> modelType)

Fetches a snapshot of the model of the given type, if available.

See getModel(Class) for more details.

型パラメータ:

T - The model type.

パラメータ:

modelType - The model type.

戻り値:

The model, or null if not present.

getBuildModel

GradleBuild getBuildModel()

Returns an overview of the Gradle build, including some basic details of the projects that make up the build. This is equivalent to calling #getModel(GradleBuild.class).

戻り値:

The model.

getModel

<T> T getModel(Model target,
               Class<T> modelType)
        throws UnknownModelException

Fetches a snapshot of the model of the given type for the given element, usually a Gradle project.

The following elements are supported:

• Any BasicGradleProject
• Any GradleProject
• Any EclipseProject
• Any IdeaModule

See getModel(Class) for more details.

型パラメータ:

T - The model type.

パラメータ:

target - The target element, usually a project.

modelType - The model type.

戻り値:

The model.

例外:

UnknownModelException - When the target project does not support the requested model.

findModel

@Nullable
<T> T findModel(Model target,
                          Class<T> modelType)

Fetches a snapshot of the model of the given type, if available.

See getModel(Model, Class) for more details.

型パラメータ:

T - The model type.

パラメータ:

modelType - The model type.

戻り値:

The model, or null if not present.