Package org.infinispan.functional.impl

Class FunctionalNotifierImpl<K,V>

java.lang.Object

org.infinispan.functional.impl.FunctionalNotifierImpl<K,V>

All Implemented Interfaces:

FunctionalNotifier<K,V>, Listeners.ReadWriteListeners<K,V>, Listeners.WriteListeners<K,V>

@Experimental
public final class FunctionalNotifierImpl<K,V>
extends Object
implements FunctionalNotifier<K,V>

Since:

8.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.infinispan.functional.Listeners.ReadWriteListeners

Listeners.ReadWriteListeners.ReadWriteListener<K,V>

Nested classes/interfaces inherited from interface org.infinispan.functional.Listeners.WriteListeners

Listeners.WriteListeners.WriteListener<K,V>

Constructor Summary

Constructors

Constructor	Description
FunctionalNotifierImpl()

Method Summary

Modifier and Type	Method	Description
AutoCloseable	add(Listeners.ReadWriteListeners.ReadWriteListener<K,V> l)	Add a read-write listener, and return an AutoCloseable instance that can be used to remove the listener registration.
AutoCloseable	add(Listeners.WriteListeners.WriteListener<K,V> l)	Add a write-only listener, and return an AutoCloseable instance that can be used to remove the listener registration.
void	notifyOnCreate(CacheEntry entry)	Notify registered Listeners.ReadWriteListeners.ReadWriteListener instances of the created entry.
void	notifyOnModify(CacheEntry<K,V> entry, V previousValue, Metadata previousMetadata)	Notify registered Listeners.ReadWriteListeners.ReadWriteListener instances of the modified entry passing the previous and new value.
void	notifyOnRemove(EntryView.ReadEntryView<K,V> removed)	Notify registered Listeners.ReadWriteListeners.ReadWriteListener instances of the removed entry passing in the removed entry.
void	notifyOnWrite(CacheEntry<K,V> entry)
void	notifyOnWriteRemove(K key)	Notify registered Listeners.WriteListeners.WriteListener instances of the written entry.
AutoCloseable	onCreate(Consumer<EntryView.ReadEntryView<K,V>> f)	Add a create event specific listener by passing in a Consumer to be called back each time a new cache entry is created, passing in a EntryView.ReadEntryView of that new entry.
AutoCloseable	onModify(BiConsumer<EntryView.ReadEntryView<K,V>,EntryView.ReadEntryView<K,V>> f)	Add a modify/update event specific listener by passing in a BiConsumer to be called back each time an entry is modified or updated, passing in a EntryView.ReadEntryView of the previous entry as first parameter, and a EntryView.ReadEntryView of the new value as second parameter.
AutoCloseable	onRemove(Consumer<EntryView.ReadEntryView<K,V>> f)	Add a remove event specific listener by passing in a Consumer to be called back each time an entry is removed, passing in the EntryView.ReadEntryView of the removed entry.
AutoCloseable	onWrite(Consumer<EntryView.ReadEntryView<K,V>> f)	Add a write event listener by passing in a Consumer to be called each time a cache entry is created, modified/updated or removed.

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionalNotifierImpl

public FunctionalNotifierImpl()

Method Detail

add

public AutoCloseable add(Listeners.WriteListeners.WriteListener<K,V> l)

Description copied from interface: Listeners.WriteListeners

Add a write-only listener, and return an AutoCloseable instance that can be used to remove the listener registration.

Specified by:

add in interface Listeners.WriteListeners<K,V>

Parameters:

l - the write-only functional map event listener

Returns:

an AutoCloseable instance that can be used to unregister the listener

add

public AutoCloseable add(Listeners.ReadWriteListeners.ReadWriteListener<K,V> l)

Description copied from interface: Listeners.ReadWriteListeners

Add a read-write listener, and return an AutoCloseable instance that can be used to remove the listener registration.

Specified by:

add in interface Listeners.ReadWriteListeners<K,V>

Parameters:

l - the read-write functional map event listener

Returns:

an AutoCloseable instance that can be used to unregister the listener

onCreate

public AutoCloseable onCreate(Consumer<EntryView.ReadEntryView<K,V>> f)

Description copied from interface: Listeners.ReadWriteListeners

Add a create event specific listener by passing in a Consumer to be called back each time a new cache entry is created, passing in a EntryView.ReadEntryView of that new entry.

