Package com.atlassian.plugin.event

Interface PluginEventManager

public interface PluginEventManager
Defines the event manager for use with internal Atlassian Plugins framework events. How listeners are defined is up to the implementation. Implementations should allow listeners to somehow identify which events they would like to listen for, then have the appropriate methods called if the event is the desired class or a subclass/implementation. This means a listener could listen for an event of type java.lang.Object and should be notified for every event.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    broadcast(Object event)
    Broadcasts an event to all applicable listeners.
    void
    register(Object listener)
    Registers a listener object
    void
    unregister(Object listener)
    Unregisters a listener object

  • Method Details

    • register

      void register(Object listener)
      Registers a listener object
      Parameters:
      listener - The listener instance. Cannot be null.

    • unregister

      void unregister(Object listener)
      Unregisters a listener object
      Parameters:
      listener - The listener. Cannot be null.

    • broadcast

      void broadcast(Object event)
      Broadcasts an event to all applicable listeners.
      Parameters:
      event - The event object. Cannot be null.
      Throws:
      NotificationException - If an exception is thrown by one of the Event Listeners.