Package 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	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 int	maxresultcnt	The max result count (if given by the producer).
protected ICommand<IResultListener<java.util.Collection<E>>>	notcommand
protected java.util.List<E>	results	The intermediate results.

Fields inherited from class jadex.commons.future.Future

CALLER_QUEUED, CALLER_RESUMED, CALLER_SUSPENDED, callers, creation, DEBUG, exception, first, listeners, NO_STACK_COMPACTION, NONE, NOTIFICATIONS, notificount, notified, result, resultavailable, undone, UNSET

Fields inherited from interface jadex.commons.future.IFuture

DONE, FALSE, TRUE

Fields inherited from interface jadex.commons.future.IIntermediateFuture

DONE

Constructor Summary

Constructors

Constructor	Description
IntermediateFuture()	Create a future that is already done.
IntermediateFuture(java.lang.Exception exception)	Create a future that is already done (failed).
IntermediateFuture(java.util.Collection<E> results)	Create a future that is already done.

Method Summary

Modifier and Type	Method	Description
void	addIntermediateResult(E result)	Add an intermediate result.
boolean	addIntermediateResultIfUndone(E result)	Set the result.
void	addResultListener(IResultListener<java.util.Collection<E>> listener)	Add a result listener.
java.util.stream.Stream<E>	asStream()	Return a stream of the results of this future.
java.util.stream.Stream<E>	asStream(long timeout, boolean realtime)	Return a stream of the results of this future.
IIntermediateFuture<E>	catchEx(java.util.function.Consumer<? super java.lang.Exception> consumer, java.lang.Class<?> futuretype)	Called on exception.
<T> IIntermediateFuture<E>	delegateEx(Future<T> delegate)	Called on exception.
protected boolean	doAddIntermediateResult(E result, boolean undone)	Set the result and schedule listener notifications.
protected E	doGetNextIntermediateResult(int index, long timeout, boolean realtime)	Perform the get without increasing the index.
IIntermediateFuture<? extends E>	done(java.util.function.Consumer<? super java.lang.Exception> consumer)	Called when the future is done (finished or exception occurred).
protected boolean	doSetException(java.lang.Exception exception, boolean undone)	Set the exception (internal implementation for normal and if-undone).
protected boolean	doSetFinished(boolean undone)	Declare that the future is finished.
protected boolean	doSetResult(java.util.Collection<E> result, boolean undone)	Set the result.
IIntermediateFuture<? extends E>	finished(java.util.function.Consumer<java.lang.Void> function)	Called when the future is finished.
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.
protected ICommand<IResultListener<java.util.Collection<E>>>	getNotificationCommand()	Get the notification command.
protected int	getResultCount()	Get the number of results already collected.
boolean	hasNextIntermediateResult()	Check if there are more results for iteration for the given caller.
boolean	hasNextIntermediateResult(long timeout, boolean realtime)	Check if there are more results for iteration for the given caller.
IIntermediateFuture<? extends E>	max(java.util.function.Consumer<java.lang.Integer> function)	Called when the maximum number of results is available.
IIntermediateFuture<? extends E>	next(java.util.function.Consumer<? super E> function)	Called when the next intermediate value is available.
protected void	notifyIntermediateResult(IIntermediateResultListener<E> listener, E result)	Notify a result listener.
protected void	resume()	Resume also intermediate waiters.
protected void	resumeIntermediate()	Resume after intermediate result.
protected boolean	scheduleMaxNotification(IResultListener<java.util.Collection<E>> lis)
void	setFinished()	Declare that the future is finished.
boolean	setFinishedIfUndone()	Declare that the future is finished.
void	setMaxResultCount(int max)	Set the maximum number of results.
protected void	storeResult(E result, boolean scheduled)	Add a result.
IIntermediateFuture<E>	then(java.util.function.Consumer<? super java.util.Collection<E>> function)	Applies a function after the result is available, using the result of this Future as input.

Methods inherited from class jadex.commons.future.Future

abortGet, catchEx, catchEx, delegate, doAddResultListener, doStartScheduledNotifications, executeNotification, get, get, get, get, get, getEmptyFuture, getException, getFuture, hasResultListener, isDone, isNotified, scheduleNotification, scheduleNotification, sendForwardCommand, setException, setExceptionIfUndone, setResult, setResultIfUndone, startScheduledNotifications, thenAccept, thenAccept, thenApply, thenApply, thenCombine, thenCompose, thenCompose, throwException

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

catchEx, catchEx, delegate, get, get, get, get, get, getException, isDone, thenApply, thenApply, thenCompose, thenCompose

Field Detail

results

protected java.util.List<E> results

The intermediate results.

intermediate

protected boolean intermediate

Flag indicating that addIntermediateResult()has been called.

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.

maxresultcnt

protected int maxresultcnt

The max result count (if given by the producer).

