org.ehcache.core.events

Class NullStoreEventDispatcher<K,V>

java.lang.Object

org.ehcache.core.events.NullStoreEventDispatcher<K,V>

All Implemented Interfaces:

StoreEventDispatcher<K,V>, StoreEventSource<K,V>

public class NullStoreEventDispatcher<K,V>
extends java.lang.Object
implements StoreEventDispatcher<K,V>

NullStoreEventDispatcher

Constructor Summary

Constructors

Constructor and Description
NullStoreEventDispatcher()

Method Summary

Modifier and Type	Method and Description
void	addEventFilter(StoreEventFilter<K,V> eventFilter) Adds an event filter.
void	addEventListener(StoreEventListener<K,V> eventListener)
StoreEventSink<K,V>	eventSink() Hands over an event sink for recording store events.
boolean	isEventOrdering() Indicates if the related Store is delivering events ordered or not.
static <K,V> StoreEventDispatcher<K,V>	nullStoreEventDispatcher()
void	releaseEventSink(StoreEventSink<K,V> eventSink) Releases the event sink after normal completion of an operation.
void	releaseEventSinkAfterFailure(StoreEventSink<K,V> eventSink, java.lang.Throwable throwable) Releases the event sink after failure of an operation.
void	removeEventListener(StoreEventListener<K,V> eventListener)
void	reset(StoreEventSink<K,V> eventSink) Reset an event sink by dropping all queued events.
void	setEventOrdering(boolean ordering) Toggles event ordering.
void	setSynchronous(boolean synchronous) Toggles event synchronicity.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NullStoreEventDispatcher

public NullStoreEventDispatcher()

Method Detail

nullStoreEventDispatcher

public static <K,V> StoreEventDispatcher<K,V> nullStoreEventDispatcher()

eventSink

public StoreEventSink<K,V> eventSink()

Description copied from interface: StoreEventDispatcher

Hands over an event sink for recording store events.

Specified by:

eventSink in interface StoreEventDispatcher<K,V>

Returns:

the event sink to use

releaseEventSink

public void releaseEventSink(StoreEventSink<K,V> eventSink)

Description copied from interface: StoreEventDispatcher

Releases the event sink after normal completion of an operation.

Specified by:

releaseEventSink in interface StoreEventDispatcher<K,V>

Parameters:

eventSink - the event sink to release

releaseEventSinkAfterFailure

public void releaseEventSinkAfterFailure(StoreEventSink<K,V> eventSink,
                                         java.lang.Throwable throwable)

Description copied from interface: StoreEventDispatcher

Releases the event sink after failure of an operation.

Specified by:

releaseEventSinkAfterFailure in interface StoreEventDispatcher<K,V>

Parameters:

eventSink - the event sink to release

throwable - the exception

reset

public void reset(StoreEventSink<K,V> eventSink)

Description copied from interface: StoreEventDispatcher

Reset an event sink by dropping all queued events.

Specified by:

reset in interface StoreEventDispatcher<K,V>

Parameters:

eventSink - the event sink to reset

addEventListener

public void addEventListener(StoreEventListener<K,V> eventListener)

Specified by:

addEventListener in interface StoreEventSource<K,V>

removeEventListener

public void removeEventListener(StoreEventListener<K,V> eventListener)

Specified by:

removeEventListener in interface StoreEventSource<K,V>

addEventFilter

public void addEventFilter(StoreEventFilter<K,V> eventFilter)

Description copied from interface: StoreEventSource

Adds an event filter.

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

Specified by:

addEventFilter in interface StoreEventSource<K,V>

Parameters:

eventFilter - the event filter

setEventOrdering

public void setEventOrdering(boolean ordering)

Description copied from interface: StoreEventSource

Toggles event ordering.

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

Specified by:

setEventOrdering in interface StoreEventSource<K,V>

Parameters:

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

setSynchronous

public void setSynchronous(boolean synchronous)

Description copied from interface: StoreEventSource

Toggles event synchronicity.

If true it means events will be fire synchronously.

Specified by:

setSynchronous in interface StoreEventSource<K,V>

Parameters:

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

isEventOrdering

public boolean isEventOrdering()

Description copied from interface: StoreEventSource

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

Specified by:

isEventOrdering in interface StoreEventSource<K,V>

Returns:

true if ordering is on, false otherwise