Package civitas.celestis.event.lifecycle

Interface EventManager

All Superinterfaces:
Module
All Known Implementing Classes:
EventThread, SyncEventManager
public interface EventManager extends Module
An event manager handles the lifecycle of events and event listeners. Events are processed by calling an event by means of call(Handleable), and event listeners can be registered and unregistered by their respective methods.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    <E extends Handleable>
    void
    call(E event)
    Calls an event to this event manager, instructing it to process the event as soon as possible.
    <E extends Handleable>
    void
    priorityCall(E event)
    Calls an event to this event manager, instructing it to prioritize this event over all other events currently in the event queue.
    void
    register(Listener listener)
    Registers an event listener to this event manager.
    void
    register(Iterable<? extends Listener> listeners)
    Registers multiple event listeners to this event manager.
    void
    unregister(Listener listener)
    Unregisters an event listener from this event manager.
    void
    unregister(Iterable<? extends Listener> listeners)
    Unregisters multiple event listeners from this event manager.

    Methods inherited from interface civitas.celestis.util.Module

    initialize, interrupt, start, terminate

  • Method Details

    • call

      <E extends Handleable> void call(@Nonnull E event)
      Calls an event to this event manager, instructing it to process the event as soon as possible.
      Type Parameters:
      E - The type of event to handle
      Parameters:
      event - The event of which to handle

    • priorityCall

      <E extends Handleable> void priorityCall(@Nonnull E event)
      Calls an event to this event manager, instructing it to prioritize this event over all other events currently in the event queue.
      Type Parameters:
      E - The type of event to prioritize
      Parameters:
      event - THe event of which to prioritize

    • register

      void register(@Nonnull Listener listener)
      Registers an event listener to this event manager.
      Parameters:
      listener - The event listener to register to this event manager

    • register

      void register(@Nonnull Iterable<? extends Listener> listeners)
      Registers multiple event listeners to this event manager.
      Parameters:
      listeners - The iterable object containing the listeners to register

    • unregister

      void unregister(@Nonnull Listener listener)
      Unregisters an event listener from this event manager.
      Parameters:
      listener - The event listener to unregister from this event manager

    • unregister

      void unregister(@Nonnull Iterable<? extends Listener> listeners)
      Unregisters multiple event listeners from this event manager.
      Parameters:
      listeners - The iterable object containing the listeners to unregister