jadex.commons.future

Interface ITerminableFuture<E>

All Superinterfaces:

IBackwardCommandFuture, IFuture<E>

All Known Subinterfaces:

IPullIntermediateFuture<E>, IPullSubscriptionIntermediateFuture<E>, ISubscriptionIntermediateFuture<E>, ITerminableIntermediateFuture<E>

All Known Implementing Classes:

PullIntermediateDelegationFuture, PullIntermediateFuture, PullSubscriptionIntermediateDelegationFuture, PullSubscriptionIntermediateFuture, SubscriptionIntermediateDelegationFuture, SubscriptionIntermediateFuture, TerminableDelegationFuture, TerminableFuture, TerminableIntermediateDelegationFuture, TerminableIntermediateFuture

public interface ITerminableFuture<E>
extends IFuture<E>, IBackwardCommandFuture

Interface for a future that can be terminated from caller side. A termination request leads to setException() being called with a FutureTerminatedException.

Field Summary

Fields inherited from interface jadex.commons.future.IFuture

DONE, FALSE, TRUE

Method Summary

Modifier and Type	Method and Description
void	terminate() Terminate the future.
void	terminate(java.lang.Exception reason) Terminate the future and supply a custom reason.

Methods inherited from interface jadex.commons.future.IFuture

acceptEither, addResultListener, addResultListener, addResultListener, applyToEither, get, get, get, getException, isDone, thenAccept, thenAccept, thenApply, thenApply, thenCombine, thenCompose, thenCompose

Methods inherited from interface jadex.commons.future.IBackwardCommandFuture

sendBackwardCommand

Method Detail

terminate

void terminate()

Terminate the future. The exception will be set to FutureTerminatedException.

terminate

void terminate(java.lang.Exception reason)

Terminate the future and supply a custom reason.