org.apache.jcs.engine.behavior
Interface ICacheEventQueue

All Known Implementing Classes:
CacheEventQueue

public interface ICacheEventQueue

Interface for a cache event queue. An event queue is used to propagate ordered cache events to one and only one target listener.

Author:
asmuts

Method Summary
 void addDisposeEvent()
          Adds a feature to the DisposeEvent attribute of the ICacheEventQueue object
 void addPutEvent(ICacheElement ce)
          Adds a feature to the PutEvent attribute of the ICacheEventQueue object
 void addRemoveAllEvent()
          Adds a feature to the RemoveAllEvent attribute of the ICacheEventQueue object
 void addRemoveEvent(java.io.Serializable key)
          Adds a feature to the RemoveEvent attribute of the ICacheEventQueue object
 void destroy()
          Description of the Method
 byte getListenerId()
          Gets the listenerId attribute of the ICacheEventQueue object
 boolean isAlive()
          Gets the alive attribute of the ICacheEventQueue object
 

Method Detail

addPutEvent

public void addPutEvent(ICacheElement ce)
                 throws java.io.IOException
Adds a feature to the PutEvent attribute of the ICacheEventQueue object

Parameters:
ce - The feature to be added to the PutEvent attribute
Throws:
java.io.IOException

addRemoveEvent

public void addRemoveEvent(java.io.Serializable key)
                    throws java.io.IOException
Adds a feature to the RemoveEvent attribute of the ICacheEventQueue object

Parameters:
key - The feature to be added to the RemoveEvent attribute
Throws:
java.io.IOException

addRemoveAllEvent

public void addRemoveAllEvent()
                       throws java.io.IOException
Adds a feature to the RemoveAllEvent attribute of the ICacheEventQueue object

Throws:
java.io.IOException

addDisposeEvent

public void addDisposeEvent()
                     throws java.io.IOException
Adds a feature to the DisposeEvent attribute of the ICacheEventQueue object

Throws:
java.io.IOException

getListenerId

public byte getListenerId()
Gets the listenerId attribute of the ICacheEventQueue object

Returns:
The listenerId value

destroy

public void destroy()
Description of the Method


isAlive

public boolean isAlive()
Gets the alive attribute of the ICacheEventQueue object

Returns:
The alive value