jadex.commons.future

Class IntermediateFuture<E>

java.lang.Object

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

jadex.commons.future.IntermediateFuture<E>

All Implemented Interfaces:

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

Direct Known Subclasses:

ComponentIntermediateFuture

public class IntermediateFuture<E>
extends Future<Collection<E>>
implements IIntermediateFuture<E>

Default implementation of an intermediate future.

Field Summary

Fields inherited from class jadex.commons.future.Future

DEBUG, EMPTY

Fields inherited from interface jadex.commons.future.IFuture

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.

Method Summary

Methods

Modifier and Type	Method and Description
void	addIntermediateResult(E result) Add an intermediate result.
void	addResultListener(IResultListener<Collection<E>> listener) Add a result listener.
Collection	getIntermediateResults() Get the intermediate results that are available.
void	setFinished() Declare that the future is finished.
void	setResult(Collection<E> result) Set the result.
void	setResultIfUndone(Collection<E> result) Set the result.

Methods inherited from class jadex.commons.future.Future

get, get, getEmptyFuture, isDone, main, 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

get, get, 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.

Method Detail

getIntermediateResults

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

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

setFinished

public void setFinished()

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.