org.infinispan.notifications

Interface Listenable

All Known Subinterfaces:

AdvancedCache<K,V>, Cache<K,V>, ClassLoaderAwareFilteringListenable<K,V>, ClassLoaderAwareListenable, DataConversionAwareListenable<K,V>, EmbeddedCacheManager, FilteringListenable<K,V>, SecureCache<K,V>

All Known Implementing Classes:

AbstractDelegatingAdvancedCache, AbstractDelegatingAdvancedCache, AbstractDelegatingCache, AbstractDelegatingCache, AbstractDelegatingEmbeddedCacheManager, AbstractDelegatingEmbeddedCacheManager, DefaultCacheManager

public interface Listenable

Interface that denotes that the implementation can have listeners attached to it.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
void	addListener(java.lang.Object listener) Adds a listener to the component.
java.util.Set<java.lang.Object>	getListeners()
void	removeListener(java.lang.Object listener) Removes a listener from the component.

Method Detail

addListener

void addListener(java.lang.Object listener)

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.

removeListener

void removeListener(java.lang.Object listener)

Removes a listener from the component.

Parameters:

listener - listener to remove. Must not be null.

Throws:

IllegalLifecycleStateException - may be thrown if the Listenable is stopped.

getListeners

java.util.Set<java.lang.Object> getListeners()

Returns:

a set of all listeners registered on this component.