net.uncontended.precipice

Interface Completable<Result extends Failable,V>

Type Parameters:

Result - the type of the result for this promise

V - the type of the value for this completable

All Known Subinterfaces:

PrecipicePromise<Result,V>

All Known Implementing Classes:

CompletionContext, Eventual

public interface Completable<Result extends Failable,V>

A context that can be completed with the result of a computation. The context can only be completed once. This holds true for both an successes and exceptions. So if it is completed with an exception, it cannot be completed successfully.

Method Summary

Modifier and Type	Method and Description
boolean	complete(Result result, V value) Completes this context successfully with the result.
boolean	completeExceptionally(Result result, java.lang.Throwable exception) Completes this context with an exception.
ResultView<Result,V>	resultView() Returns a view of the result of of this completable.

Method Detail

complete

boolean complete(Result result,
                 V value)

Completes this context successfully with the result. A boolean will be returned indicating if it was completed successfully.

Parameters:

result - of the computation

value - of the computation

Returns:

if the context was competed successfully

completeExceptionally

boolean completeExceptionally(Result result,
                              java.lang.Throwable exception)

Completes this context with an exception. A boolean will be returned indicating if it was completed successfully.

Parameters:

result - of the computation

exception - of the computation

Returns:

if the context was competed successfully

resultView

ResultView<Result,V> resultView()

Returns a view of the result of of this completable.

Returns:

the result view