bolts

Class TaskCompletionSource<TResult>

java.lang.Object

bolts.TaskCompletionSource<TResult>

Direct Known Subclasses:

Task.TaskCompletionSource

public class TaskCompletionSource<TResult>
extends java.lang.Object

Allows safe orchestration of a task's completion, preventing the consumer from prematurely completing the task. Essentially, it represents the producer side of a Task, providing access to the consumer side through the getTask() method while isolating the Task's completion mechanisms from the consumer.

Constructor Summary

Constructors

Constructor and Description
TaskCompletionSource() Creates a TaskCompletionSource that orchestrates a Task.

Method Summary

Methods

Modifier and Type	Method and Description
Task<TResult>	getTask()
void	setCancelled() Sets the cancelled flag on the task, throwing if the Task has already been completed.
void	setError(java.lang.Exception error) Sets the error of the Task, throwing if the Task has already been completed.
void	setResult(TResult result) Sets the result of the Task, throwing if the Task has already been completed.
boolean	trySetCancelled() Sets the cancelled flag on the Task if the Task hasn't already been completed.
boolean	trySetError(java.lang.Exception error) Sets the error on the Task if the Task hasn't already been completed.
boolean	trySetResult(TResult result) Sets the result on the Task if the Task hasn't already been completed.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskCompletionSource

public TaskCompletionSource()

Creates a TaskCompletionSource that orchestrates a Task. This allows the creator of a task to be solely responsible for its completion.

Method Detail

getTask

public Task<TResult> getTask()

Returns:

the Task associated with this TaskCompletionSource.

trySetCancelled

public boolean trySetCancelled()

Sets the cancelled flag on the Task if the Task hasn't already been completed.

trySetResult

public boolean trySetResult(TResult result)

Sets the result on the Task if the Task hasn't already been completed.

trySetError

public boolean trySetError(java.lang.Exception error)

Sets the error on the Task if the Task hasn't already been completed.

setCancelled

public void setCancelled()

Sets the cancelled flag on the task, throwing if the Task has already been completed.

setResult

public void setResult(TResult result)

Sets the result of the Task, throwing if the Task has already been completed.

setError

public void setError(java.lang.Exception error)

Sets the error of the Task, throwing if the Task has already been completed.