jadex.commons.future

Class TerminableIntermediateFuture<E>

java.lang.Object

jadex.commons.future.Future<Collection<E>>

jadex.commons.future.IntermediateFuture<E>

jadex.commons.future.TerminableIntermediateFuture<E>

All Implemented Interfaces:

IFuture<Collection<E>>, IIntermediateFuture<E>, ITerminableFuture<Collection<E>>, ITerminableIntermediateFuture<E>

Direct Known Subclasses:

SubscriptionIntermediateFuture

public class TerminableIntermediateFuture<E>
extends IntermediateFuture<E>
implements ITerminableIntermediateFuture<E>

Intermediate future that can be terminated from caller side. A termination request leads to setException() being called with a FutureTerminatedException. The future can be supplied with a command that gets executed if terminate is called.

Field Summary

Fields inherited from class jadex.commons.future.Future

DEBUG, EMPTY, NO_STACK_COMPACTION, STACK

Fields inherited from interface jadex.commons.future.IIntermediateFuture

DONE

Constructor Summary

Constructors

Constructor and Description
TerminableIntermediateFuture() Create a new future.
TerminableIntermediateFuture(Exception exception) Create a future that is already done (failed).
TerminableIntermediateFuture(ITerminationCommand terminate) Create a new future.

Method Summary

Methods

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

Methods inherited from class jadex.commons.future.IntermediateFuture

addIntermediateResult, addIntermediateResultIfUndone, addResultListener, getIntermediateResults, getNextIntermediateResult, hasNextIntermediateResult, setFinished, setFinishedIfUndone, setResult, setResultIfUndone

Methods inherited from class jadex.commons.future.Future

get, get, getEmptyFuture, getException, isDone, setException, setExceptionIfUndone

Methods inherited from class java.lang.Object

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

Methods inherited from interface jadex.commons.future.IIntermediateFuture

getIntermediateResults, getNextIntermediateResult, hasNextIntermediateResult

Methods inherited from interface jadex.commons.future.IFuture

addResultListener, get, get, getException, isDone

Constructor Detail

TerminableIntermediateFuture

public TerminableIntermediateFuture()

Create a new future.

TerminableIntermediateFuture

public TerminableIntermediateFuture(Exception exception)

Create a future that is already done (failed).

Parameters:

exception - The exception.

TerminableIntermediateFuture

public TerminableIntermediateFuture(ITerminationCommand terminate)

Create a new future.

Parameters:

terminate - The runnable to be executed in case of termination.

Method Detail

terminate

public void terminate()

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

Specified by:

terminate in interface ITerminableFuture<Collection<E>>

terminate

public void terminate(Exception reason)

Terminate the future and supply a custom reason.

Specified by:

terminate in interface ITerminableFuture<Collection<E>>