net.uncontended.precipice.concurrent

Class AbstractResilientPromise<T>

java.lang.Object

net.uncontended.precipice.concurrent.AbstractResilientPromise<T>

All Implemented Interfaces:

ResilientPromise<T>

Direct Known Subclasses:

DefaultResilientPromise, SingleWriterResilientPromise

public abstract class AbstractResilientPromise<T>
extends java.lang.Object
implements ResilientPromise<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected T	result

Constructor Summary

Constructors

Constructor and Description
AbstractResilientPromise()

Method Summary

Modifier and Type	Method and Description
void	await() Block on this promise being completed.
boolean	await(long timeout, java.util.concurrent.TimeUnit unit)
T	awaitResult() Block on this promise being completed and return the result.
java.lang.Exception	getError() Return any error that has been delivered.
T	getResult() Return any result that has been delivered.
Status	getStatus() Return the status of the promise.
boolean	isDone() Indicate if the Status of the promise is not pending.
boolean	isError() Indicate if the Status of the promise is error.
boolean	isSuccessful() Indicate if the Status of the promise is successful.
boolean	isTimedOut() Indicate if the Status of the promise is timeout.
void	wrapPromise(ResilientPromise<T> promise)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.uncontended.precipice.concurrent.ResilientPromise

deliverError, deliverResult, setTimedOut

Field Detail

result

protected volatile T result

Constructor Detail

AbstractResilientPromise

public AbstractResilientPromise()

Method Detail

await

public void await()
           throws java.lang.InterruptedException

Description copied from interface: ResilientPromise

Block on this promise being completed.

Specified by:

await in interface ResilientPromise<T>

Throws:

java.lang.InterruptedException

await

public boolean await(long timeout,
                     java.util.concurrent.TimeUnit unit)
              throws java.lang.InterruptedException

Specified by:

await in interface ResilientPromise<T>

Throws:

java.lang.InterruptedException

awaitResult

public T awaitResult()
              throws java.lang.InterruptedException

Description copied from interface: ResilientPromise

Block on this promise being completed and return the result. If promise is not successfully completed, this will return null.

Specified by:

awaitResult in interface ResilientPromise<T>

Returns:

T the result of the promise

Throws:

java.lang.InterruptedException

getResult

public T getResult()

Description copied from interface: ResilientPromise

Return any result that has been delivered. If promise is not successfully completed or is still pending, this will return null.

Specified by:

getResult in interface ResilientPromise<T>

Returns:

T the result of the promise

getError

public java.lang.Exception getError()

Description copied from interface: ResilientPromise

Return any error that has been delivered. If action did not error or is still pending, this will return null.

Specified by:

getError in interface ResilientPromise<T>

Returns:

Exception the error of the promise

getStatus

public Status getStatus()

Description copied from interface: ResilientPromise

Return the status of the promise.

Specified by:

getStatus in interface ResilientPromise<T>

Returns:

Status the status of the promise

isSuccessful

public boolean isSuccessful()

Description copied from interface: ResilientPromise

Indicate if the Status of the promise is successful.

Specified by:

isSuccessful in interface ResilientPromise<T>

Returns:

boolean indicating if the status is successful

isDone

public boolean isDone()

Description copied from interface: ResilientPromise

Indicate if the Status of the promise is not pending.

Specified by:

isDone in interface ResilientPromise<T>

Returns:

boolean indicating if the promise is not pending

isError

public boolean isError()

Description copied from interface: ResilientPromise

Indicate if the Status of the promise is error.

Specified by:

isError in interface ResilientPromise<T>

Returns:

boolean indicating if the status is error

isTimedOut

public boolean isTimedOut()

Description copied from interface: ResilientPromise

Indicate if the Status of the promise is timeout.

Specified by:

isTimedOut in interface ResilientPromise<T>

Returns:

boolean indicating if the status is timeout

wrapPromise

public void wrapPromise(ResilientPromise<T> promise)