org.ehcache.impl.config.event

Class DefaultCacheEventListenerConfiguration

java.lang.Object

org.ehcache.impl.internal.classes.ClassInstanceConfiguration<org.ehcache.event.CacheEventListener<?,?>>

org.ehcache.impl.config.event.DefaultCacheEventListenerConfiguration

All Implemented Interfaces:

org.ehcache.core.events.CacheEventListenerConfiguration<java.lang.Void>, org.ehcache.spi.service.ServiceConfiguration<org.ehcache.core.events.CacheEventListenerProvider,java.lang.Void>

public class DefaultCacheEventListenerConfiguration
extends org.ehcache.impl.internal.classes.ClassInstanceConfiguration<org.ehcache.event.CacheEventListener<?,?>>
implements org.ehcache.core.events.CacheEventListenerConfiguration<java.lang.Void>

ServiceConfiguration for the default CacheEventListenerProvider.

Enables configuring a CacheEventListener for a given cache.

This class overrides the default ServiceConfiguration.compatibleWith(ServiceConfiguration) implementation to allow for the configuration of multiple cache event listeners on the same cache.

Constructor Summary

Constructors

Constructor and Description
DefaultCacheEventListenerConfiguration(java.util.Set<org.ehcache.event.EventType> fireOn, org.ehcache.event.CacheEventListener<?,?> listener) Creates a new DefaultCacheEventListenerConfiguration with the provided parameters.
DefaultCacheEventListenerConfiguration(java.util.Set<org.ehcache.event.EventType> fireOn, java.lang.Class<? extends org.ehcache.event.CacheEventListener<?,?>> clazz, java.lang.Object... arguments) Creates a new DefaultCacheEventListenerConfiguration with the provided parameters.

Method Summary

Modifier and Type	Method and Description
boolean	compatibleWith(org.ehcache.spi.service.ServiceConfiguration<?,?> other)
java.util.EnumSet<org.ehcache.event.EventType>	fireOn()
org.ehcache.event.EventFiring	firingMode()
java.lang.Class<org.ehcache.core.events.CacheEventListenerProvider>	getServiceType()
org.ehcache.event.EventOrdering	orderingMode()
void	setEventFiringMode(org.ehcache.event.EventFiring firingMode) Sets the event firing mode on this configuration object.
void	setEventOrderingMode(org.ehcache.event.EventOrdering orderingMode) Sets the event orderign mode on this configuration object.

Methods inherited from class org.ehcache.impl.internal.classes.ClassInstanceConfiguration

getArguments, getClazz, getInstance

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ehcache.spi.service.ServiceConfiguration

build, derive

Constructor Detail

DefaultCacheEventListenerConfiguration

public DefaultCacheEventListenerConfiguration(java.util.Set<org.ehcache.event.EventType> fireOn,
                                              java.lang.Class<? extends org.ehcache.event.CacheEventListener<?,?>> clazz,
                                              java.lang.Object... arguments)

Creates a new DefaultCacheEventListenerConfiguration with the provided parameters.

• Default event firing mode is EventFiring.ASYNCHRONOUS
• Default event ordering mode is EventOrdering.UNORDERED

Parameters:

fireOn - the events to fire on

clazz - the cache event listener class

arguments - optional constructor arguments

See Also:

setEventFiringMode(EventFiring), setEventOrderingMode(EventOrdering)

DefaultCacheEventListenerConfiguration

public DefaultCacheEventListenerConfiguration(java.util.Set<org.ehcache.event.EventType> fireOn,
                                              org.ehcache.event.CacheEventListener<?,?> listener)

Creates a new DefaultCacheEventListenerConfiguration with the provided parameters.

• Default event firing mode is EventFiring.ASYNCHRONOUS
• Default event ordering mode is EventOrdering.UNORDERED

Parameters:

fireOn - the events to fire on

listener - the cache event listener instance

See Also:

setEventFiringMode(EventFiring), setEventOrderingMode(EventOrdering)

Method Detail

getServiceType

public java.lang.Class<org.ehcache.core.events.CacheEventListenerProvider> getServiceType()

Specified by:

getServiceType in interface org.ehcache.spi.service.ServiceConfiguration<org.ehcache.core.events.CacheEventListenerProvider,java.lang.Void>

setEventFiringMode

public void setEventFiringMode(org.ehcache.event.EventFiring firingMode)

Sets the event firing mode on this configuration object.

Parameters:

firingMode - the event firing mode

setEventOrderingMode

public void setEventOrderingMode(org.ehcache.event.EventOrdering orderingMode)

Sets the event orderign mode on this configuration object.

Parameters:

orderingMode - the event ordering mode

firingMode

public org.ehcache.event.EventFiring firingMode()

Specified by:

firingMode in interface org.ehcache.core.events.CacheEventListenerConfiguration<java.lang.Void>

orderingMode

public org.ehcache.event.EventOrdering orderingMode()

Specified by:

orderingMode in interface org.ehcache.core.events.CacheEventListenerConfiguration<java.lang.Void>

fireOn

public java.util.EnumSet<org.ehcache.event.EventType> fireOn()

Specified by:

fireOn in interface org.ehcache.core.events.CacheEventListenerConfiguration<java.lang.Void>

compatibleWith

public boolean compatibleWith(org.ehcache.spi.service.ServiceConfiguration<?,?> other)

Specified by:

compatibleWith in interface org.ehcache.spi.service.ServiceConfiguration<org.ehcache.core.events.CacheEventListenerProvider,java.lang.Void>