This method is shortcut for users who are only interested in create events. If interested in multiple event types, calling Listeners.ReadWriteListeners.add(ReadWriteListener) is recommended instead.

Specified by:

onCreate in interface Listeners.ReadWriteListeners<K,V>

Parameters:

f - operation to be called each time a new cache entry is created

Returns:

an AutoCloseable instance that can be used to unregister the listener

onModify

public AutoCloseable onModify(BiConsumer<EntryView.ReadEntryView<K,V>,EntryView.ReadEntryView<K,V>> f)

Description copied from interface: Listeners.ReadWriteListeners

Add a modify/update event specific listener by passing in a BiConsumer to be called back each time an entry is modified or updated, passing in a EntryView.ReadEntryView of the previous entry as first parameter, and a EntryView.ReadEntryView of the new value as second parameter.

This method is shortcut for users who are only interested in update events. If interested in multiple event types, calling Listeners.ReadWriteListeners.add(ReadWriteListener) is recommended instead.

Specified by:

onModify in interface Listeners.ReadWriteListeners<K,V>

Parameters:

f - operation to be called each time a new cache entry is modified or updated, with the first parameter the EntryView.ReadEntryView of the previous entry value, and the second parameter the new EntryView.ReadEntryView

Returns:

an AutoCloseable instance that can be used to unregister the listener

onRemove

public AutoCloseable onRemove(Consumer<EntryView.ReadEntryView<K,V>> f)

Description copied from interface: Listeners.ReadWriteListeners

Add a remove event specific listener by passing in a Consumer to be called back each time an entry is removed, passing in the EntryView.ReadEntryView of the removed entry.

This method is shortcut for users who are only interested in remove events. If interested in multiple event types, calling Listeners.ReadWriteListeners.add(ReadWriteListener) is recommended instead.

Specified by:

onRemove in interface Listeners.ReadWriteListeners<K,V>

Parameters:

f - operation to be called each time a new cache entry is removed, with the old cached entry's EntryView.ReadEntryView as parameter.

Returns:

an AutoCloseable instance that can be used to unregister the listener

onWrite

public AutoCloseable onWrite(Consumer<EntryView.ReadEntryView<K,V>> f)

Description copied from interface: Listeners.WriteListeners

Add a write event listener by passing in a Consumer to be called each time a cache entry is created, modified/updated or removed.

For created or modified/updated events, the EntryView.ReadEntryView passed in will represent the newly stored entry, hence implementations will not be available to differentiate between created events vs modified/updated events.

For removed events, EntryView.ReadEntryView passed in will represent an empty entry view, hence EntryView.ReadEntryView.find() will return an empty Optional instance, and EntryView.ReadEntryView.get() will throw NoSuchElementException.

Specified by:

onWrite in interface Listeners.WriteListeners<K,V>

Parameters:

f - operation to be called each time a cache entry is written

Returns:

an AutoCloseable instance that can be used to unregister the listener

notifyOnCreate

public void notifyOnCreate(CacheEntry entry)

Description copied from interface: FunctionalNotifier

Notify registered Listeners.ReadWriteListeners.ReadWriteListener instances of the created entry.

Specified by:

notifyOnCreate in interface FunctionalNotifier<K,V>

notifyOnModify

public void notifyOnModify(CacheEntry<K,V> entry,
                           V previousValue,
                           Metadata previousMetadata)

Description copied from interface: FunctionalNotifier

Notify registered Listeners.ReadWriteListeners.ReadWriteListener instances of the modified entry passing the previous and new value.

Specified by:

notifyOnModify in interface FunctionalNotifier<K,V>

notifyOnRemove

public void notifyOnRemove(EntryView.ReadEntryView<K,V> removed)

Description copied from interface: FunctionalNotifier

Notify registered Listeners.ReadWriteListeners.ReadWriteListener instances of the removed entry passing in the removed entry.

Specified by:

notifyOnRemove in interface FunctionalNotifier<K,V>

notifyOnWrite

public void notifyOnWrite(CacheEntry<K,V> entry)

Specified by:

notifyOnWrite in interface FunctionalNotifier<K,V>

notifyOnWriteRemove

public void notifyOnWriteRemove(K key)

Description copied from interface: FunctionalNotifier

Notify registered Listeners.WriteListeners.WriteListener instances of the written entry.

Specified by:

notifyOnWriteRemove in interface FunctionalNotifier<K,V>