net.uncontended.precipice.concurrent

Interface PrecipiceFuture<Result extends Failable,V>

Type Parameters:

Result - the type of the result for this future

V - the type of the value for this future

All Superinterfaces:

java.util.concurrent.Future<V>, ResultView<Result,V>

All Known Implementing Classes:

Eventual

public interface PrecipiceFuture<Result extends Failable,V>
extends java.util.concurrent.Future<V>, ResultView<Result,V>

A context containing the result of an asynchronous computation.

Method Summary

Modifier and Type	Method and Description
void	await() Block until the completion of the future.
void	await(long duration, java.util.concurrent.TimeUnit unit) Block until the completion of the future or until the time duration is exceeded.
void	onError(PrecipiceFunction<Result,java.lang.Throwable> fn) Attaches a callback to be executed if the future is not completed successfully.
void	onSuccess(PrecipiceFunction<Result,V> fn) Attaches a callback to be executed if the future is completed successfully.

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Methods inherited from interface net.uncontended.precipice.ResultView

getError, getResult, getValue

Method Detail

onSuccess

void onSuccess(PrecipiceFunction<Result,V> fn)

Attaches a callback to be executed if the future is completed successfully. The function will be passed the result of the future and the value.

This method only is guaranteed to be safe if it is called once. Specific implementations may provide stronger guarantees.

Parameters:

fn - function to be executed

onError

void onError(PrecipiceFunction<Result,java.lang.Throwable> fn)

Attaches a callback to be executed if the future is not completed successfully. The function will be passed the result of the future and any exception that occurred during execution.

This method only is guaranteed to be safe if it is called once. Specific implementations may provide stronger guarantees.

Parameters:

fn - function to be executed

await

void await()
    throws java.lang.InterruptedException

Block until the completion of the future.

Throws:

java.lang.InterruptedException

await

void await(long duration,
           java.util.concurrent.TimeUnit unit)
    throws java.lang.InterruptedException

Block until the completion of the future or until the time duration is exceeded.

Parameters:

duration - the maximum duration to wait

unit - the unit of the duration argument

Throws:

java.lang.InterruptedException