Package javax.cache.configuration

Class MutableCacheEntryListenerConfiguration<K,V>

java.lang.Object

javax.cache.configuration.MutableCacheEntryListenerConfiguration<K,V>

Type Parameters:

K - the type of keys maintained the cache

V - the type of cached values

All Implemented Interfaces:

java.io.Serializable, CacheEntryListenerConfiguration<K,V>

public class MutableCacheEntryListenerConfiguration<K,V>
extends java.lang.Object
implements CacheEntryListenerConfiguration<K,V>

A convenience class providing a mutable, serializable implementation of a CacheEntryListenerConfiguration.

Since:

1.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private Factory<CacheEntryEventFilter<? super K,? super V>>	filterFactory	The Factory to be used to create the CacheEntryEventFilter.
private boolean	isOldValueRequired	Is the old value required to be provide to the CacheEntryListener?
private boolean	isSynchronous	Should the CacheEntryListener be notified as part of an operation or is asynchronous delivery acceptable?
private Factory<CacheEntryListener<? super K,? super V>>	listenerFactory	The Factory to be used to create the CacheEntryListener.
static long	serialVersionUID	The serialVersionUID required for Serializable.

Constructor Summary

Constructors

Constructor	Description
MutableCacheEntryListenerConfiguration(CacheEntryListenerConfiguration<K,V> configuration)	Constructs a MutableCacheEntryListenerConfiguration based on another CacheEntryListenerConfiguration.
MutableCacheEntryListenerConfiguration(Factory<? extends CacheEntryListener<? super K,? super V>> listenerFactory, Factory<? extends CacheEntryEventFilter<? super K,? super V>> filterFactory, boolean isOldValueRequired, boolean isSynchronous)	Constructs a MutableCacheEntryListenerConfiguration.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object object)
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.
int	hashCode()
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.
MutableCacheEntryListenerConfiguration<K,V>	setCacheEntryEventFilterFactory(Factory<? extends CacheEntryEventFilter<? super K,? super V>> filterFactory)	Sets the Factory to be used to create a CacheEntryEventFilter.
MutableCacheEntryListenerConfiguration<K,V>	setCacheEntryListenerFactory(Factory<? extends CacheEntryListener<? super K,? super V>> listenerFactory)	Sets the Factory to be used to create a CacheEntryListener.
MutableCacheEntryListenerConfiguration<K,V>	setOldValueRequired(boolean isOldValueRequired)	Sets if the old value should be provided to the CacheEntryListener.
MutableCacheEntryListenerConfiguration<K,V>	setSynchronous(boolean isSynchronous)	Sets if the thread that causes an event should be blocked (not return from the operation causing the event) until the CacheEntryListener has been notified.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

The serialVersionUID required for Serializable.

See Also:

Constant Field Values

listenerFactory

private Factory<CacheEntryListener<? super K,? super V>> listenerFactory

The Factory to be used to create the CacheEntryListener.

filterFactory

private Factory<CacheEntryEventFilter<? super K,? super V>> filterFactory

The Factory to be used to create the CacheEntryEventFilter. (may be null if no filtering is required)

isOldValueRequired

private boolean isOldValueRequired

Is the old value required to be provide to the CacheEntryListener?

isSynchronous

private boolean isSynchronous

Should the CacheEntryListener be notified as part of an operation or is asynchronous delivery acceptable?

Constructor Detail

MutableCacheEntryListenerConfiguration

public MutableCacheEntryListenerConfiguration(CacheEntryListenerConfiguration<K,V> configuration)

Constructs a MutableCacheEntryListenerConfiguration based on another CacheEntryListenerConfiguration.

Parameters:

configuration - the CacheEntryListenerConfiguration

MutableCacheEntryListenerConfiguration

public MutableCacheEntryListenerConfiguration(Factory<? extends CacheEntryListener<? super K,? super V>> listenerFactory,
                                              Factory<? extends CacheEntryEventFilter<? super K,? super V>> filterFactory,
                                              boolean isOldValueRequired,
                                              boolean isSynchronous)

Constructs a MutableCacheEntryListenerConfiguration.

Parameters:

listenerFactory - the CacheEntryListener Factory

filterFactory - the optional CacheEntryEventFilter Factory

isOldValueRequired - if the old value is required for events with this listenerFactory

isSynchronous - if the listenerFactory should block the thread causing the event

Method Detail

getCacheEntryListenerFactory

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

Obtains the Factory for the CacheEntryListener.

Specified by:

getCacheEntryListenerFactory in interface CacheEntryListenerConfiguration<K,V>

Returns:

the Factory for the CacheEntryListener

setCacheEntryListenerFactory

public MutableCacheEntryListenerConfiguration<K,V> setCacheEntryListenerFactory(Factory<? extends CacheEntryListener<? super K,? super V>> listenerFactory)

Sets the Factory to be used to create a CacheEntryListener.

Parameters:

listenerFactory - the Factory

Returns:

the MutableCacheEntryListenerConfiguration to permit fluent-style method calls

getCacheEntryEventFilterFactory

public 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.

Specified by:

getCacheEntryEventFilterFactory in interface CacheEntryListenerConfiguration<K,V>

Returns:

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

setCacheEntryEventFilterFactory

public MutableCacheEntryListenerConfiguration<K,V> setCacheEntryEventFilterFactory(Factory<? extends CacheEntryEventFilter<? super K,? super V>> filterFactory)

Sets the Factory to be used to create a CacheEntryEventFilter.

Parameters:

filterFactory - the Factory, or null if event filtering is not requried

Returns:

the MutableCacheEntryListenerConfiguration to permit fluent-style method calls

isOldValueRequired

public boolean isOldValueRequired()

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

Specified by:

isOldValueRequired in interface CacheEntryListenerConfiguration<K,V>

Returns:

true if the old value is required by the CacheEntryListener

setOldValueRequired

public MutableCacheEntryListenerConfiguration<K,V> setOldValueRequired(boolean isOldValueRequired)

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

Parameters:

isOldValueRequired - true if the old value is required

Returns:

the MutableCacheEntryListenerConfiguration to permit fluent-style method calls

isSynchronous

public 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.

Specified by:

isSynchronous in interface CacheEntryListenerConfiguration<K,V>

Returns:

true if the thread that created the event should block

setSynchronous

public MutableCacheEntryListenerConfiguration<K,V> setSynchronous(boolean isSynchronous)

Sets if the thread that causes an event should be blocked (not return from the operation causing the event) until the CacheEntryListener has been notified.

Parameters:

isSynchronous - true means block until notified

Returns:

the MutableCacheEntryListenerConfiguration to permit fluent-style method calls

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object