org.openbase.jul.pattern

Interface Observable<T>

Type Parameters:

T - the data type on whose changes is notified

All Superinterfaces:

Shutdownable

All Known Implementing Classes:

AbstractObservable, ObservableImpl

public interface Observable<T>
extends Shutdownable

* @author Tamino Huxohl

Nested Class Summary

Nested classes/interfaces inherited from interface org.openbase.jul.iface.Shutdownable

Shutdownable.ShutdownDeamon

Method Summary

Modifier and Type	Method and Description
void	addObserver(Observer<T> observer) Method registers the given observer to this observable to get informed about value changes.
default T	getLatestValue() Deprecated. please use getValue() instead.
T	getValue() Method returns the latest observable value.
Future<T>	getValueFuture() Method returns a Future object which represents the value availability.
boolean	isValueAvailable() Checks if a value was ever notified.
void	removeObserver(Observer<T> observer) Method removes the given observer from this observable to finish the observation.
default void	waitForValue() Method blocks until the observable is available.
void	waitForValue(long timeout, TimeUnit timeUnit) Method blocks until the observable is available.

Methods inherited from interface org.openbase.jul.iface.Shutdownable

registerShutdownHook, registerShutdownHook, shutdown

Method Detail

waitForValue

void waitForValue(long timeout,
                  TimeUnit timeUnit)
           throws CouldNotPerformException,
                  InterruptedException

Method blocks until the observable is available. In case the given timeout is reached an TimeoutException is thrown.

Parameters:

timeout - is the timeout related to the given TimeUnit.

timeUnit - is the unit of the timeout.

Throws:

InterruptedException - is thrown if the current thread was interrupted externally.

CouldNotPerformException - is thrown with a TimeoutException cause if the given timeout is reached.

waitForValue

default void waitForValue()
                   throws CouldNotPerformException,
                          InterruptedException

Method blocks until the observable is available.

Throws:

CouldNotPerformException - is thrown if an error occurs before the thread was blocked.

InterruptedException - is thrown if the current thread was interrupted externally.

addObserver

void addObserver(Observer<T> observer)

Method registers the given observer to this observable to get informed about value changes.

Parameters:

observer - is the observer to register.

removeObserver

void removeObserver(Observer<T> observer)

Method removes the given observer from this observable to finish the observation.

Parameters:

observer - is the observer to remove.

getValue

T getValue()
    throws NotAvailableException

Method returns the latest observable value.

Returns:

the latest value of the observable.

Throws:

NotAvailableException

getValueFuture

Future<T> getValueFuture()

Method returns a Future object which represents the value availability.

Returns:

a future object providing the value.

isValueAvailable

boolean isValueAvailable()

Checks if a value was ever notified.

Returns:

true if the value is available.

getLatestValue

@Deprecated
default T getLatestValue()
                              throws NotAvailableException

Deprecated. please use getValue() instead.

Method returns the latest observable value.

Returns:

Throws:

NotAvailableException