jadex.commons.future

Class PullIntermediateFuture<E>

java.lang.Object

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

jadex.commons.future.IntermediateFuture<E>

jadex.commons.future.TerminableIntermediateFuture<E>

jadex.commons.future.PullIntermediateFuture<E>

All Implemented Interfaces:

IBackwardCommandFuture, IForwardCommandFuture, IFuture<Collection<E>>, IIntermediateFuture<E>, IPullIntermediateFuture<E>, ITerminableFuture<Collection<E>>, ITerminableIntermediateFuture<E>

public class PullIntermediateFuture<E>
extends TerminableIntermediateFuture<E>
implements IPullIntermediateFuture<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.

Nested Class Summary

Nested classes/interfaces inherited from interface jadex.commons.future.IForwardCommandFuture

IForwardCommandFuture.Type

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
PullIntermediateFuture(Exception exception) Create a future that is already done (failed).
PullIntermediateFuture(ICommand<PullIntermediateFuture<E>> pullcmd) Create a new future.
PullIntermediateFuture(ICommand<PullIntermediateFuture<E>> pullcmd, ITerminationCommand termcom) Create a new future.

Method Summary

Modifier and Type	Method and Description
void	pullIntermediateResult() Pull an intermediate result.

Methods inherited from class jadex.commons.future.TerminableIntermediateFuture

addBackwardCommand, getTerminationCommand, removeBackwardCommand, sendBackwardCommand, setTerminationCommand, terminate, terminate

Methods inherited from class jadex.commons.future.IntermediateFuture

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

Methods inherited from class jadex.commons.future.Future

abortGet, addForwardCommand, addResultListener, addResultListener, get, get, get, get, getEmptyFuture, getException, isDone, removeForwardCommand, sendForwardCommand, 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

addIntermediateResultListener, addIntermediateResultListener, addIntermediateResultListener, addIntermediateResultListener, getIntermediateResults, getNextIntermediateResult, hasNextIntermediateResult

Methods inherited from interface jadex.commons.future.ITerminableFuture

terminate, terminate

Methods inherited from interface jadex.commons.future.IFuture

addResultListener, addResultListener, addResultListener, get, get, get, get, getException, isDone

Methods inherited from interface jadex.commons.future.IBackwardCommandFuture

sendBackwardCommand

Constructor Detail

PullIntermediateFuture

public PullIntermediateFuture(Exception exception)

Create a future that is already done (failed).

Parameters:

exception - The exception.

PullIntermediateFuture

public PullIntermediateFuture(ICommand<PullIntermediateFuture<E>> pullcmd)

Create a new future.

Parameters:

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

PullIntermediateFuture

public PullIntermediateFuture(ICommand<PullIntermediateFuture<E>> pullcmd,
                              ITerminationCommand termcom)

Create a new future.

Parameters:

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

Method Detail

pullIntermediateResult

public void pullIntermediateResult()

Pull an intermediate result.

Specified by:

pullIntermediateResult in interface IPullIntermediateFuture<E>