jadex.commons.future

Class PullIntermediateFuture<E>

java.lang.Object

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

jadex.commons.future.IntermediateFuture<E>

jadex.commons.future.TerminableIntermediateFuture<E>

jadex.commons.future.PullIntermediateFuture<E>

All Implemented Interfaces:

IBackwardCommandFuture, IForwardCommandFuture, IFuture<java.util.Collection<E>>, IIntermediateFuture<E>, IPullIntermediateFuture<E>, ITerminableFuture<java.util.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

Modifier and Type	Field and Description
protected ICommand<PullIntermediateFuture<E>>	pullcmd The pull command.

Fields inherited from class jadex.commons.future.TerminableIntermediateFuture

bcommands, terminate

Fields inherited from class jadex.commons.future.IntermediateFuture

icallers, indices, intermediate, notcommand, results

Fields inherited from class jadex.commons.future.Future

CALLER_QUEUED, CALLER_RESUMED, CALLER_SUSPENDED, callers, creation, DEBUG, exception, first, listener, listeners, NO_STACK_COMPACTION, NONE, notifications, result, resultavailable, STACK, undone, UNSET

Fields inherited from interface jadex.commons.future.IIntermediateFuture

DONE

Fields inherited from interface jadex.commons.future.IFuture

FALSE, TRUE

Constructor Summary

Constructors

Constructor and Description
PullIntermediateFuture() Create a new future.
PullIntermediateFuture(java.lang.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, addIntermediateResultListener, addResultListener, doAddIntermediateResult, doGetNextIntermediateResult, doSetFinished, doSetResult, flatMapAsync, getIntermediateResults, getNextIntermediateResult, getNextIntermediateResult, getNextIntermediateResult, getNotificationCommand, hasNextIntermediateResult, hasNextIntermediateResult, mapAsync, mapAsync, notifyIntermediateResult, resume, resumeIntermediate, setFinished, setFinishedIfUndone, storeResult

Methods inherited from class jadex.commons.future.Future

abortGet, acceptEither, addResultListener, addResultListener, applyToEither, delegate, doSetException, exceptionally, exceptionally, exceptionally, executeNotification, get, get, get, get, get, getEmptyFuture, getException, getFuture, hasResultListener, isDone, notifyListener, notifyListener, scheduleNotification, scheduleNotification, scheduleNotification, sendForwardCommand, setException, setExceptionIfUndone, setResult, setResultIfUndone, startScheduledNotifications, thenAccept, thenAccept, thenApply, thenApply, thenCombine, thenCompose, thenCompose

Methods inherited from class java.lang.Object

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

Methods inherited from interface jadex.commons.future.IIntermediateFuture

addIntermediateResultListener, addIntermediateResultListener, addIntermediateResultListener, addIntermediateResultListener, addIntermediateResultListener, flatMapAsync, getIntermediateResults, getNextIntermediateResult, getNextIntermediateResult, hasNextIntermediateResult, hasNextIntermediateResult, mapAsync, mapAsync

Methods inherited from interface jadex.commons.future.ITerminableFuture

terminate, terminate

Methods inherited from interface jadex.commons.future.IFuture

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

Methods inherited from interface jadex.commons.future.IBackwardCommandFuture

sendBackwardCommand

Field Detail

pullcmd

protected ICommand<PullIntermediateFuture<E>> pullcmd

The pull command.

Constructor Detail

PullIntermediateFuture

public PullIntermediateFuture()

Create a new future.

PullIntermediateFuture

public PullIntermediateFuture(java.lang.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>