org.openbase.jul.pattern

Interface Controller<M>

Type Parameters:

M - Message

All Superinterfaces:

Activatable, Changeable, Pingable, Requestable<M>, Shutdownable

All Known Subinterfaces:

ConfigurableController<ID,M,CONFIG>, IdentifiableController<ID,M>

public interface Controller<M>
extends Shutdownable, Activatable, Changeable, Pingable, Requestable<M>

Author:

Divine Threepwood

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Controller.ControllerAvailabilityState

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

Shutdownable.ShutdownDeamon

Method Summary

Modifier and Type	Method and Description
Controller.ControllerAvailabilityState	getControllerAvailabilityState() Method returns the availability state of this controller.
M	getData()
Class<M>	getDataClass() Method returns the class of the internal data object which is used for remote synchronization.
void	notifyChange() Synchronize all registered remote instances about a data change.
void	waitForAvailabilityState(Controller.ControllerAvailabilityState controllerAvailabilityState) Wait until the controller reached a given availability state.

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

registerShutdownHook, registerShutdownHook, shutdown

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

activate, deactivate, isActive

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

ping

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

requestStatus

Method Detail

getData

M getData()
   throws CouldNotPerformException

Throws:

CouldNotPerformException

getDataClass

Class<M> getDataClass()

Method returns the class of the internal data object which is used for remote synchronization.

Returns:

data class

getControllerAvailabilityState

Controller.ControllerAvailabilityState getControllerAvailabilityState()

Method returns the availability state of this controller.

Returns:

OFFLINE / ONLINE

waitForAvailabilityState

void waitForAvailabilityState(Controller.ControllerAvailabilityState controllerAvailabilityState)
                       throws InterruptedException

Wait until the controller reached a given availability state.

Parameters:

controllerAvailabilityState - the state on which is waited

Throws:

InterruptedException - if the waiting is interrupted

notifyChange

void notifyChange()
           throws CouldNotPerformException,
                  InterruptedException

Synchronize all registered remote instances about a data change.

Specified by:

notifyChange in interface Changeable

Throws:

CouldNotPerformException - if the notification could not be performed

InterruptedException - if the notification has been interrupted