org.openbase.jul.pattern.provider

Interface DataProvider<D>

Type Parameters:

D -

All Known Subinterfaces:

ConfigurableRemote<ID,M,CONFIG>, IdentifiableRemote<ID,M>, Remote<M>

public interface DataProvider<D>

Author:

Divine Threepwood

Method Summary

Modifier and Type	Method and Description
void	addDataObserver(Observer<D> observer) This method allows the registration of data observers to get informed about data updates.
D	getData() Method returns the data object of this instance.
Class<D>	getDataClass() Method returns the class of the data object.
CompletableFuture<D>	getDataFuture() Returns a future of the data object.
boolean	isDataAvailable() Check if the data object is already available.
void	removeDataObserver(Observer<D> observer) This method removes already registered data observers.
void	waitForData() Method blocks until an initial data is available.
void	waitForData(long timeout, TimeUnit timeUnit) Method blocks until an initial data is available or the given timeout is reached.

Method Detail

isDataAvailable

boolean isDataAvailable()

Check if the data object is already available.

Returns:

if data is available

getDataClass

Class<D> getDataClass()

Method returns the class of the data object.

Returns:

the class of the data object

getData

D getData()
   throws NotAvailableException

Method returns the data object of this instance. In case the data is not available a NotAvailableException is thrown.

Returns:

the data object.

Throws:

NotAvailableException - is thrown in case the data is not available.

getDataFuture

CompletableFuture<D> getDataFuture()

Returns a future of the data object. The future can be used to wait for the data object.

Returns:

a future object delivering the data if available.

addDataObserver

void addDataObserver(Observer<D> observer)

This method allows the registration of data observers to get informed about data updates.

Parameters:

observer - the observer added

removeDataObserver

void removeDataObserver(Observer<D> observer)

This method removes already registered data observers.

Parameters:

observer - the observer removed

waitForData

void waitForData()
          throws CouldNotPerformException,
                 InterruptedException

Method blocks until an initial data is available.

Throws:

CouldNotPerformException - is thrown if any error occurs.

InterruptedException - is thrown in case the thread is externally interrupted.

waitForData

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

Method blocks until an initial data is available or the given timeout is reached.

Parameters:

timeout - maximal time to wait for the data. After the timeout is reached a NotAvailableException is thrown which is caused by a TimeoutException.

timeUnit - the time unit of the timeout.

Throws:

NotAvailableException - is thrown in case the any error occurs, or if the given timeout is reached. In this case a TimeoutException is thrown.

InterruptedException - is thrown in case the thread is externally interrupted.

CouldNotPerformException