org.objectweb.celtix.BusEventCache Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of celtix-api Show documentation
The newest version!
package org.objectweb.celtix;

import java.util.*;


/**
 * Caches all bus events that do not have a listener associated with them.
 * The bus events will be stored until the cache limit is reached.
 * After reaching the cache size, events will be discarded using first in,
 * first out semantics.
 */
public interface BusEventCache {
    /**
     * Add the BusEvent to the cache.
     * If the maximum size of the cache is reached, the first BusEvent
     * added will be removed from the cache(FIFO)
     * @param e The BusEvent to be added to the cache.
     */
    void addEvent(BusEvent e);


    /**
     * Flushes the cache of all the BusEvent.
     * @return List Containing all the BusEvents cached.
     */
    List flushEvents();


    /**
     * Flushes the BusEvent from the cache matching the event id.
     * @param eventID The unique event id that identifies the BusEvent.
     * @return List Containing all BusEvents matching the event id.
     */
    List flushEvents(String eventID);


    /**
     * Flushes the BusEvent from the cache matching the event class.
     * @param eventClass The class of the event that identifies the BusEvent.
     * @return List Containing all BusEvents matching the event class.
     */
    List flushEvents(Class eventClass);

    /**
     * Returns all the bus events. This method doesn't remove the
     * events from the cache.
     * @return List Containing all bus events stored in the cache.
     */
    List getEvents();


    /**
     * Returns all the bus events matching the event id. This method doesn't
     * remove the events from the cache.
     * @param eventID Unique bus event id that identifies the BusEvent.
     * @return List Containing all of BusEvents matching the event id.
     */
    List getEvents(String eventID);


    /**
     * Sets the cache size. This method can be used to dynamically change the
     * cache size from the configured size.
     * @param size Indicates the new size of the cache.
     */
    void setCacheSize(int size);
}