jadex.commons.future

Class IntermediateFuture<E>

java.lang.Object

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

jadex.commons.future.IntermediateFuture<E>

All Implemented Interfaces:

IForwardCommandFuture, IFuture<java.util.Collection<E>>, IIntermediateFuture<E>

Direct Known Subclasses:

TerminableIntermediateDelegationFuture, TerminableIntermediateFuture, Tuple2Future

public class IntermediateFuture<E>
extends Future<java.util.Collection<E>>
implements IIntermediateFuture<E>

Default implementation of an intermediate future.

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 java.util.Map<ISuspendable,java.lang.String>	icallers The blocked intermediate callers (caller->state).
protected java.util.Map<java.lang.Thread,java.lang.Integer>	indices The index of the next result for a thread.
protected boolean	intermediate Flag indicating that addIntermediateResult()has been called.
protected java.util.Collection<E>	results The intermediate results.
protected java.util.List	scheduled The scheduled notifications.

Fields inherited from class jadex.commons.future.Future

CALLER_QUEUED, CALLER_RESUMED, CALLER_SUSPENDED, callers, creation, DEBUG, exception, fcommands, first, listener, listeners, NO_STACK_COMPACTION, NONE, 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
IntermediateFuture() Create a future that is already done.
IntermediateFuture(java.util.Collection<E> results) Create a future that is already done.
IntermediateFuture(java.lang.Exception exception) Create a future that is already done (failed).

Method Summary

Modifier and Type	Method and Description
void	addIntermediateResult(E result) Add an intermediate result.
boolean	addIntermediateResultIfUndone(E result) Set the result.
void	addIntermediateResultListener(IFunctionalIntermediateResultListener<E> intermediateListener) Add a functional result listener, which called on intermediate results.
void	addIntermediateResultListener(IFunctionalIntermediateResultListener<E> intermediateListener, IFunctionalIntermediateFinishedListener<java.lang.Void> finishedListener) Add a functional result listener, which called on intermediate results.
void	addIntermediateResultListener(IFunctionalIntermediateResultListener<E> intermediateListener, IFunctionalIntermediateFinishedListener<java.lang.Void> finishedListener, IFunctionalExceptionListener exceptionListener) Add a functional result listener, which called on intermediate results.
void	addIntermediateResultListener(IIntermediateResultListener<E> intermediateListener) Add an result listener, which called on intermediate results.
protected void	addResult(E result) Add a result.
void	addResultListener(IResultListener<java.util.Collection<E>> listener) Add a result listener.
protected boolean	doAddIntermediateResult(E result, boolean undone) Set the result without notifying listeners.
protected E	doGetNextIntermediateResult(int index, long timeout, boolean realtime) Perform the get without increasing the index.
protected void	doNotifyListener(IResultListener<java.util.Collection<E>> listener) Notify a result listener.
protected boolean	doSetFinished(boolean undone) Declare that the future is finished.
protected boolean	doSetResult(java.util.Collection<E> result, boolean undone) Set the result.
<R> IIntermediateFuture<R>	flatMapAsync(Function<E,IIntermediateFuture<R>> function) Implements async loop and applies a an async multi-function to each element.
java.util.Collection<E>	getIntermediateResults() Get the intermediate results that are available.
E	getNextIntermediateResult() Iterate over the intermediate results in a blocking fashion.
E	getNextIntermediateResult(boolean realtime) Iterate over the intermediate results in a blocking fashion.
E	getNextIntermediateResult(long timeout, boolean realtime) Iterate over the intermediate results in a blocking fashion.
boolean	hasNextIntermediateResult() Check if there are more results for iteration for the given caller.
<R> IIntermediateFuture<R>	mapAsync(Function<E,IFuture<R>> function) Implements async loop and applies a an async function to each element.
<R> IIntermediateFuture<R>	mapAsync(Function<E,IFuture<R>> function, java.lang.Class<?> futuretype) Implements async loop and applies a an async function to each element.
protected void	notifyIntermediateResult(IIntermediateResultListener<E> listener, E result) Notify a result listener.
protected void	notifyListener(IResultListener<java.util.Collection<E>> listener) Notify a result listener.
protected void	resume() Resume also intermediate waiters.
protected void	resumeIntermediate() Resume after intermediate result.
protected void	scheduleNotification(IResultListener<java.util.Collection<E>> listener, boolean intermediate, java.lang.Object result) Schedule a listener notification.
void	setFinished() Declare that the future is finished.
boolean	setFinishedIfUndone() Declare that the future is finished.
protected void	startScheduledNotifications() Start scheduled listener notifications if not already running.

