org.infinispan.notifications

Interface FilteringListenable<K,V>

All Superinterfaces:

Listenable

All Known Subinterfaces:

AdvancedCache<K,V>, Cache<K,V>, ClassLoaderAwareFilteringListenable<K,V>, SecureCache<K,V>

All Known Implementing Classes:

AbstractDelegatingAdvancedCache, AbstractDelegatingAdvancedCache, AbstractDelegatingCache, AbstractDelegatingCache

public interface FilteringListenable<K,V>
extends Listenable

A Listable that can also filter events based on key

Since:

6.0

Author:

Manik Surtani

Method Summary

Methods

Modifier and Type	Method and Description
<C> void	addListener(Object listener, CacheEventFilter<? super K,? super V> filter, CacheEventConverter<? super K,? super V,C> converter) Registers a listener that will be notified on events that pass the filter condition.
void	addListener(Object listener, KeyFilter<? super K> filter) Adds a listener to the component.

Methods inherited from interface org.infinispan.notifications.Listenable

addListener, getListeners, removeListener

Method Detail

addListener

void addListener(Object listener,
               KeyFilter<? super K> filter)

Adds a listener to the component. Typically, listeners would need to be annotated with Listener and further to that, contain methods annotated appropriately, otherwise the listener will not be registered.

See the Listener annotation for more information.

Parameters:

listener - must not be null.

addListener

<C> void addListener(Object listener,
                   CacheEventFilter<? super K,? super V> filter,
                   CacheEventConverter<? super K,? super V,C> converter)

Registers a listener that will be notified on events that pass the filter condition. The value presented in the notifications will be first converted using the provided converter if there is one.

Some implementations may provide optimizations when a CacheEventFilterConverter is provided as both arguments to the filter and converter arguments. Note the provided object must have reference equality ie. (==) to be recognized. This allows for the filter and conversion step to take place in the same method call reducing possible overhead.

Type Parameters:

C - The type of the resultant value after being converted

Parameters:

listener - The listener to callback upon event notifications. Must not be null.

filter - The filter to see if the notification should be sent to the listener. Can be null.

converter - The converter to apply to the entry before being sent to the listener. Can be null.

Throws:

NullPointerException - if the specified listener is null