com.googlecode.sarasvati.event.ExecutionEventQueue Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sarasvati-core Show documentation
The newest version!
/*
    This file is part of Sarasvati.

    Sarasvati is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as
    published by the Free Software Foundation, either version 3 of the
    License, or (at your option) any later version.

    Sarasvati is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with Sarasvati.  If not, see .

    Copyright 2008 Paul Lorenz
*/
package com.googlecode.sarasvati.event;

import com.googlecode.sarasvati.Engine;

/**
 * An ExecutionEventQueue manages a set of {@link ExecutionListener}s. It handles
 * adding and removing listeners as well as sending events to the appropriate
 * listeners.
 *
 * @author Paul Lorenz
 */
public interface ExecutionEventQueue
{
  /**
   * Adds the given listener type to the event queue for the given event types using the given engine.
   *
   * @param engine The engine being used
   * @param listenerClass The type of listener to add
   * @param eventTypes The event types the listener should receive event notifications for
   */
  void addListener (Engine engine,
                    Class listenerClass,
                    ExecutionEventType... eventTypes);

  /**
   * Removes the given listener type from the event queue for the given event types using the given engine.
   *
   * @param engine The engine being used
   * @param listenerClass The type of listener to add
   * @param eventTypes The event types the listener should receive event notifications for
   */
  void removeListener (Engine engine,
                       Class listenerClass,
                       ExecutionEventType... eventTypes);

  /**
   * Sends the event to the appropriate listeners.
   *
   * @param event The execution event
   */
  EventActions fireEvent (ExecutionEvent event);
}