net.uncontended.precipice.concurrent

Class Eventual<Result extends Failable,V>

java.lang.Object

net.uncontended.precipice.concurrent.Eventual<Result,V>

All Implemented Interfaces:

java.util.concurrent.Future<V>, Completable<Result,V>, PrecipiceFuture<Result,V>, PrecipicePromise<Result,V>, ExecutionContext, ResultView<Result,V>

public class Eventual<Result extends Failable,V>
extends java.lang.Object
implements PrecipiceFuture<Result,V>, PrecipicePromise<Result,V>, ExecutionContext

Constructor Summary

Constructors

Constructor and Description
Eventual()
Eventual(Completable<Result,V> completable)
Eventual(long permitCount)
Eventual(long permitCount, long startNanos)
Eventual(long permitCount, long startNanos, Completable<Result,V> completable)

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.
boolean	cancel(boolean mayInterruptIfRunning)
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.
PrecipiceFuture<Result,V>	future() Returns a future containing the result of this promise
V	get()
V	get(long timeout, java.util.concurrent.TimeUnit unit)
java.lang.Throwable	getError() Return the exception that might have occurred during a failed execution.
Result	getResult() Return the result of the execution.
V	getValue() Return the value of a successful execution.
void	internalOnComplete(PrecipiceFunction<Result,ExecutionContext> fn)
boolean	isCancelled()
boolean	isDone()
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.
long	permitCount() Returns the number of guard rail permits that this task required.
ResultView<Result,V>	resultView() Returns a view of the result of of this completable.
void	setCancellable(Cancellable cancellable)
long	startNanos() Returns the time that the guard rail approved the execution of this task.

Methods inherited from class java.lang.Object

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

Constructor Detail

Eventual

public Eventual()

Eventual

public Eventual(long permitCount)

Eventual

public Eventual(long permitCount,
                long startNanos)

Eventual

public Eventual(Completable<Result,V> completable)

Eventual

public Eventual(long permitCount,
                long startNanos,
                Completable<Result,V> completable)

Method Detail

complete

public boolean complete(Result result,
                        V value)

Description copied from interface: Completable

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

Specified by:

complete in interface Completable<Result extends Failable,V>

Parameters:

result - of the computation

value - of the computation

Returns:

if the context was competed successfully

completeExceptionally

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

Description copied from interface: Completable

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

Specified by:

completeExceptionally in interface Completable<Result extends Failable,V>

Parameters:

result - of the computation

exception - of the computation

Returns:

if the context was competed successfully

resultView

public ResultView<Result,V> resultView()

Description copied from interface: Completable

Returns a view of the result of of this completable.

Specified by:

resultView in interface Completable<Result extends Failable,V>

Returns:

the result view

future

public PrecipiceFuture<Result,V> future()

Description copied from interface: PrecipicePromise

Returns a future containing the result of this promise

Specified by:

future in interface PrecipicePromise<Result extends Failable,V>

Returns:

a future

get

public V get()
      throws java.lang.InterruptedException,
             java.util.concurrent.ExecutionException

Specified by:

get in interface java.util.concurrent.Future<V>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

get

public V get(long timeout,
             java.util.concurrent.TimeUnit unit)
      throws java.lang.InterruptedException,
             java.util.concurrent.ExecutionException,
             java.util.concurrent.TimeoutException

Specified by:

get in interface java.util.concurrent.Future<V>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

isDone

public boolean isDone()

Specified by:

isDone in interface java.util.concurrent.Future<V>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface java.util.concurrent.Future<V>

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface java.util.concurrent.Future<V>

await

public void await()
           throws java.lang.InterruptedException

Description copied from interface: PrecipiceFuture

Block until the completion of the future.

Specified by:

await in interface PrecipiceFuture<Result extends Failable,V>

Throws:

java.lang.InterruptedException

await

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

Description copied from interface: PrecipiceFuture

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

Specified by:

await in interface PrecipiceFuture<Result extends Failable,V>

Parameters:

duration - the maximum duration to wait

unit - the unit of the duration argument

Throws:

java.lang.InterruptedException

getValue

public V getValue()

Description copied from interface: ResultView

Return the value of a successful execution.

Specified by:

getValue in interface ResultView<Result extends Failable,V>

Returns:

the value

getError

public java.lang.Throwable getError()

Description copied from interface: ResultView

Return the exception that might have occurred during a failed execution.

Specified by:

getError in interface ResultView<Result extends Failable,V>

Returns:

the exception

onSuccess

public void onSuccess(PrecipiceFunction<Result,V> fn)

Description copied from interface: PrecipiceFuture

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.

Specified by:

onSuccess in interface PrecipiceFuture<Result extends Failable,V>

Parameters:

fn - function to be executed

onError

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

Description copied from interface: PrecipiceFuture

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.

Specified by:

onError in interface PrecipiceFuture<Result extends Failable,V>

Parameters:

fn - function to be executed

getResult

public Result getResult()

Description copied from interface: ResultView

Return the result of the execution.

Specified by:

getResult in interface ResultView<Result extends Failable,V>

Returns:

the result

startNanos

public long startNanos()

Description copied from interface: ExecutionContext

Returns the time that the guard rail approved the execution of this task.

Specified by:

startNanos in interface ExecutionContext

Returns:

the start nano time

permitCount

public long permitCount()

Description copied from interface: ExecutionContext

Returns the number of guard rail permits that this task required.

Specified by:

permitCount in interface ExecutionContext

Returns:

number of permits

setCancellable

public void setCancellable(Cancellable cancellable)

internalOnComplete

public void internalOnComplete(PrecipiceFunction<Result,ExecutionContext> fn)