CancellationTokenSource (Gradle API 2.9)
Date: 2015-11-17

Package: org.gradle.tooling

## [Java] Interface CancellationTokenSource

- A `CancellationTokenSource` allows you to issue cancellation requests to one or more LongRunningOperation instances. To use a token source:

  - Create a token source using GradleConnector.newCancellationTokenSource.
  - Attach the token to one or more operations using LongRunningOperation.withCancellationToken. You need to do this before you start the operation.
  - Later, you can cancel the associated operations by calling cancel() on this token source.

  All implementations of this interface are required to be thread safe.

  Since:
    2.1

- - ### Methods Summary

    Methods
    Type | Name and description
    --- | ---
    `void` | `cancel()` Initiates cancel request.
    `CancellationToken` | `token()` Returns a token associated with this `CancellationTokenSource`.

- - ### Method Detail

    - #### public void cancel()

      Initiates cancel request. All operations that have been associated with this token will be cancelled.

      It is assumed that the implementation will do 'best-effort' attempt to perform cancellation. This method returns immediately and if the cancellation is successful the cancelled operation will notify its ResultHandler.onFailure with a BuildCancelledException describing how it was cancelled.

    - #### public CancellationToken token()

      Returns a token associated with this `CancellationTokenSource`. Always returns the same instance.

      Returns:
        The cancellation token.