Package rsb.event

Class EventMulticaster

java.lang.Object
rsb.event.EventMulticaster
All Implemented Interfaces:
EventListener
public class EventMulticaster extends Object implements EventListener

  • Field Details

  • Constructor Details

    • EventMulticaster

      public EventMulticaster()

  • Method Details

    • getDefaultMask

      public static long getDefaultMask(EventListener el)
      Gets the default mask for an event listener.
      Parameters:
      el - an EventListener
      Returns:
      the integer value representing the mask for this object

    • getDefaultMask

      public static long getDefaultMask(EventObject e)
      Gets the default mask for an event.
      Parameters:
      e - an EventObject
      Returns:
      the integer value representing the mask for this object

    • addListener

      public void addListener(EventListener el)
      Adds the listener to the tree with a default mask.
      Parameters:
      el - an EventListener to add

    • addListener

      public void addListener(EventListener el, long mask)
      Adds the listener with the specified mask. If it is an EventMulticaster the specified mask will be ignored.
      Parameters:
      el - an EventListener to add
      mask - a mask to assign to the EventListener

    • fireEvent

      public void fireEvent(EventObject e)
      Fires an event to all applicable listeners.
      Parameters:
      e - an EventObject to trigger

    • fireEvent

      public void fireEvent(EventObject e, long mask)
      Fires an event to all listeners, restricted by the mask.
      Parameters:
      e - an EventObject to trigger
      mask - a mask to act as a filter to prevent unwanted firing

    • getEnabledMask

      public long getEnabledMask()
      Gets the masks enabled for this multicaster.
      Returns:
      the mask for the multicaster

    • getListeners

      public List<EventListener> getListeners()
      Returns an unmodifiable list of the backing list of listeners.
      Returns:
      the listeners on this multicaster

    • isEnabled

      public final boolean isEnabled(long mask)
      Returns whether the mask is enabled on this multicaster.
      Parameters:
      mask - the mask to check for on the multicaster
      Returns:
      true if the mask is found; otherwise false

    • removeListener

      public void removeListener(EventListener el)
      Removes a listener. Cleans up the masks.
      Parameters:
      el - an EventListener to remove