com.hazelcast.map.impl.event

Interface EntryEventDataCache

public interface EntryEventDataCache

A cache for EntryEventData. Instances of this interface are obtained by FilteringStrategys. This provides a chance for filtering strategies to optimize event data caching implementation. This is not a general-purpose cache, rather it is meant to be used within the context of processing a single entry event in single-threaded code. This will allow creating less instances that are shared between listener registrations. The concrete number of created instances depends on the implementation. Every new event will need to obtain a new instance of the EntryEventDataCache.

See Also:

MapEventPublisherImpl.publishEvent(Collection, Address, String, EntryEventType, Data, Object, Object, Object)

Method Summary

Modifier and Type	Method and Description
Collection<EntryEventData>	eventDataExcludingValues() Return EntryEventData created & cached by invocations to getOrCreateEventData(String, Address, Data, Object, Object, Object, int, boolean), excluding values from the EntryEventData object.
Collection<EntryEventData>	eventDataIncludingValues() Return EntryEventData created & cached by invocations to getOrCreateEventData(String, Address, Data, Object, Object, Object, int, boolean), including values in the EntryEventData object.
EntryEventData	getOrCreateEventData(String mapName, Address caller, Data dataKey, Object newValue, Object oldValue, Object mergingValue, int eventType, boolean includingValues) If an EntryEventData for the given parameters is already cached then return the cached value, otherwise create, cache and return the EntryEventData.
boolean	isEmpty() Indicate whether event data have been created and are cached in this cache or not.

Method Detail

getOrCreateEventData

EntryEventData getOrCreateEventData(String mapName,
                                    Address caller,
                                    Data dataKey,
                                    Object newValue,
                                    Object oldValue,
                                    Object mergingValue,
                                    int eventType,
                                    boolean includingValues)

If an EntryEventData for the given parameters is already cached then return the cached value, otherwise create, cache and return the EntryEventData.

Parameters:

mapName - name of map

caller - the address of the caller that caused the event

dataKey - the key of the event map entry

newValue - the new value of the map entry

oldValue - the old value of the map entry

mergingValue - the value used when performing a merge operation in case of a EntryEventType.MERGED event. This value together with the old value produced the new value.

eventType - the event type

includingValues - if all of the entry values need to be included in the returned EntryEventData

Returns:

EntryEventData already cached in Map eventDataPerEventType for the given eventType or if not already cached, a new EntryEventData object.

isEmpty

boolean isEmpty()

Indicate whether event data have been created and are cached in this cache or not. If this method returns false, then eventDataIncludingValues.size() + eventDataExcludingValues.size() > 0.

Returns:

true if event data were not created in this cache, otherwise false.

eventDataIncludingValues

Collection<EntryEventData> eventDataIncludingValues()

Return EntryEventData created & cached by invocations to getOrCreateEventData(String, Address, Data, Object, Object, Object, int, boolean), including values in the EntryEventData object.

Returns:

EntryEventData created & cached including values. When no such EntryEventData exist, may return null or empty collection.

eventDataExcludingValues

Collection<EntryEventData> eventDataExcludingValues()

Return EntryEventData created & cached by invocations to getOrCreateEventData(String, Address, Data, Object, Object, Object, int, boolean), excluding values from the EntryEventData object.

Returns:

EntryEventData created & cached excluding values. When no such EntryEventData exist, may return null or empty collection.