Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | METHOD DETAIL: FIELD | METHOD

org.gradle.tooling
[Java] Interface BuildController

@Incubating
public interface BuildController

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

Since:
1.8

Method Summary
Object findModel(Class modelType)

Fetches a snapshot of the model of the given type, if available.
Object findModel(Model target, Class 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.

Object getModel(Class modelType)

Fetches a snapshot of the model of the given type for the default project.

Object getModel(Model target, Class modelType)

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

Method Detail

findModel

@Nullable
public Object findModel(Class modelType)
Fetches a snapshot of the model of the given type, if available.

See getModel(Class) for more details.

Parameters:
modelType - The model type.
- The model type.
Returns:
The model, or null if not present.

findModel

@Nullable
public Object findModel(Model target, Class modelType)
Fetches a snapshot of the model of the given type, if available.

See getModel(Model, Class) for more details.

Parameters:
modelType - The model type.
- The model type.
Returns:
The model, or null if not present.

getBuildModel

public 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).
Returns:
The model.

getModel

public Object getModel(Class modelType)
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:

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

throws:
UnknownModelException When the default project does not support the requested model.
Parameters:
modelType - The model type.
- The model type.
Returns:
The model.
Since:
1.8

getModel

public Object getModel(Model target, Class modelType)
Fetches a snapshot of the model of the given type for the given element, usually a Gradle project.

The following elements are supported:

See getModel(Class) for more details.

throws:
UnknownModelException When the target project does not support the requested model.
Parameters:
target - The target element, usually a project.
modelType - The model type.
- The model type.
Returns:
The model.

 

Gradle API 1.12