CancellationTokenSource 16.0.0 API - Android SDK Reference

Android SDK Version

16.0.0

All Implemented Interfaces:

java.io.Closeable , java.lang.AutoCloseable


public final class CancellationTokenSource
 implements Closeable

Signals to a CancellationToken that it should be canceled. To create a CancellationToken first create a CancellationTokenSource then use token to retrieve the token for the source.

Field Summary

Modifier and Type	Field	Description
`private final Boolean`	`isCancellationRequested`
`private final CancellationToken`	`token`

Constructor Summary

Constructor	Description
`CancellationTokenSource()`

Method Summary

Modifier and Type	Method	Description
`final Boolean`	`getIsCancellationRequested()`
`final CancellationToken`	`getToken()`
`final Unit`	`cancel()`	Cancels the token if it has not already been cancelled.
`final Unit`	`cancelAfter(Long delay)`	Schedules a cancel operation on this `CancellationTokenSource` after the specified number of milliseconds.
`Unit`	`close()`
`String`	`toString()`

Methods inherited from class java.lang.Object

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

Constructor Detail

CancellationTokenSource

CancellationTokenSource()

Method Detail

getIsCancellationRequested

 final BooleangetIsCancellationRequested()

getToken

 final CancellationTokengetToken()

cancel

 final Unitcancel()

Cancels the token if it has not already been cancelled.

cancelAfter

 final UnitcancelAfter(Long delay)

Schedules a cancel operation on this CancellationTokenSource after the specified number of milliseconds.

Parameters:

delay - The number of milliseconds to wait before completing the returned task.

close

Unitclose()

toString

StringtoString()