se.tedro.concurrent

Interface Completable<T>

Type Parameters:

T - type of the value being completed

All Superinterfaces:

Stage<T>

public interface Completable<T>
extends Stage<T>

A value that can be completed at a later point in time. In general this follows the contract of Stage, but extends to to allow for the completion of the underlying computation.

See Also:

Stage

Field Summary

Fields inherited from interface se.tedro.concurrent.Stage

CANCELLED, COMPLETED, FAILED, PENDING

Method Summary

Modifier and Type	Method and Description
boolean	complete(T result) Complete the current stage.
boolean	fail(Throwable cause) Fail the current stage.

Methods inherited from interface se.tedro.concurrent.Stage

cancel, cause, handle, isCancelled, isCompleted, isDone, isFailed, join, join, joinNow, thenApply, thenApplyFailed, thenCancel, thenComplete, thenCompose, thenComposeCaught, thenFail, whenCancelled, whenComplete, whenDone, whenFailed, withCloser, withComplete, withNotComplete

Method Detail

complete

boolean complete(T result)

Complete the current stage.

This takes the stage out of the pending state and into the completed state.

Parameters:

result - result of the computation

Returns:

true if the completable was completed by this call

fail

boolean fail(Throwable cause)

Fail the current stage.

This takes the stage out of the pending state and into the cancelled state.

Parameters:

cause - the cause of the failure

Returns:

true if the completable was completed by this call