Package org.infinispan.notifications.cachelistener.filter

Interface CacheEventConverter<K,V,C>

All Known Subinterfaces:

CacheEventFilterConverter<K,V,C>, IndexedFilter<K,V,C>

All Known Implementing Classes:

AbstractCacheEventFilterConverter, KeyValueFilterConverterAsCacheEventFilterConverter

public interface CacheEventConverter<K,V,C>

A converter that can be used to convert the value given for an event. This converter allows for converting based on the previous value as well as the new updated value. The old value and old metadata are the previous values and the new value and new metadata are the new values even for pre and post events.

Since:

7.0

Author:

wburns

Method Summary

Modifier and Type	Method	Description
C	convert(K key, V oldValue, Metadata oldMetadata, V newValue, Metadata newMetadata, EventType eventType)	Converts the given newValue into something different possibly.
default org.infinispan.commons.dataconversion.MediaType	format()
default boolean	useRequestFormat()

Method Detail

convert

C convert(K key,
          V oldValue,
          Metadata oldMetadata,
          V newValue,
          Metadata newMetadata,
          EventType eventType)

Converts the given newValue into something different possibly.

Parameters:

key - The key for the entry that was changed for the event

oldValue - The previous value before the event takes place

oldMetadata - The old value before the event takes place

newValue - The new value for the entry after the event takes place

newMetadata - The new metadata for the entry after the event takes place

eventType - The type of event that is being raised

Returns:

The converted value to be used in the event

format

default org.infinispan.commons.dataconversion.MediaType format()

useRequestFormat

@Experimental
default boolean useRequestFormat()

Returns:

if true, convert(Object, Object, Metadata, Object, Metadata, EventType) will be presented with data in the request format rather than the format specified in format(). The request format is defined as the MediaType that a cache was previously decorated with AdvancedCache.withMediaType(String, String).