T - The type of model to buildpublic interface ModelBuilder<T extends Model> extends LongRunningOperation
ModelBuilder allows you to fetch a snapshot of the model for a project.
Instances of ModelBuilder are not thread-safe.
You use a ModelBuilder as follows:
ModelBuilder by calling ProjectConnection.model(Class).
get() or get(ResultHandler) to build the model.
ProjectConnection connection = GradleConnector.newConnector()
.forProjectDirectory(new File("someFolder"))
.connect();
try {
ModelBuilder<GradleProject> builder = connection.model(GradleProject.class);
//if you use a different than usual build file name:
builder.withArguments("--build-file", "theBuild.gradle");
//configure the standard input in case your build is interactive:
builder.setStandardInput(new ByteArrayInputStream("consume this!".getBytes()));
//if you want to listen to the progress events:
ProgressListener listener = null; // use your implementation
builder.addProgressListener(listener);
//get the model:
GradleProject project = builder.get();
//query the model for information:
System.out.println("Available tasks: " + project.getTasks());
} finally {
connection.close();
}
| Modifier and Type | Method and Description |
|---|---|
ModelBuilder<T> |
addProgressListener(ProgressListener listener)
Adds a progress listener which will receive progress events as the operation runs.
|
ModelBuilder<T> |
forTasks(String... tasks)
Specifies the tasks to execute before building the model.
|
T |
get()
Fetch the model, blocking until it is available.
|
void |
get(ResultHandler<? super T> handler)
Starts fetching the build.
|
ModelBuilder<T> |
setJavaHome(File javaHome)
If the target Gradle version supports it you can use this setting
to specify the Java home directory to use for the long running operation.
|
ModelBuilder<T> |
setJvmArguments(String... jvmArguments)
If the target Gradle version supports it you can use this setting
to specify the Java vm arguments to use for the long running operation.
|
ModelBuilder<T> |
setStandardError(OutputStream outputStream)
Sets the
OutputStream which should receive standard error logging generated while running the operation. |
ModelBuilder<T> |
setStandardInput(InputStream inputStream)
If the target Gradle version supports it you can use this setting
to set the standard
InputStream that will be used by builds. |
ModelBuilder<T> |
setStandardOutput(OutputStream outputStream)
Sets the
OutputStream which should receive standard output logging generated while running the operation. |
ModelBuilder<T> |
withArguments(String... arguments)
Specify the command line build arguments.
|
ModelBuilder<T> withArguments(String... arguments)
BuildLauncher.
Be aware that not all of the Gradle command line options are supported!
Only the build arguments that configure the build execution are supported.
They are modelled in the Gradle API via StartParameter.
Examples of supported build arguments: '--info', '-u', '-p'.
The command line instructions that are actually separate commands (like '-?' and '-v') are not supported.
Some other instructions like '--daemon' are also not supported - the tooling API always runs with the daemon.
If an unknown or unsupported command line option is specified, UnsupportedBuildArgumentException
will be thrown at the time the operation is executed via BuildLauncher.run() or get().
For the list of all Gradle command line options please refer to the user guide
or take a look at the output of the 'gradle -?' command. Majority of arguments modeled by
StartParameter are supported.
The arguments can potentially override some other settings you have configured.
For example, the project directory or Gradle user home directory that are configured
in the GradleConnector.
Also, the task names configured by BuildLauncher.forTasks(String...) can be overridden
if you happen to specify other tasks via the build arguments.
See the example in the docs for BuildLauncher
withArguments in interface LongRunningOperationarguments - Gradle command line argumentsModelBuilder<T> setStandardOutput(OutputStream outputStream)
OutputStream which should receive standard output logging generated while running the operation.
The default is to discard the output.setStandardOutput in interface LongRunningOperationoutputStream - The output stream.ModelBuilder<T> setStandardError(OutputStream outputStream)
OutputStream which should receive standard error logging generated while running the operation.
The default is to discard the output.setStandardError in interface LongRunningOperationoutputStream - The output stream.ModelBuilder<T> setStandardInput(InputStream inputStream)
InputStream that will be used by builds.
Useful when the tooling api drives interactive builds.
If the target Gradle version does not support it the long running operation will fail eagerly with
UnsupportedOperationConfigurationException when the operation is started.
If not configured or null passed the dummy input stream with zero bytes is used to avoid the build hanging problems.
setStandardInput in interface LongRunningOperationinputStream - The input streamModelBuilder<T> setJavaHome(File javaHome)
If the target Gradle version does not support it the long running operation will fail eagerly with
UnsupportedOperationConfigurationException when the operation is started.
BuildEnvironment model contains information such as Java or Gradle environment.
If you want to get hold of this information you can ask tooling API to build this model.
If not configured or null passed the sensible default will be used.
setJavaHome in interface LongRunningOperationjavaHome - to use for the Gradle processModelBuilder<T> setJvmArguments(String... jvmArguments)
If the target Gradle version does not support it the long running operation will fail eagerly with
UnsupportedOperationConfigurationException when the operation is started.
BuildEnvironment model contains information such as Java or Gradle environment.
If you want to get hold of this information you can ask tooling API to build this model.
If not configured, null an empty array passed then the reasonable default will be used.
setJvmArguments in interface LongRunningOperationjvmArguments - to use for the Gradle processModelBuilder<T> addProgressListener(ProgressListener listener)
addProgressListener in interface LongRunningOperationlistener - The listener@Incubating ModelBuilder<T> forTasks(String... tasks)
tasks - The paths of the tasks to be executed. Relative paths are evaluated relative to the project for which this launcher was created.T get() throws GradleConnectionException
UnsupportedVersionException - When the target Gradle version does not support the features required to build this model.UnsupportedOperationConfigurationException - when you have configured the long running operation with a settings
like: setStandardInput(java.io.InputStream), setJavaHome(java.io.File),
setJvmArguments(String...) but those settings are not supported on the target Gradle.BuildException - On some failure executing the Gradle build.GradleConnectionException - On some other failure using the connection.IllegalStateException - When the connection has been closed or is closing.void get(ResultHandler<? super T> handler) throws IllegalStateException
handler - The handler to supply the result to.IllegalStateException - When the connection has been closed or is closing.