com.trivago.triava.tcache.event

Class ListenerCollection<K,V>

java.lang.Object

com.trivago.triava.tcache.event.ListenerCollection<K,V>

public class ListenerCollection<K,V>
extends Object

Constructor Summary

Constructors

Constructor and Description
ListenerCollection(Cache<K,V> tcache, Builder<K,V> builder) Creates a ListenerCollection that consists of all listeners from builder.getCacheEntryListenerConfigurations().

Method Summary

Modifier and Type	Method and Description
void	deregisterCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> listenerConfiguration) Deregisters a cache listener.
void	dispatchEvent(javax.cache.event.EventType eventType, K key, V value)
void	dispatchEvent(javax.cache.event.EventType eventType, K key, V value, V oldValue)
void	dispatchEvents(Map<K,V> entries, javax.cache.event.EventType eventType, boolean forceAsync) Notifies all listeners that a given EventType has happened for all the given entries.
boolean	hasListenerFor(javax.cache.event.EventType eventType) Checks whether this ListenerCollection includes at least one Listener for the given EventType.
void	registerCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> listenerConfiguration) Registers a cache listener.
void	shutdown()
int	size() Returns the number of listeners in this ListenerCollection.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListenerCollection

public ListenerCollection(Cache<K,V> tcache,
                          Builder<K,V> builder)

Creates a ListenerCollection that consists of all listeners from builder.getCacheEntryListenerConfigurations().

Parameters:

tcache - The Cache

builder - The Builder of the given tcache

Method Detail

deregisterCacheEntryListener

public void deregisterCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> listenerConfiguration)

Deregisters a cache listener.

Parameters:

listenerConfiguration - The Cache Listener

registerCacheEntryListener

public void registerCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> listenerConfiguration)

Registers a cache listener.

Parameters:

listenerConfiguration - The Cache Listener

dispatchEvent

public void dispatchEvent(javax.cache.event.EventType eventType,
                          K key,
                          V value)

dispatchEvent

public void dispatchEvent(javax.cache.event.EventType eventType,
                          K key,
                          V value,
                          V oldValue)

dispatchEvents

public void dispatchEvents(Map<K,V> entries,
                           javax.cache.event.EventType eventType,
                           boolean forceAsync)

Notifies all listeners that a given EventType has happened for all the given entries. You can force all listeners to Async mode, but should only do this if it is compliant with JSR107.

IMPORTANT PERFORMANCE NOTE: To avoid unnecessary object creation (TCacheEntryEvent and the event Iterable), you SHOULD check with hasListenerFor(EventType) whether there is any Listener interested in the given eventType. If not, do you can spare to create the TCacheEntryEvent events.

Parameters:

entries - The key-value pairs for which to send events

eventType - The event Type

forceAsync - Force async mode

hasListenerFor

public boolean hasListenerFor(javax.cache.event.EventType eventType)

Checks whether this ListenerCollection includes at least one Listener for the given EventType.

Parameters:

eventType - The EventType to check

Returns:

true if at least one Listener is interested in the EventType

size

public int size()

Returns the number of listeners in this ListenerCollection.

Returns:

The number of listeners

shutdown

public void shutdown()