org.ehcache.core.spi.store.events

Interface StoreEventSource<K,V>

All Known Subinterfaces:

StoreEventDispatcher<K,V>

All Known Implementing Classes:

NullStoreEventDispatcher

public interface StoreEventSource<K,V>

Interface to enable listening on and configuring the Store eventing system.

Method Summary

Modifier and Type	Method and Description
void	addEventFilter(StoreEventFilter<K,V> eventFilter) Adds an event filter.
void	addEventListener(StoreEventListener<K,V> eventListener)
boolean	isEventOrdering() Indicates if the related Store is delivering events ordered or not.
void	removeEventListener(StoreEventListener<K,V> eventListener)
void	setEventOrdering(boolean ordering) Toggles event ordering.
void	setSynchronous(boolean synchronous) Toggles event synchronicity.

Method Detail

addEventListener

void addEventListener(StoreEventListener<K,V> eventListener)

removeEventListener

void removeEventListener(StoreEventListener<K,V> eventListener)

addEventFilter

void addEventFilter(StoreEventFilter<K,V> eventFilter)

Adds an event filter.

When multiple event filters are added, an event must be accepted by all to be valid.

Parameters:

eventFilter - the event filter

setEventOrdering

void setEventOrdering(boolean ordering)
               throws java.lang.IllegalArgumentException

Toggles event ordering.

If true it means events will respect ordering of operations on a key basis.

Parameters:

ordering - true if ordering is desired, false for no ordering

Throws:

java.lang.IllegalArgumentException

setSynchronous

void setSynchronous(boolean synchronous)
             throws java.lang.IllegalArgumentException

Toggles event synchronicity.

If true it means events will be fire synchronously.

Parameters:

synchronous - true if synchronicity is desired, false for asynchronous.

Throws:

java.lang.IllegalArgumentException

isEventOrdering

boolean isEventOrdering()

Indicates if the related Store is delivering events ordered or not.

Returns:

true if ordering is on, false otherwise