Methods inherited from class jadex.commons.future.Future

abortGet, acceptEither, addForwardCommand, addResultListener, addResultListener, applyToEither, doSetException, get, get, get, get, get, getEmptyFuture, getException, getFuture, hasResultListener, isDone, notifyListenerCommand, removeForwardCommand, sendForwardCommand, setException, setExceptionIfUndone, setResult, setResultIfUndone, 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.IFuture

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

Field Detail

results

protected java.util.Collection<E> results

The intermediate results.

intermediate

protected boolean intermediate

Flag indicating that addIntermediateResult()has been called.

scheduled

protected java.util.List scheduled

The scheduled notifications.

icallers

protected java.util.Map<ISuspendable,java.lang.String> icallers

The blocked intermediate callers (caller->state).

indices

protected java.util.Map<java.lang.Thread,java.lang.Integer> indices

The index of the next result for a thread.

Constructor Detail

IntermediateFuture

public IntermediateFuture()

Create a future that is already done.

Parameters:

result - The result, if any.

IntermediateFuture

public IntermediateFuture(java.util.Collection<E> results)

Create a future that is already done.

Parameters:

result - The result, if any.

IntermediateFuture

public IntermediateFuture(java.lang.Exception exception)

Create a future that is already done (failed).

Parameters:

exception - The exception.

Method Detail

getIntermediateResults

public java.util.Collection<E> getIntermediateResults()

Get the intermediate results that are available.

Specified by:

getIntermediateResults in interface IIntermediateFuture<E>

Returns:

The current intermediate results (copy of the list).

addIntermediateResult

public void addIntermediateResult(E result)

Add an intermediate result.

addIntermediateResultIfUndone

public boolean addIntermediateResultIfUndone(E result)

Set the result. Listener notifications occur on calling thread of this method.

Parameters:

result - The result.

Returns:

True if result was set.

doAddIntermediateResult

protected boolean doAddIntermediateResult(E result,
                                          boolean undone)

Set the result without notifying listeners.

addResult

protected void addResult(E result)

Add a result.

Parameters:

result - The result.

doSetResult

protected boolean doSetResult(java.util.Collection<E> result,
                              boolean undone)

Set the result. Listener notifications occur on calling thread of this method.

Overrides:

doSetResult in class Future<java.util.Collection<E>>

Parameters:

result - The result.

setFinished

public void setFinished()

Declare that the future is finished.

setFinishedIfUndone

public boolean setFinishedIfUndone()

Declare that the future is finished.

doSetFinished

protected boolean doSetFinished(boolean undone)

Declare that the future is finished.

addResultListener

public void addResultListener(IResultListener<java.util.Collection<E>> listener)

Add a result listener.

Specified by:

addResultListener in interface IFuture<java.util.Collection<E>>

Overrides:

addResultListener in class Future<java.util.Collection<E>>

Parameters:

listener - The listener.

addIntermediateResultListener

public void addIntermediateResultListener(IIntermediateResultListener<E> intermediateListener)

Add an result listener, which called on intermediate results.

Specified by:

addIntermediateResultListener in interface IIntermediateFuture<E>

Parameters:

intermediateListener - The intermediate listener.

addIntermediateResultListener

public void addIntermediateResultListener(IFunctionalIntermediateResultListener<E> intermediateListener)

Add a functional result listener, which called on intermediate results. Exceptions will be logged.

Specified by:

addIntermediateResultListener in interface IIntermediateFuture<E>

Parameters:

intermediateListener - The intermediate listener.

addIntermediateResultListener

public void addIntermediateResultListener(IFunctionalIntermediateResultListener<E> intermediateListener,
                                          IFunctionalIntermediateFinishedListener<java.lang.Void> finishedListener)

Add a functional result listener, which called on intermediate results. Exceptions will be logged.

Specified by:

addIntermediateResultListener in interface IIntermediateFuture<E>

Parameters:

intermediateListener - The intermediate listener.

finishedListener - The finished listener, called when no more intermediate results will arrive. If null, the finish event will be ignored.

addIntermediateResultListener

public void addIntermediateResultListener(IFunctionalIntermediateResultListener<E> intermediateListener,
                                          IFunctionalIntermediateFinishedListener<java.lang.Void> finishedListener,
                                          IFunctionalExceptionListener exceptionListener)

Add a functional result listener, which called on intermediate results.

Specified by:

addIntermediateResultListener in interface IIntermediateFuture<E>

Parameters:

