IntermediateDelegationResultListener (Jadex Active Component Platform 3.0.0-RC63 API)

java.lang.Object
- jadex.commons.future.IntermediateDelegationResultListener<E>

All Implemented Interfaces:

IFunctionalExceptionListener, IFunctionalResultListener<java.util.Collection<E>>, IFutureCommandListener, IIntermediateResultListener<E>, IResultListener<java.util.Collection<E>>, IUndoneIntermediateResultListener<E>, IUndoneResultListener<java.util.Collection<E>>

Direct Known Subclasses:

DefaultServiceFetcher.StoreIntermediateDelegationResultListener, SServiceProvider.IntermediateProxyResultListener, TerminableIntermediateDelegationResultListener
```
public class IntermediateDelegationResultListener<E>
extends java.lang.Object
implements IIntermediateResultListener<E>, IFutureCommandListener, IUndoneIntermediateResultListener<E>
```
Intermediate version of the delegation result listener.

Field Summary

Fields
Modifier and Type	Field and Description
`protected IFunctionalResultListener<E>`	`customIntermediateResultListener` Custom functional result listener
`protected IntermediateFuture<E>`	`future` The future to which calls are delegated.
`protected boolean`	`undone` Flag if undone methods should be used.

Constructor Summary

Constructors
Constructor and Description
`IntermediateDelegationResultListener(IntermediateFuture<E> future)` Create a new listener.
`IntermediateDelegationResultListener(IntermediateFuture<E> future, boolean undone)` Create a new listener.
`IntermediateDelegationResultListener(IntermediateFuture<E> future, boolean undone, IFunctionalResultListener<E> customIntermediateResultListener)` Create a new listener.
`IntermediateDelegationResultListener(IntermediateFuture<E> future, IFunctionalResultListener<E> customIntermediateResultListener)` Create a new listener.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`commandAvailable(java.lang.Object command)` Called when a command is available.
`void`	`customIntermediateResultAvailable(E result)` Called when an intermediate result is available.
`void`	`customResultAvailable(java.util.Collection<E> result)` Called when the result is available.
`void`	`exceptionOccurred(java.lang.Exception exception)` Called when an exception occurred.
`void`	`exceptionOccurredIfUndone(java.lang.Exception exception)` Called when an exception occurred.
`void`	`finished()` Declare that the future is finished.
`void`	`finishedIfUndone()` Declare that the future is finished.
`void`	`intermediateResultAvailable(E result)` Called when an intermediate result is available.
`void`	`intermediateResultAvailableIfUndone(E result)` Called when an intermediate result is available.
`void`	`resultAvailable(java.util.Collection<E> result)` Called when the result is available.
`void`	`resultAvailableIfUndone(java.util.Collection<E> result)` Called when the result is available.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - future
```
protected IntermediateFuture<E> future
```
    The future to which calls are delegated.
  - undone
```
protected boolean undone
```
    Flag if undone methods should be used.
  - customIntermediateResultListener
```
protected IFunctionalResultListener<E> customIntermediateResultListener
```
    Custom functional result listener
- Constructor Detail
  - IntermediateDelegationResultListener
```
public IntermediateDelegationResultListener(IntermediateFuture<E> future,
                                            IFunctionalResultListener<E> customIntermediateResultListener)
```
    Create a new listener.
    
    Parameters:
    
    future - The delegation target.
    
    undone - use undone methods.
    
    customResultListener - Custom result listener that overwrites the delegation behaviour.
  - IntermediateDelegationResultListener
```
public IntermediateDelegationResultListener(IntermediateFuture<E> future,
                                            boolean undone,
                                            IFunctionalResultListener<E> customIntermediateResultListener)
```
    Create a new listener.
    
    Parameters:
    
    future - The delegation target.
    
    undone - use undone methods.
    
    customResultListener - Custom result listener that overwrites the delegation behaviour. Can be null
  - IntermediateDelegationResultListener
```
public IntermediateDelegationResultListener(IntermediateFuture<E> future)
```
    Create a new listener.
  - IntermediateDelegationResultListener
```
public IntermediateDelegationResultListener(IntermediateFuture<E> future,
                                            boolean undone)
```
    Create a new listener.
- Method Detail
  - resultAvailable
```
public final void resultAvailable(java.util.Collection<E> result)
```
    Called when the result is available.
    
    Specified by:
    
    resultAvailable in interface IFunctionalResultListener<java.util.Collection<E>>
    
    Specified by:
    
    resultAvailable in interface IIntermediateResultListener<E>
    
    Parameters:
    
    result - The result.
  - intermediateResultAvailable
```
public final void intermediateResultAvailable(E result)
```
    Called when an intermediate result is available.
    
    Specified by:
    
    intermediateResultAvailable in interface IIntermediateResultListener<E>
    
    Parameters:
    
    result - The result.
  - finished
```
public void finished()
```
    Declare that the future is finished.
    
    Specified by:
    
    finished in interface IIntermediateResultListener<E>
  - customResultAvailable
```
public void customResultAvailable(java.util.Collection<E> result)
```
    Called when the result is available.
    
    Parameters:
    
    result - The result.
  - exceptionOccurred
```
public void exceptionOccurred(java.lang.Exception exception)
```
    Called when an exception occurred.
    
    Specified by:
    
    exceptionOccurred in interface IFunctionalExceptionListener
    
    Parameters:
    
    exception - The exception.
  - customIntermediateResultAvailable
```
public void customIntermediateResultAvailable(E result)
```
    Called when an intermediate result is available.
    
    Parameters:
    
    result - The result.
  - commandAvailable
```
public void commandAvailable(java.lang.Object command)
```
    Called when a command is available.
    
    Specified by:
    
    commandAvailable in interface IFutureCommandListener
  - resultAvailableIfUndone
```
public void resultAvailableIfUndone(java.util.Collection<E> result)
```
    Called when the result is available.
    
    Specified by:
    
    resultAvailableIfUndone in interface IUndoneResultListener<java.util.Collection<E>>
    
    Parameters:
    
    result - The result.
  - exceptionOccurredIfUndone
```
public void exceptionOccurredIfUndone(java.lang.Exception exception)
```
    Called when an exception occurred.
    
    Specified by:
    
    exceptionOccurredIfUndone in interface IUndoneResultListener<java.util.Collection<E>>
    
    Parameters:
    
    exception - The exception.
  - intermediateResultAvailableIfUndone
```
public void intermediateResultAvailableIfUndone(E result)
```
    Called when an intermediate result is available.
    
    Specified by:
    
    intermediateResultAvailableIfUndone in interface IUndoneIntermediateResultListener<E>
    
    Parameters:
    
    result - The result.
  - finishedIfUndone
```
public void finishedIfUndone()
```
    Declare that the future is finished. This method is only called for intermediate futures, i.e. when this method is called it is guaranteed that the intermediateResultAvailable method was called for all intermediate results before.
    
    Specified by:
    
    finishedIfUndone in interface IUndoneIntermediateResultListener<E>

Class IntermediateDelegationResultListener<E>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

future

undone

customIntermediateResultListener

Constructor Detail

IntermediateDelegationResultListener

IntermediateDelegationResultListener

IntermediateDelegationResultListener

IntermediateDelegationResultListener

Method Detail

resultAvailable

intermediateResultAvailable

finished

customResultAvailable

exceptionOccurred

customIntermediateResultAvailable

commandAvailable

resultAvailableIfUndone

exceptionOccurredIfUndone

intermediateResultAvailableIfUndone

finishedIfUndone