Interface InternalCancellableConnection
-
- All Superinterfaces:
InternalProtocolInterface
public interface InternalCancellableConnection extends InternalProtocolInterface
Mixed into a provider connection, to allow tooling models to be requested by the client and to run client-provided actions (including builds) with cancellation support.DO NOT CHANGE THIS INTERFACE - it is part of the cross-version protocol.
Consumer compatibility: This interface is used by all consumer versions from 2.1-rc-1.
Provider compatibility: This interface is implemented by all provider versions from 2.1-rc-1. Methods have different version compatibilities.
- Since:
- 2.1-rc-1
- See Also:
InternalParameterAcceptingConnection
,ConnectionVersion4
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description BuildResult<?>
getModel(ModelIdentifier modelIdentifier, InternalCancellationToken cancellationToken, BuildParameters operationParameters)
Performs some action against a build and returns the requested model.<T> BuildResult<T>
run(InternalBuildAction<T> action, InternalCancellationToken cancellationToken, BuildParameters operationParameters)
Deprecated.4.4.
-
-
-
Method Detail
-
getModel
BuildResult<?> getModel(ModelIdentifier modelIdentifier, InternalCancellationToken cancellationToken, BuildParameters operationParameters) throws BuildExceptionVersion1, InternalUnsupportedModelException, InternalUnsupportedBuildArgumentException, InternalBuildCancelledException, java.lang.IllegalStateException
Performs some action against a build and returns the requested model.Consumer compatibility: This method is used by all consumer versions from 2.1-rc-1.
Provider compatibility: This method is implemented by all provider versions from 2.1-rc-1.
- Parameters:
modelIdentifier
- The identifier of the model to build.cancellationToken
- The token to propagate cancellation.- Throws:
BuildExceptionVersion1
- On build failure.InternalUnsupportedModelException
- When the requested model is not supported.InternalUnsupportedBuildArgumentException
- When the specified command-line options are not supported.InternalBuildCancelledException
- When the operation was cancelled before it could complete.java.lang.IllegalStateException
- When this connection has been stopped.- Since:
- 2.1-rc-1
-
run
@Deprecated <T> BuildResult<T> run(InternalBuildAction<T> action, InternalCancellationToken cancellationToken, BuildParameters operationParameters) throws BuildExceptionVersion1, InternalUnsupportedBuildArgumentException, InternalBuildActionFailureException, InternalBuildCancelledException, java.lang.IllegalStateException
Deprecated.Performs some action against a build and returns the result.Consumer compatibility: This method is used by all consumer versions from 2.1-rc-1 to 4.3. It is also used by later consumers when the provider does not implement newer interfaces.
Provider compatibility: This method is implemented by all provider versions from 2.1-rc-1.
- Throws:
BuildExceptionVersion1
- On build failure.InternalUnsupportedBuildArgumentException
- When the specified command-line options are not supported.InternalBuildActionFailureException
- When the action fails with an exception.InternalBuildCancelledException
- When the operation was cancelled before it could complete.java.lang.IllegalStateException
- When this connection has been stopped.- Since:
- 2.1-rc-1
-
-