Package de.quantummaid.eventmaid.messagefunction.internal

Class ExpectedResponseFuture

java.lang.Object

de.quantummaid.eventmaid.messagefunction.internal.ExpectedResponseFuture

All Implemented Interfaces:

ResponseFuture, Future<Object>

public final class ExpectedResponseFuture
extends Object
implements ResponseFuture

Constructor Summary

Constructors

Constructor	Description
ExpectedResponseFuture()

Method Summary

Modifier and Type	Method	Description
boolean	cancel(boolean mayInterruptIfRunning)
static ExpectedResponseFuture	expectedResponseFuture(SubscriptionContainer subscriptionContainer)
void	fullFill(ProcessingContext<Object> response)
void	fullFillWithException(Exception e)
Object	get()
Object	get(long timeout, TimeUnit unit)
Object	getErrorResponse()	Waits until the future is fulfilled and returns the error payload.
Object	getErrorResponse(long timeout, TimeUnit unit)	Waits until the future is fulfilled to return the error payload or the timeout expires.
ProcessingContext<Object>	getRaw()	Waits until the future is fulfilled and returns the ProcessingContext payload.
ProcessingContext<Object>	getRaw(long timeout, TimeUnit unit)	Waits until the future is fulfilled and returns the ProcessingContext payload or the timeout expires.
boolean	isCancelled()
boolean	isDone()
void	then(FollowUpAction followUpAction)	Adds a FollowUpAction, that gets executed, once the Future is fulfilled.
boolean	wasSuccessful()	Returns true if the future was fulfilled with an success response, false if an exception occurred, the future was cancelled or the error payload is not null.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExpectedResponseFuture

public ExpectedResponseFuture()

Method Detail

expectedResponseFuture

public static ExpectedResponseFuture expectedResponseFuture(SubscriptionContainer subscriptionContainer)

fullFill

public void fullFill(ProcessingContext<Object> response)

fullFillWithException

public void fullFillWithException(Exception e)

wasSuccessful

public boolean wasSuccessful()

Description copied from interface: ResponseFuture

Returns true if the future was fulfilled with an success response, false if an exception occurred, the future was cancelled or the error payload is not null.

Specified by:

wasSuccessful in interface ResponseFuture

Returns:

true if only payload is set, false otherwise

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<Object>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<Object>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<Object>

get

public Object get()
           throws InterruptedException,
                  ExecutionException

Specified by:

get in interface Future<Object>

Throws:

InterruptedException

ExecutionException

get

public Object get(long timeout,
                  TimeUnit unit)
           throws InterruptedException,
                  ExecutionException,
                  TimeoutException

Specified by:

get in interface Future<Object>

Throws:

InterruptedException

ExecutionException

TimeoutException

getErrorResponse

public Object getErrorResponse()
                        throws InterruptedException,
                               ExecutionException

Description copied from interface: ResponseFuture

Waits until the future is fulfilled and returns the error payload.

Specified by:

getErrorResponse in interface ResponseFuture

Returns:

the error payload of the message or null if none exists

Throws:

InterruptedException - if the waiting Thread is interrupted

ExecutionException - if the future was fulfilled with an exception

getErrorResponse

public Object getErrorResponse(long timeout,
                               TimeUnit unit)
                        throws InterruptedException,
                               ExecutionException,
                               TimeoutException

Description copied from interface: ResponseFuture

Waits until the future is fulfilled to return the error payload or the timeout expires.

Specified by:

getErrorResponse in interface ResponseFuture

Parameters:

timeout - the interval to wait

unit - the unit of the interval

Returns:

the error payload of the message or null if none exists

Throws:

InterruptedException - if the waiting Thread is interrupted

ExecutionException - if the future was fulfilled with an exception

TimeoutException - if the timeout expired

getRaw

public ProcessingContext<Object> getRaw()
                                 throws InterruptedException,
                                        ExecutionException

Description copied from interface: ResponseFuture

Waits until the future is fulfilled and returns the ProcessingContext payload.

Specified by:

getRaw in interface ResponseFuture

Returns:

the ProcessingContext of the message

Throws:

InterruptedException - if the waiting Thread is interrupted

ExecutionException - if the future was fulfilled with an exception

getRaw

public ProcessingContext<Object> getRaw(long timeout,
                                        TimeUnit unit)
                                 throws InterruptedException,
                                        ExecutionException,
                                        TimeoutException

Description copied from interface: ResponseFuture

Waits until the future is fulfilled and returns the ProcessingContext payload or the timeout expires.

Specified by:

getRaw in interface ResponseFuture

Parameters:

timeout - the interval to wait

unit - the unit of the interval

Returns:

the ProcessingContext of the message

Throws:

InterruptedException - if the waiting Thread is interrupted

ExecutionException - if the future was fulfilled with an exception

TimeoutException - if the timeout expired

then

public void then(FollowUpAction followUpAction)

Description copied from interface: ResponseFuture

Adds a FollowUpAction, that gets executed, once the Future is fulfilled.

Specified by:

then in interface ResponseFuture

Parameters:

followUpAction - the FollowUpAction to execute