javax.cache.configuration

Interface CacheEntryListenerConfiguration<K,V>

Type Parameters:

K - the type of keys

V - the type of values

All Superinterfaces:

Serializable

All Known Implementing Classes:

MutableCacheEntryListenerConfiguration

public interface CacheEntryListenerConfiguration<K,V>
extends Serializable

Defines the configuration requirements for a CacheEntryListener and a Factory for its creation.

Since:

1.0

Author:

Brian Oliver, Greg Luck

Method Summary

Methods

Modifier and Type	Method and Description
Factory<CacheEntryEventFilter<? super K,? super V>>	getCacheEntryEventFilterFactory() Obtains the Factory for the CacheEntryEventFilter that should be applied prior to notifying the CacheEntryListener.
Factory<CacheEntryListener<? super K,? super V>>	getCacheEntryListenerFactory() Obtains the Factory for the CacheEntryListener.
boolean	isOldValueRequired() Determines if the old value should be provided to the CacheEntryListener.
boolean	isSynchronous() Determines if the thread that caused an event to be created should be blocked (not return from the operation causing the event) until the CacheEntryListener has been notified.

Method Detail

getCacheEntryListenerFactory

Factory<CacheEntryListener<? super K,? super V>> getCacheEntryListenerFactory()

Obtains the Factory for the CacheEntryListener.

Returns:

the Factory for the CacheEntryListener

isOldValueRequired

boolean isOldValueRequired()

Determines if the old value should be provided to the CacheEntryListener.

Returns:

true if the old value is required by the CacheEntryListener

getCacheEntryEventFilterFactory

Factory<CacheEntryEventFilter<? super K,? super V>> getCacheEntryEventFilterFactory()

Obtains the Factory for the CacheEntryEventFilter that should be applied prior to notifying the CacheEntryListener.

When null no filtering is applied and all appropriate events are notified.

Returns:

the Factory for the CacheEntryEventFilter or null if no filtering is required

isSynchronous

boolean isSynchronous()

Determines if the thread that caused an event to be created should be blocked (not return from the operation causing the event) until the CacheEntryListener has been notified.

Returns:

true if the thread that created the event should block