org.openbase.jul.schedule

Class AbstractSynchronizationFuture<T>

java.lang.Object

org.openbase.jul.schedule.AbstractSynchronizationFuture<T>

Type Parameters:

T - The return type of the internal future.

All Implemented Interfaces:

Future<T>

public abstract class AbstractSynchronizationFuture<T>
extends Object
implements Future<T>

The synchronization future is used to guarantee that the change done by the internal future has at one time been synchronized.

Author:

pleminoq

Constructor Summary

Constructors

Constructor and Description
AbstractSynchronizationFuture(Future<T> internalFuture, DataProvider dataProvider)

Method Summary

Modifier and Type	Method and Description
protected abstract void	addObserver(Observer observer) Called to add an observer to the component whose synchronization is waited for by this future.
protected abstract void	beforeWaitForSynchronization() Called before the synchronization task enters its loop.
boolean	cancel(boolean mayInterruptIfRunning)
protected abstract boolean	check(T message) Called inside of the synchronization loop to check if the synchronization is complete.
T	get()
T	get(long timeout, TimeUnit unit)
Future<T>	getInternalFuture()
boolean	isCancelled()
boolean	isDone()
protected abstract void	removeObserver(Observer observer) Remove the notify change observer from the component whose synchronization is waited for after the synchronization is complete or failed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractSynchronizationFuture

public AbstractSynchronizationFuture(Future<T> internalFuture,
                                     DataProvider dataProvider)

Method Detail

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<T>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<T>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<T>

get

public T get()
      throws InterruptedException,
             ExecutionException

Specified by:

get in interface Future<T>

Throws:

InterruptedException

ExecutionException

get

public T get(long timeout,
             TimeUnit unit)
      throws InterruptedException,
             ExecutionException,
             TimeoutException

Specified by:

get in interface Future<T>

Throws:

InterruptedException

ExecutionException

TimeoutException

getInternalFuture

public Future<T> getInternalFuture()

addObserver

protected abstract void addObserver(Observer observer)

Called to add an observer to the component whose synchronization is waited for by this future. This is done in this way because sometimes the change is notified through a normal observer and sometime by a data observer so the internal call changes.

Parameters:

observer - In this case always the notify change observer that is added.

removeObserver

protected abstract void removeObserver(Observer observer)

Remove the notify change observer from the component whose synchronization is waited for after the synchronization is complete or failed.

Parameters:

observer - In this case always the notify change observer that is added.

beforeWaitForSynchronization

protected abstract void beforeWaitForSynchronization()
                                              throws CouldNotPerformException

Called before the synchronization task enters its loop. Can for example be used to wait for initial data so that the check that is done afterwards in the loop does not fail immediately.

Throws:

CouldNotPerformException - if something goes wrong

check

protected abstract boolean check(T message)
                          throws CouldNotPerformException

Called inside of the synchronization loop to check if the synchronization is complete.

Parameters:

message - the return value of the internal future

Returns:

true if the synchronization is complete and else false

Throws:

CouldNotPerformException - it something goes wrong in the check