jadex.commons.future

Interface IIntermediateFuture<E>

All Superinterfaces:

IFuture<Collection<E>>

All Known Subinterfaces:

ISubscriptionIntermediateFuture<E>, ITerminableIntermediateFuture<E>

All Known Implementing Classes:

IntermediateFuture, SubscriptionIntermediateDelegationFuture, SubscriptionIntermediateFuture, TerminableIntermediateDelegationFuture, TerminableIntermediateFuture

public interface IIntermediateFuture<E>
extends IFuture<Collection<E>>

Future that support intermediate results.

Field Summary

Fields

Modifier and Type	Field and Description
static IntermediateFuture<Void>	DONE A future representing a completed action.

Method Summary

Methods

Modifier and Type	Method and Description
Collection<E>	getIntermediateResults() Get the intermediate results that are currently available.
E	getNextIntermediateResult(ISuspendable caller) Iterate over the intermediate results in a blocking fashion.
boolean	hasNextIntermediateResult(ISuspendable caller) Check if there are more results for iteration for the given caller.

Methods inherited from interface jadex.commons.future.IFuture

addResultListener, get, get, getException, isDone

Field Detail

DONE

static final IntermediateFuture<Void> DONE

A future representing a completed action. Can be used as direct return value of methods that do not perform asynchronous operations and do not return a result value.

Method Detail

getIntermediateResults

Collection<E> getIntermediateResults()

Get the intermediate results that are currently available. Non-blocking method.

Returns:

The future result.

hasNextIntermediateResult

boolean hasNextIntermediateResult(ISuspendable caller)

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

Parameters:

caller - The caller that wants to iterate over intermediate results.

Returns:

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

getNextIntermediateResult

E getNextIntermediateResult(ISuspendable caller)

Iterate over the intermediate results in a blocking fashion. Manages results independently for different callers, i.e. when called with different suspendables, each suspendable receives all intermediate results.

Parameters:

caller - The caller that wants to iterate over intermediate results.

Returns:

The next intermediate result.

Throws:

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