Module io.github.tonywasher.joceanus.oceanus
Package io.github.tonywasher.joceanus.oceanus.event

Class OceanusEventManager<E extends Enum<E>>

java.lang.Object
io.github.tonywasher.joceanus.oceanus.event.OceanusEventManager<E>
Type Parameters:
E - The event id type
All Implemented Interfaces:
OceanusEventRegistrar.OceanusEventProvider<E>
public class OceanusEventManager<E extends Enum<E>> extends Object implements OceanusEventRegistrar.OceanusEventProvider<E>
EventManager implementation. This provides means for classes to fire events to registered listeners.

  • Constructor Details

    • OceanusEventManager

      public OceanusEventManager()
      Constructor.

  • Method Details

    • getManagerId

      public Integer getManagerId()
      Obtain ownerId.
      Returns:
      the owner Id

    • getEventRegistrar

      public OceanusEventRegistrar<E> getEventRegistrar()
      Description copied from interface: OceanusEventRegistrar.OceanusEventProvider
      Obtain registration object for listeners.
      Specified by:
      getEventRegistrar in interface OceanusEventRegistrar.OceanusEventProvider<E extends Enum<E>>
      Returns:
      the registrar

    • cascadeEvent

      public void cascadeEvent(OceanusEvent<E> pEvent)
      Cascade action event.
      Parameters:
      pEvent - the event to cascade

    • fireEvent

      public boolean fireEvent(E pEventId)
      Fire Event to all registered listeners.
      Parameters:
      pEventId - the eventId of the event
      Returns:
      was the event consumed?

    • fireEvent

      public boolean fireEvent(E pEventId, Object pDetails)
      Fire Event to all registered listeners.
      Parameters:
      pEventId - the eventId of the event
      pDetails - the details of the event
      Returns:
      was the event left unconsumed? true/false