org.gradle.tooling.internal.protocol

Interface ConnectionVersion4

All Known Subinterfaces:

InternalConnection

All Known Implementing Classes:

DefaultConnection

public interface ConnectionVersion4

Represents a connection to a particular Gradle implementation.

Implementations must be thread-safe.

Changes to this interface may break the cross-version protocol. If you change it, make sure you run the all tooling api tests to flush out compatibility issues.

Method Summary

Methods

Modifier and Type	Method and Description
void	executeBuild(BuildParametersVersion1 buildParameters, BuildOperationParametersVersion1 operationParameters) Executes a build.
ConnectionMetaDataVersion1	getMetaData() Returns the meta-data for this connection.
ProjectVersion3	getModel(Class<? extends ProjectVersion3> type, BuildOperationParametersVersion1 operationParameters) Deprecated.
void	stop() Stops this connection, blocking until complete.

Method Detail

stop

void stop()

Stops this connection, blocking until complete.

getMetaData

ConnectionMetaDataVersion1 getMetaData()

Returns the meta-data for this connection. The implementation of this method should be fast, and should continue to work after the connection has been stopped.

Returns:

The meta-data.

getModel

@Deprecated
ProjectVersion3 getModel(Class<? extends ProjectVersion3> type,
                                  BuildOperationParametersVersion1 operationParameters)
                         throws UnsupportedOperationException,
                                IllegalStateException

Deprecated.

Fetches a snapshot of the model for the project.

Deprecated, please use InternalConnection.getTheModel(Class, BuildOperationParametersVersion1)

Throws:

UnsupportedOperationException - When the given model type is not supported.

IllegalStateException - When this connection has been stopped.

executeBuild

void executeBuild(BuildParametersVersion1 buildParameters,
                BuildOperationParametersVersion1 operationParameters)
                  throws IllegalStateException

Executes a build.

Parameters:

buildParameters - The parameters for the build.

Throws:

IllegalStateException - When this connection has been stopped.