jadex.commons.future

Class IntermediateFuture<E>

java.lang.Object

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

jadex.commons.future.IntermediateFuture<E>

All Implemented Interfaces:

IForwardCommandFuture, IFuture<Collection<E>>, IIntermediateFuture<E>

Direct Known Subclasses:

TerminableIntermediateDelegationFuture, TerminableIntermediateFuture, Tuple2Future

public class IntermediateFuture<E>
extends Future<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 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
IntermediateFuture() Create a future that is already done.
IntermediateFuture(Collection<E> results) Create a future that is already done.
IntermediateFuture(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(IFunctionalResultListener<E> intermediateListener) Add a functional result listener, which called on intermediate results.
void	addIntermediateResultListener(IFunctionalResultListener<E> intermediateListener, IFunctionalResultListener<Void> finishedListener) Add a functional result listener, which called on intermediate results.
void	addIntermediateResultListener(IFunctionalResultListener<E> intermediateListener, IFunctionalResultListener<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.
void	addResultListener(IResultListener<Collection<E>> listener) Add a result listener.
Collection<E>	getIntermediateResults() Get the intermediate results that are available.
E	getNextIntermediateResult() Iterate over the intermediate results in a blocking fashion.
E	getNextIntermediateResult(ISuspendable sus) Iterate over the intermediate results in a blocking fashion.
boolean	hasNextIntermediateResult() Check if there are more results for iteration for the given caller.
void	setFinished() Declare that the future is finished.
boolean	setFinishedIfUndone() Declare that the future is finished.
void	setResult(Collection<E> result) Set the result.
boolean	setResultIfUndone(Collection<E> result) Set the result.

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.IFuture

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

Constructor Detail

IntermediateFuture

public IntermediateFuture()

Create a future that is already done.

Parameters:

result - The result, if any.

IntermediateFuture

public IntermediateFuture(Collection<E> results)

Create a future that is already done.

Parameters:

result - The result, if any.

IntermediateFuture

public IntermediateFuture(Exception exception)

Create a future that is already done (failed).

Parameters:

exception - The exception.

Method Detail

getIntermediateResults

public 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.

setResult

public void setResult(Collection<E> result)

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

Overrides:

setResult in class Future<Collection<E>>

Parameters:

result - The result.

setResultIfUndone

public boolean setResultIfUndone(Collection<E> result)

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

Overrides:

setResultIfUndone in class Future<Collection<E>>

Parameters:

result - The result.

Returns:

True if result was set.

setFinished

public void setFinished()

Declare that the future is finished.

setFinishedIfUndone

public boolean setFinishedIfUndone()

Declare that the future is finished.

addResultListener

public void addResultListener(IResultListener<Collection<E>> listener)

Add a result listener.

Specified by:

addResultListener in interface IFuture<Collection<E>>

Overrides:

addResultListener in class Future<Collection<E>>

Parameters:

listsner - 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(IFunctionalResultListener<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(IFunctionalResultListener<E> intermediateListener,
                                          IFunctionalResultListener<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(IFunctionalResultListener<E> intermediateListener,
                                          IFunctionalResultListener<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.

exListener - 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(ISuspendable sus)

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.