intermediateListener - The intermediate listener.

finishedListener - The finished listener, called when no more intermediate results will arrive. If null, the finish event will be ignored.

exceptionListener - The listener that is called on exceptions. Passing null enables default exception logging.

hasNextIntermediateResult

public boolean hasNextIntermediateResult()

Check if there are more results for iteration for the given caller. If there are currently no unprocessed results and future is not yet finished, the caller is blocked until either new results are available and true is returned or the future is finished, thus returning false.

Specified by:

hasNextIntermediateResult in interface IIntermediateFuture<E>

Returns:

True, when there are more intermediate results for the caller.

getNextIntermediateResult

public E getNextIntermediateResult()

Iterate over the intermediate results in a blocking fashion. Manages results independently for different callers, i.e. when called from different threads, each thread receives all intermediate results. The operation is guaranteed to be non-blocking, if hasNextIntermediateResult() has returned true before for the same caller. Otherwise the caller is blocked until a result is available or the future is finished.

Specified by:

getNextIntermediateResult in interface IIntermediateFuture<E>

Returns:

The next intermediate result.

Throws:

NoSuchElementException, - when there are no more intermediate results and the future is finished.

getNextIntermediateResult

public E getNextIntermediateResult(boolean realtime)

Iterate over the intermediate results in a blocking fashion. Manages results independently for different callers, i.e. when called from different threads, each thread receives all intermediate results. The operation is guaranteed to be non-blocking, if hasNextIntermediateResult() has returned true before for the same caller. Otherwise the caller is blocked until a result is available or the future is finished.

Returns:

The next intermediate result.

Throws:

NoSuchElementException, - when there are no more intermediate results and the future is finished.

getNextIntermediateResult

public E getNextIntermediateResult(long timeout,
                                   boolean realtime)

Iterate over the intermediate results in a blocking fashion. Manages results independently for different callers, i.e. when called from different threads, each thread receives all intermediate results. The operation is guaranteed to be non-blocking, if hasNextIntermediateResult() has returned true before for the same caller. Otherwise the caller is blocked until a result is available or the future is finished.

Returns:

The next intermediate result.

Throws:

NoSuchElementException, - when there are no more intermediate results and the future is finished.

doGetNextIntermediateResult

protected E doGetNextIntermediateResult(int index,
                                        long timeout,
                                        boolean realtime)

Perform the get without increasing the index.

notifyIntermediateResult

protected void notifyIntermediateResult(IIntermediateResultListener<E> listener,
                                        E result)

Notify a result listener.

Parameters:

listener - The listener.

notifyListener

protected void notifyListener(IResultListener<java.util.Collection<E>> listener)

Notify a result listener.

Overrides:

notifyListener in class Future<java.util.Collection<E>>

Parameters:

listener - The listener.

doNotifyListener

protected void doNotifyListener(IResultListener<java.util.Collection<E>> listener)

Notify a result listener.

Parameters:

listener - The listener.

scheduleNotification

protected void scheduleNotification(IResultListener<java.util.Collection<E>> listener,
                                    boolean intermediate,
                                    java.lang.Object result)

Schedule a listener notification.

Parameters:

listener - The listener to be notified.

intermediate - True for intermediate result, false for final results.

result - The intermediate result (if any).

startScheduledNotifications

protected void startScheduledNotifications()

Start scheduled listener notifications if not already running. Must not be called from synchronized block.

resume

protected void resume()

Resume also intermediate waiters.

Overrides:

resume in class Future<java.util.Collection<E>>

resumeIntermediate

protected void resumeIntermediate()

Resume after intermediate result.

mapAsync

public <R> IIntermediateFuture<R> mapAsync(Function<E,IFuture<R>> function)

Implements async loop and applies a an async function to each element.

Specified by:

mapAsync in interface IIntermediateFuture<E>

Parameters:

function - The function.

Returns:

True result intermediate future.

mapAsync

public <R> IIntermediateFuture<R> mapAsync(Function<E,IFuture<R>> function,
                                           java.lang.Class<?> futuretype)

Implements async loop and applies a an async function to each element.

Specified by:

mapAsync in interface IIntermediateFuture<E>

Parameters:

function - The function.

Returns:

True result intermediate future.

flatMapAsync

public <R> IIntermediateFuture<R> flatMapAsync(Function<E,IIntermediateFuture<R>> function)

Implements async loop and applies a an async multi-function to each element.

Specified by:

flatMapAsync in interface IIntermediateFuture<E>

Parameters:

function - The function.

Returns:

True result intermediate future.