net.uncontended.precipice

Class CompletionContext<Result extends Failable,V>

java.lang.Object

net.uncontended.precipice.CompletionContext<Result,V>

All Implemented Interfaces:

Completable<Result,V>, ExecutionContext, ResultView<Result,V>

public class CompletionContext<Result extends Failable,V>
extends java.lang.Object
implements Completable<Result,V>, ExecutionContext, ResultView<Result,V>

Constructor Summary

Constructors

Constructor and Description
CompletionContext()
CompletionContext(long permits)
CompletionContext(long startTime, Completable<Result,V> wrappedCompletable)
CompletionContext(long permits, long startTime)
CompletionContext(long permits, long startTime, Completable<Result,V> wrappedCompletable)

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.
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)
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.
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

CompletionContext

public CompletionContext()

CompletionContext

public CompletionContext(long permits)

CompletionContext

public CompletionContext(long permits,
                         long startTime)

CompletionContext

public CompletionContext(long startTime,
                         Completable<Result,V> wrappedCompletable)

CompletionContext

public CompletionContext(long permits,
                         long startTime,
                         Completable<Result,V> wrappedCompletable)

Method Detail

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

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

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

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

internalOnComplete

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