org.intellimate.izou.events

Class EventDistributor

java.lang.Object

org.intellimate.izou.util.IzouModule

org.intellimate.izou.events.EventDistributor

All Implemented Interfaces:

Runnable, Identifiable, AddonThreadPoolUser, MainProvider

public class EventDistributor
extends IzouModule
implements Runnable, AddonThreadPoolUser

This class gets all the Events from all registered EventPublisher, generates Resources and passes them to the OutputManager. Can also be used to fire Events Concurrently.

Field Summary

Fields inherited from class org.intellimate.izou.util.IzouModule

log, main

Constructor Summary

Constructors

Constructor and Description
EventDistributor(Main main)

Method Summary

Modifier and Type	Method and Description
void	fireEventConcurrently(EventModel<?> eventModel) fires the event concurrently, this is generally discouraged.
BlockingQueue<EventModel<?>>	getEvents()
void	registerEventFinishedListener(EventModel event, EventListenerModel eventListener) Adds an listener for events that gets called when the event finished processing.
void	registerEventFinishedListener(List<String> ids, EventListenerModel eventListener) Adds an listener for events that gets called when the event finished processing.
void	registerEventListener(EventModel event, EventListenerModel eventListener) Adds an listener for events.
void	registerEventListener(List<String> ids, EventListenerModel eventListener) Adds an listener for events.
Optional<EventCallable>	registerEventPublisher(Identification identification) with this method you can register EventPublisher add a Source of Events to the System.
void	registerEventsController(EventsControllerModel controller) Registers an EventController to control EventDispatching-Behaviour
void	run() When an object implementing interface Runnable is used to create a thread, starting the thread causes the object's run method to be called in that separately executing thread.
void	stop() stops the EventDistributor
void	unregisterEventFinishedListener(EventListenerModel eventListener) unregister an EventListener that got called when the event finished processing.
void	unregisterEventFinishedListener(EventModel<EventModel> event, EventListenerModel eventListener) unregister an EventListener that got called when the event finished processing.
void	unregisterEventListener(EventListenerModel eventListener) unregister an EventListener It will unregister for all registered descriptors.
void	unregisterEventListener(EventModel<EventModel> event, EventListenerModel eventListener) unregister an EventListener It will unregister for all Descriptors individually! It will also ignore if this listener is not listening to an Event.
void	unregisterEventPublisher(Identification identification) with this method you can unregister EventPublisher add a Source of Events to the System.
void	unregisterEventsController(EventsControllerModel controller) Unregisters an EventController

Methods inherited from class org.intellimate.izou.util.IzouModule

debug, debug, error, error, fatal, fatal, getID, getMain

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.intellimate.izou.util.AddonThreadPoolUser

submit, submit, timeOut

Methods inherited from interface org.intellimate.izou.util.MainProvider

debug, debug, error, error, fatal, fatal, getMain

Methods inherited from interface org.intellimate.izou.identification.Identifiable

isOwner

Constructor Detail

EventDistributor

public EventDistributor(Main main)

Method Detail

fireEventConcurrently

public 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

registerEventPublisher

public 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

public 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

public void registerEventsController(EventsControllerModel controller)
                              throws IllegalIDException

Registers an EventController to control EventDispatching-Behaviour

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

Parameters:

controller - the EventController Interface to control event-dispatching

Throws:

IllegalIDException - not yet implemented

unregisterEventsController

public void unregisterEventsController(EventsControllerModel controller)

Unregisters an EventController

Method is thread-safe.

Parameters:

controller - the EventController Interface to remove

registerEventListener

public void registerEventListener(EventModel event,
                                  EventListenerModel eventListener)
                           throws IllegalIDException

Adds an listener for events.

Be careful with this method, it will register the listener for ALL the informations found in the Event. If your event-type is a common event type, it will fire EACH time!. It will also register for all Descriptors individually! It will also ignore if this listener is already listening to an Event. Method is thread-safe.

Parameters:

event - the Event to listen to (it will listen to all descriptors individually!)

eventListener - the ActivatorEventListener-interface for receiving activator events

Throws:

IllegalIDException - not yet implemented

registerEventListener

public void registerEventListener(List<String> ids,
                                  EventListenerModel eventListener)

Adds an listener for events.

It will register for all ids individually! This method will ignore if this listener is already listening to an Event. Method is thread-safe.

Parameters:

ids - this can be type, or descriptors etc.

eventListener - the ActivatorEventListener-interface for receiving activator events

unregisterEventListener

public void unregisterEventListener(EventModel<EventModel> event,
                                    EventListenerModel eventListener)
                             throws IllegalArgumentException

unregister an EventListener It will unregister for all Descriptors individually! It will also ignore if this listener is not listening to an Event. Method is thread-safe.

Parameters:

event - the Event to stop listen to

eventListener - the ActivatorEventListener used to listen for events

Throws:

IllegalArgumentException - if Listener is already listening to the Event or the id is not allowed

unregisterEventListener

public void unregisterEventListener(EventListenerModel eventListener)
                             throws IllegalArgumentException

unregister an EventListener It will unregister for all registered descriptors. It will also ignore if this listener is not listening to an Event. Method is thread-safe.

Parameters:

eventListener - the ActivatorEventListener used to listen for events

Throws:

IllegalArgumentException - if Listener is already listening to the Event or the id is not allowed

registerEventFinishedListener

public void registerEventFinishedListener(EventModel event,
                                          EventListenerModel eventListener)
                                   throws IllegalIDException

Adds an listener for events that gets called when the event finished processing.

Be careful with this method, it will register the listener for ALL the informations found in the Event. If your event-type is a common event type, it will fire EACH time!. It will also register for all Descriptors individually! It will also ignore if this listener is already listening to an Event. Method is thread-safe.

Parameters:

event - the Event to listen to (it will listen to all descriptors individually!)

eventListener - the ActivatorEventListener-interface for receiving activator events

Throws:

IllegalIDException - not yet implemented

registerEventFinishedListener

public void registerEventFinishedListener(List<String> ids,
                                          EventListenerModel eventListener)

Adds an listener for events that gets called when the event finished processing.

It will register for all ids individually! This method will ignore if this listener is already listening to an Event. Method is thread-safe.

Parameters:

ids - this can be type, or descriptors etc.

eventListener - the ActivatorEventListener-interface for receiving activator events

unregisterEventFinishedListener

public void unregisterEventFinishedListener(EventModel<EventModel> event,
                                            EventListenerModel eventListener)
                                     throws IllegalArgumentException

unregister an EventListener that got called when the event finished processing. It will unregister for all Descriptors individually! It will also ignore if this listener is not listening to an Event. Method is thread-safe.

Parameters:

event - the Event to stop listen to

eventListener - the ActivatorEventListener used to listen for events

Throws:

IllegalArgumentException - if Listener is already listening to the Event or the id is not allowed

unregisterEventFinishedListener

public void unregisterEventFinishedListener(EventListenerModel eventListener)
                                     throws IllegalArgumentException

unregister an EventListener that got called when the event finished processing. It will unregister for all registered descriptors. It will also ignore if this listener is not listening to an Event. Method is thread-safe.

Parameters:

eventListener - the ActivatorEventListener used to listen for events

Throws:

IllegalArgumentException - if Listener is already listening to the Event or the id is not allowed

getEvents

public BlockingQueue<EventModel<?>> getEvents()

run

public void run()

When an object implementing interface Runnable is used to create a thread, starting the thread causes the object's run method to be called in that separately executing thread.

The general contract of the method run is that it may take any action whatsoever.

Specified by:

run in interface Runnable

See Also:

Thread.run()

stop

public void stop()

stops the EventDistributor