notcommand

protected ICommand<IResultListener<java.util.Collection<E>>> notcommand

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.

Parameters:

result - The result.

Returns:

True if result was set.

doAddIntermediateResult

protected boolean doAddIntermediateResult(E result,
                                          boolean undone)

Set the result and schedule listener notifications.

Returns:

true, when the result was added (finished and undone otherwise).

storeResult

protected void storeResult(E result,
                           boolean scheduled)

Add a result.

Parameters:

result - The result.

scheduled - True, if any listener notification has been scheduled for this result. (used for subscription futures to check for lost values)

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.

doSetException

protected boolean doSetException(java.lang.Exception exception,
                                 boolean undone)

Description copied from class: Future

Set the exception (internal implementation for normal and if-undone).

Overrides:

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

addResultListener

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

Add a result listener.

Specified by:

addResultListener in interface IFuture<E>

Overrides:

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

Parameters:

listener - The listener.

getNotificationCommand

protected ICommand<IResultListener<java.util.Collection<E>>> getNotificationCommand()

Get the notification command.

Overrides:

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

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.

hasNextIntermediateResult

public boolean hasNextIntermediateResult(long timeout,
                                         boolean realtime)

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>

Parameters:

timeout - The timeout in millis.

realtime - Flag, if wait should be realtime (in constrast to simulation time).

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.

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.

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.

Specified by:

getNextIntermediateResult in interface IIntermediateFuture<E>

Parameters:

timeout - The timeout in millis.

realtime - Flag, if wait should be realtime (in constrast to simulation time).

Returns:

The next intermediate result.

setMaxResultCount

public void setMaxResultCount(int max)

Set the maximum number of results.

Parameters:

max - The maximum number of results.

scheduleMaxNotification

protected boolean scheduleMaxNotification(IResultListener<java.util.Collection<E>> lis)

Parameters:

max -

getResultCount

protected int getResultCount()

Get the number of results already collected.

Returns:

The number of results.

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.

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.

catchEx

public IIntermediateFuture<E> catchEx(java.util.function.Consumer<? super java.lang.Exception> consumer,
                                      java.lang.Class<?> futuretype)

Description copied from class: Future

Called on exception.

Specified by:

catchEx in interface IFuture<E>

Overrides:

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

Parameters:

consumer - The function called with the exception.

futuretype - The function called with the exception.

delegateEx

public <T> IIntermediateFuture<E> delegateEx(Future<T> delegate)

Called on exception.

Overrides:

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

Parameters:

delegate - The future the exception will be delegated to.

then

public IIntermediateFuture<E> then(java.util.function.Consumer<? super java.util.Collection<E>> function)

Description copied from interface: IFuture

Applies a function after the result is available, using the result of this Future as input.

Specified by:

then in interface IFuture<E>

Overrides:

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

Parameters:

function - Function that takes the result of this future as input and delivers t.

Returns:

Future of the result after the function has been applied.

next

public IIntermediateFuture<? extends E> next(java.util.function.Consumer<? super E> function)

Called when the next intermediate value is available.

Specified by:

next in interface IIntermediateFuture<E>

Parameters:

function - Called when value arrives.

Returns:

The future for chaining.

max

public IIntermediateFuture<? extends E> max(java.util.function.Consumer<java.lang.Integer> function)

Called when the maximum number of results is available.

Specified by:

max in interface IIntermediateFuture<E>

Parameters:

function - Called when max value arrives.

Returns:

The future for chaining.

finished

public IIntermediateFuture<? extends E> finished(java.util.function.Consumer<java.lang.Void> function)

Called when the future is finished.

Specified by:

finished in interface IIntermediateFuture<E>

Parameters:

function - Called when max value arrives.

Returns:

The future for chaining.

done

public IIntermediateFuture<? extends E> done(java.util.function.Consumer<? super java.lang.Exception> consumer)

Called when the future is done (finished or exception occurred). Exception parameter will be set if the cause was an exception, null otherwise.

Specified by:

done in interface IIntermediateFuture<E>

Parameters:

consumer - Called future is done.

Returns:

The future for chaining.

asStream

public java.util.stream.Stream<E> asStream()

Return a stream of the results of this future. Although this method itself is non-blocking, all terminal stream methods (e.g. forEach) will block until the future is finished!

Specified by:

asStream in interface IIntermediateFuture<E>

asStream

public java.util.stream.Stream<E> asStream(long timeout,
                                           boolean realtime)

Return a stream of the results of this future. Use the given timeout settings when waiting for elements in the stream. Although this method itself is non-blocking, all terminal stream methods (e.g. forEach) will block until the future is finished!

Specified by:

asStream in interface IIntermediateFuture<E>

Parameters:

timeout - The timeout in millis.

realtime - Flag, if wait should be realtime (in constrast to simulation time).