org.intellimate.izou.events

Class LocalEventManager

java.lang.Object

org.intellimate.izou.util.IzouModule

org.intellimate.izou.events.LocalEventManager

All Implemented Interfaces:

Runnable, Identifiable, MainProvider

public class LocalEventManager
extends IzouModule
implements Runnable

This class is used to manage local events.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	LocalEventManager.EventCaller Class used to fire events.
static class	LocalEventManager.MultipleEventsException Deprecated.

Field Summary

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

log, main

Constructor Summary

Constructors

Constructor and Description
LocalEventManager(Main main)

Method Summary

Modifier and Type	Method and Description
void	fireEvent(EventModel event) This method fires an Event
Optional<EventCallable>	registerCaller(Identification identification) Registers with the EventManager to fire an event.
void	run()
void	stop() Should stop the EventManager.
void	unregisterCaller(Identification identification) Unregister with the EventManager.

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.identification.Identifiable

isOwner

Constructor Detail

LocalEventManager

public LocalEventManager(Main main)

Method Detail

registerCaller

public Optional<EventCallable> registerCaller(Identification identification)
                                       throws IllegalIDException

Registers with the EventManager 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

unregisterCaller

public void unregisterCaller(Identification identification)

Unregister with the EventManager. Method is thread-safe.

Parameters:

identification - the Identification of the the instance

fireEvent

public void fireEvent(EventModel event)
               throws IllegalIDException,
                      MultipleEventsException

This method fires an Event

Parameters:

event - the fired Event

Throws:

IllegalIDException - not yet implemented

MultipleEventsException - if there is currently another event getting processed

run

public void run()

Specified by:

run in interface Runnable

stop

public void stop()

Should stop the EventManager. The method run() is a while-loop that repeats itself as long as a variable isn't true. This sets the variable true but does NOT interrupt the execution! If its not processing, it is waiting for an event, so this Thread still may not stop without interruption.