Package 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:
DefaultCacheManager
public interface Listenable
Interface that denotes that the implementation can have listeners attached to it.- Since:
- 4.0
- Author:
- Manik Surtani
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description default void
addListener(Object listener)
Adds a listener to the component.CompletionStage<Void>
addListenerAsync(Object listener)
Asynchronous version ofaddListener(Object)
Set<Object>
getListeners()
Deprecated.Since 10.0, with no replacementdefault void
removeListener(Object listener)
Removes a listener from the component.CompletionStage<Void>
removeListenerAsync(Object listener)
Asynchronous version ofremoveListener(Object)
-
-
-
Method Detail
-
addListener
default void addListener(Object listener)
Adds a listener to the component. Typically, listeners would need to be annotated withListener
and further to that, contain methods annotated appropriately, otherwise the listener will not be registered. See theListener
annotation for more information.- Parameters:
listener
- listener to add, must not be null
-
addListenerAsync
CompletionStage<Void> addListenerAsync(Object listener)
Asynchronous version ofaddListener(Object)
- Parameters:
listener
- listener to add, must not be null- Returns:
- CompletionStage that when complete the listener is fully installed
-
removeListener
default void removeListener(Object listener)
Removes a listener from the component.- Parameters:
listener
- listener to remove. Must not be null.- Throws:
IllegalLifecycleStateException
- may be thrown if theListenable
is stopped.
-
removeListenerAsync
CompletionStage<Void> removeListenerAsync(Object listener)
Asynchronous version ofremoveListener(Object)
- Parameters:
listener
- listener to remove, must not be null- Returns:
- CompletionStage that when complete the listener is fully removed
-
getListeners
@Deprecated Set<Object> getListeners()
Deprecated.Since 10.0, with no replacement- Returns:
- a set of all listeners registered on this component.
-
-