org.intellimate.izou.system.context

Interface Events

public interface Events

Version:

1.0

Author:

Leander Kurscheidt

Method Summary

Modifier and Type	Method and Description
EventsDistributor	distributor() returns the API for the EventsDistributor
void	fireEvent(EventModel event) This method fires an Event
Identification	getManagerIdentification() returns the ID of the Manager (LocalEventManager)
Optional<EventCallable>	registerEventCaller(Identification identification) Registers with the LocalEventManager to fire an event.
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 that gets called before the generation of the resources and the outputPlugins..
void	registerEventListener(List<String> ids, EventListenerModel eventListener) Adds an listener for events that gets called before the generation of the resources and the outputPlugins..
void	unregisterEventCaller(Identification identification) Unregister with the LocalEventManager.
void	unregisterEventFinishedListener(EventListenerModel eventListener) unregister an EventListener that got called when the event finished processing.
void	unregisterEventFinishedListener(EventModel event, EventListenerModel eventListener) unregister an EventListener that got called when the event finished processing.
void	unregisterEventListener(EventListenerModel eventListener) unregister an EventListener that gets called before the generation of the resources and the outputPlugins.
void	unregisterEventListener(EventModel event, EventListenerModel eventListener) unregister an EventListener that gets called before the generation of the resources and the outputPlugins.

Method Detail

registerEventListener

void registerEventListener(EventModel event,
                           EventListenerModel eventListener)
                    throws IllegalIDException

Adds an listener for events that gets called before the generation of the resources and the outputPlugins..

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

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

Adds an listener for events that gets called before the generation of the resources and the outputPlugins..

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

void unregisterEventListener(EventModel event,
                             EventListenerModel eventListener)

unregister an EventListener that gets called before the generation of the resources and the outputPlugins.

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

void unregisterEventListener(EventListenerModel eventListener)

unregister an EventListener that gets called before the generation of the resources and the outputPlugins.

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:

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

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

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

void unregisterEventFinishedListener(EventModel event,
                                     EventListenerModel eventListener)

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

void unregisterEventFinishedListener(EventListenerModel eventListener)

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:

eventListener - the ActivatorEventListener used to listen for events

Throws:

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

registerEventCaller

Optional<EventCallable> registerEventCaller(Identification identification)
                                     throws IllegalIDException

Registers with the LocalEventManager to fire an event.

Note: the same Event can be fired from multiple sources. Method is thread-safe.

Parameters:

identification - the Identification of the the instance

Returns:

an Optional, empty if already registered

Throws:

IllegalIDException - not yet implemented

unregisterEventCaller

void unregisterEventCaller(Identification identification)

Unregister with the LocalEventManager.

Method is thread-safe.

Parameters:

identification - the Identification of the the instance

fireEvent

void fireEvent(EventModel event)
        throws IllegalIDException,
               MultipleEventsException

This method fires an Event

Parameters:

event - the fired Event

Throws:

IllegalAccessError - not yet implemented

IllegalIDException - not yet implemented

MultipleEventsException - if there is currently another Event processing

distributor

EventsDistributor distributor()

returns the API for the EventsDistributor

Returns:

Distributor

getManagerIdentification

Identification getManagerIdentification()

returns the ID of the Manager (LocalEventManager)

Returns:

an instance of Identification