org.intellimate.izou.system.context

Interface EventsDistributor

public interface EventsDistributor

Version:

1.0

Author:

Leander Kurscheidt

Method Summary

Modifier and Type	Method and Description
void	fireEventConcurrently(EventModel<?> eventModel) fires the event concurrently, this is generally discouraged.
Identification	getManagerIdentification() returns the ID of the Manager (EventsDistributor)
Optional<EventCallable>	registerEventPublisher(Identification identification) with this method you can register EventPublisher add a Source of Events to the System.
void	registerEventsController(EventsControllerModel eventsController) Registers an EventController to control EventDispatching-Behaviour
void	unregisterEventPublisher(Identification identification) with this method you can unregister EventPublisher add a Source of Events to the System.
void	unregisterEventsController(EventsControllerModel eventsController) Unregisters an EventController

Method Detail

registerEventPublisher

Optional<EventCallable> registerEventPublisher(Identification identification)
                                        throws IllegalIDException

with this method you can register EventPublisher add a Source of Events to the System.

This method represents a higher level of abstraction! Use the EventManager to fire Events! This method is intended for use cases where you have an entire new source of events (e.g. network)

Parameters:

identification - the Identification of the Source

Returns:

An Optional Object which may or may not contains an EventPublisher

Throws:

IllegalIDException - not yet implemented

unregisterEventPublisher

void unregisterEventPublisher(Identification identification)

with this method you can unregister EventPublisher add a Source of Events to the System.

This method represents a higher level of abstraction! Use the EventManager to fire Events! This method is intended for use cases where you have an entire new source of events (e.g. network)

Parameters:

identification - the Identification of the Source

registerEventsController

void registerEventsController(EventsControllerModel eventsController)
                       throws IllegalIDException

Registers an EventController to control EventDispatching-Behaviour

Method is thread-safe. It is expected that this method executes quickly.

Parameters:

eventsController - the EventController Interface to control event-dispatching

Throws:

IllegalIDException - not yet implemented

unregisterEventsController

void unregisterEventsController(EventsControllerModel eventsController)

Unregisters an EventController

Method is thread-safe.

Parameters:

eventsController - the EventController Interface to remove

fireEventConcurrently

void fireEventConcurrently(EventModel<?> eventModel)

fires the event concurrently, this is generally discouraged.

This method should not be used for normal Events, for for events which obey the following laws:
1. they are time critical.
2. addons are not expected to react in any way beside a small update
3. they are few.
if your event matches the above laws, you may consider firing it concurrently.

Parameters:

eventModel - the EventModel

getManagerIdentification

Identification getManagerIdentification()

returns the ID of the Manager (EventsDistributor)

Returns:

an instance of Identification