org.gradle.tooling.internal.consumer

Class DefaultModelBuilder<T extends Model,P>

java.lang.Object

org.gradle.tooling.internal.consumer.DefaultModelBuilder<T,P>

All Implemented Interfaces:

LongRunningOperation, ModelBuilder<T>

public class DefaultModelBuilder<T extends Model,P>
extends Object
implements ModelBuilder<T>

Constructor Summary

Constructors

Constructor and Description
DefaultModelBuilder(Class<T> modelType, Class<P> protocolType, AsyncConnection connection, ProtocolToModelAdapter adapter, ConnectionParameters parameters)

Method Summary

Methods

Modifier and Type	Method and Description
DefaultModelBuilder<T,P>	addProgressListener(ProgressListener listener) Adds a progress listener which will receive progress events as the operation runs.
T	get() Fetch the model, blocking until it is available.
void	get(ResultHandler<? super T> handler) Starts fetching the build.
DefaultModelBuilder<T,P>	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.
DefaultModelBuilder<T,P>	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.
DefaultModelBuilder<T,P>	setStandardError(OutputStream outputStream) Sets the OutputStream which should receive standard error logging generated while running the operation.
DefaultModelBuilder<T,P>	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.
DefaultModelBuilder<T,P>	setStandardOutput(OutputStream outputStream) Sets the OutputStream which should receive standard output logging generated while running the operation.
DefaultModelBuilder<T,P>	withArguments(String... arguments) Specify the command line build arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultModelBuilder

public DefaultModelBuilder(Class<T> modelType,
                   Class<P> protocolType,
                   AsyncConnection connection,
                   ProtocolToModelAdapter adapter,
                   ConnectionParameters parameters)

Method Detail

get

public T get()
                    throws GradleConnectionException

Description copied from interface: ModelBuilder

Fetch the model, blocking until it is available.

Specified by:

get in interface ModelBuilder<T extends Model>

Returns:

The model.

Throws:

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: ModelBuilder.setStandardInput(java.io.InputStream), ModelBuilder.setJavaHome(java.io.File), ModelBuilder.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.

get

public void get(ResultHandler<? super T> handler)
         throws IllegalStateException

Description copied from interface: ModelBuilder

Starts fetching the build. This method returns immediately, and the result is later passed to the given handler.

Specified by:

get in interface ModelBuilder<T extends Model>

Parameters:

handler - The handler to supply the result to.

Throws:

IllegalStateException - When the connection has been closed or is closing.

withArguments

public DefaultModelBuilder<T,P> withArguments(String... arguments)

Description copied from interface: ModelBuilder

Specify the command line build arguments. Useful mostly for running tasks via 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 '-?', '-v') are not supported. Some other instructions like '--daemon' are also not supported - the tooling API always runs with the daemon.

If you specify unknown or unsupported command line option the UnsupportedBuildArgumentException will be thrown but only at the time when you execute the operation, i.e. BuildLauncher.run() or ModelBuilder.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. Supported arguments are those modelled by StartParameter.

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

Specified by:

withArguments in interface LongRunningOperation

Specified by:

withArguments in interface ModelBuilder<T extends Model>

Parameters:

arguments - gradle command line arguments

Returns:

this

setStandardOutput

public DefaultModelBuilder<T,P> setStandardOutput(OutputStream outputStream)

Description copied from interface: ModelBuilder

Sets the OutputStream which should receive standard output logging generated while running the operation. The default is to discard the output.

Specified by:

setStandardOutput in interface LongRunningOperation

Specified by:

setStandardOutput in interface ModelBuilder<T extends Model>

Parameters:

outputStream - The output stream.

Returns:

this

setStandardError

public DefaultModelBuilder<T,P> setStandardError(OutputStream outputStream)

Description copied from interface: ModelBuilder

Sets the OutputStream which should receive standard error logging generated while running the operation. The default is to discard the output.

Specified by:

setStandardError in interface LongRunningOperation

Specified by:

setStandardError in interface ModelBuilder<T extends Model>

Parameters:

outputStream - The output stream.

Returns:

this

setStandardInput

public DefaultModelBuilder<T,P> setStandardInput(InputStream inputStream)

Description copied from interface: ModelBuilder

If the target gradle version supports it you can use this setting to set the standard 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.

Specified by:

setStandardInput in interface LongRunningOperation

Specified by:

setStandardInput in interface ModelBuilder<T extends Model>

Parameters:

inputStream - The input stream

Returns:

this

setJavaHome

public DefaultModelBuilder<T,P> setJavaHome(File javaHome)

Description copied from interface: ModelBuilder

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.

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.

Specified by:

setJavaHome in interface LongRunningOperation

Specified by:

setJavaHome in interface ModelBuilder<T extends Model>

Parameters:

javaHome - to use for the gradle process

Returns:

this

setJvmArguments

public DefaultModelBuilder<T,P> setJvmArguments(String... jvmArguments)

Description copied from interface: ModelBuilder

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.

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.

Specified by:

setJvmArguments in interface LongRunningOperation

Specified by:

setJvmArguments in interface ModelBuilder<T extends Model>

Parameters:

jvmArguments - to use for the gradle process

Returns:

this

addProgressListener

public DefaultModelBuilder<T,P> addProgressListener(ProgressListener listener)

Description copied from interface: ModelBuilder

Adds a progress listener which will receive progress events as the operation runs.

Specified by:

addProgressListener in interface LongRunningOperation

Specified by:

addProgressListener in interface ModelBuilder<T extends Model>

Parameters:

listener - The listener

Returns:

this