org.ehcache.jcache
Class JCacheListenerAdapter<K,V>

java.lang.Object
  org.ehcache.jcache.JCacheListenerAdapter<K,V>

Type Parameters:

K - the type of keys used by this JCacheListenerAdapter

V - the type of values that are loaded by this JCacheListenerAdapter

All Implemented Interfaces:

Cloneable, net.sf.ehcache.event.CacheEventListener

public class JCacheListenerAdapter<K,V>
extends Object
implements net.sf.ehcache.event.CacheEventListener

Adapt a CacheEntryListener to the CacheEventListener interface

Since:

1.4.0-beta1

Author:

Ryan Gardner

Constructor Summary

JCacheListenerAdapter(javax.cache.event.CacheEntryListener<K,V> cacheListener, JCache<K,V> jCache, javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)
Construct an adapter that wraps the cacheListener to be used by Ehcache

The interfaces of CacheEntryListener are more fine-grained than the CacheEntryListener interface - and may only implement one or more of the following sub-interfaces: CacheEntryRemovedListener CacheEntryCreatedListener CacheEntryUpdatedListener CacheEntryExpiredListener

When this constructor is called, the cacheListener will be inspected and based upon which sub-interfaces of CacheEntryListener the cacheListener implements, listeners on the corresponding EHCache events will be adapted to it.

Method Summary

Object	clone() Creates and returns a copy of this object.
void	dispose() Give the listener a chance to cleanup and free resources when no longer needed
boolean	equals(Object o)
int	hashCode()
void	notifyElementEvicted(net.sf.ehcache.Ehcache cache, net.sf.ehcache.Element element) Called immediately after an element is evicted from the cache.
void	notifyElementExpired(net.sf.ehcache.Ehcache cache, net.sf.ehcache.Element element) Called immediately after an element is found to be expired.
void	notifyElementPut(net.sf.ehcache.Ehcache cache, net.sf.ehcache.Element element) Called immediately after an element has been put into the cache.
void	notifyElementRemoved(net.sf.ehcache.Ehcache cache, net.sf.ehcache.Element element) Called immediately after an attempt to remove an element.
void	notifyElementUpdated(net.sf.ehcache.Ehcache cache, net.sf.ehcache.Element element) Called immediately after an element has been put into the cache and the element already existed in the cache.
void	notifyRemoveAll(net.sf.ehcache.Ehcache cache) Called during Ehcache.removeAll() to indicate that the all elements have been removed from the cache in a bulk operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

JCacheListenerAdapter

public JCacheListenerAdapter(javax.cache.event.CacheEntryListener<K,V> cacheListener,
                             JCache<K,V> jCache,
                             javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)

Construct an adapter that wraps the cacheListener to be used by Ehcache

The interfaces of CacheEntryListener are more fine-grained than the CacheEntryListener interface - and may only implement one or more of the following sub-interfaces: CacheEntryRemovedListener CacheEntryCreatedListener CacheEntryUpdatedListener CacheEntryExpiredListener

When this constructor is called, the cacheListener will be inspected and based upon which sub-interfaces of CacheEntryListener the cacheListener implements, listeners on the corresponding EHCache events will be adapted to it.

It is expected that the EventListener model of JSR107 will change, so this class will likely be refactored several times before the final release of JSR107.

Parameters:

cacheListener - the cacheListener to wrap

jCache -

cacheEntryListenerConfiguration -

Method Detail

notifyElementRemoved

public void notifyElementRemoved(net.sf.ehcache.Ehcache cache,
                                 net.sf.ehcache.Element element)
                          throws net.sf.ehcache.CacheException

Called immediately after an attempt to remove an element. The remove method will block until this method returns.

This notification is received regardless of whether the cache had an element matching the removal key or not. If an element was removed, the element is passed to this method, otherwise a synthetic element, with only the key set is passed in.

This notification is not called for the following special cases:

1. removeAll was called. See notifyRemoveAll(net.sf.ehcache.Ehcache)
2. An element was evicted from the cache. See notifyElementEvicted(net.sf.ehcache.Ehcache, net.sf.ehcache.Element)

Specified by:

notifyElementRemoved in interface net.sf.ehcache.event.CacheEventListener

Throws:

net.sf.ehcache.CacheException

notifyElementPut

public void notifyElementPut(net.sf.ehcache.Ehcache cache,
                             net.sf.ehcache.Element element)
                      throws net.sf.ehcache.CacheException

Called immediately after an element has been put into the cache. The Cache.put(net.sf.ehcache.Element) method will block until this method returns.

Implementers may wish to have access to the Element's fields, including value, so the element is provided. Implementers should be careful not to modify the element. The effect of any modifications is undefined.

Specified by:

notifyElementPut in interface net.sf.ehcache.event.CacheEventListener

Throws:

net.sf.ehcache.CacheException

notifyElementUpdated

public void notifyElementUpdated(net.sf.ehcache.Ehcache cache,
                                 net.sf.ehcache.Element element)
                          throws net.sf.ehcache.CacheException

Called immediately after an element has been put into the cache and the element already existed in the cache. This is thus an update.

The Cache.put(net.sf.ehcache.Element) method will block until this method returns.

Implementers may wish to have access to the Element's fields, including value, so the element is provided. Implementers should be careful not to modify the element. The effect of any modifications is undefined.

Specified by:

notifyElementUpdated in interface net.sf.ehcache.event.CacheEventListener

Throws:

net.sf.ehcache.CacheException

notifyElementExpired

public void notifyElementExpired(net.sf.ehcache.Ehcache cache,
                                 net.sf.ehcache.Element element)

Called immediately after an element is found to be expired. The Cache.remove(Object) method will block until this method returns.

As the Element has been expired, only what was the key of the element is known.

Elements are checked for expiry in ehcache at the following times:

• When a get request is made
• When an element is spooled to the diskStore in accordance with a MemoryStore eviction policy
• In the DiskStore when the expiry thread runs, which by default is Cache.DEFAULT_EXPIRY_THREAD_INTERVAL_SECONDS

If an element is found to be expired, it is deleted and this method is notified.

Specified by:

notifyElementExpired in interface net.sf.ehcache.event.CacheEventListener

notifyElementEvicted

public void notifyElementEvicted(net.sf.ehcache.Ehcache cache,
                                 net.sf.ehcache.Element element)

Called immediately after an element is evicted from the cache. Evicted in this sense means evicted from one store and not moved to another, so that it exists nowhere in the local cache.

In a sense the Element has been removed from the cache, but it is different, thus the separate notification.

Specified by:

notifyElementEvicted in interface net.sf.ehcache.event.CacheEventListener

notifyRemoveAll

public void notifyRemoveAll(net.sf.ehcache.Ehcache cache)

Called during Ehcache.removeAll() to indicate that the all elements have been removed from the cache in a bulk operation. The usual notifyElementRemoved(net.sf.ehcache.Ehcache, net.sf.ehcache.Element) is not called.

This notification exists because clearing a cache is a special case. It is often not practical to serially process notifications where potentially millions of elements have been bulk deleted.

Specified by:

notifyRemoveAll in interface net.sf.ehcache.event.CacheEventListener

dispose

public void dispose()

Give the listener a chance to cleanup and free resources when no longer needed

Specified by:

dispose in interface net.sf.ehcache.event.CacheEventListener

clone

public Object clone()
             throws CloneNotSupportedException

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x

will be true, and that the expression:

 x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

 x.clone().equals(x)

will be true, this is not an absolute requirement. By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass(). By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified. The method clone for class Object performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown. Note that all arrays are considered to implement the interface Cloneable and that the return type of the clone method of an array type T[] is T[] where T is any reference or primitive type. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation. The class Object does not itself implement the interface Cloneable, so calling the clone method on an object whose class is Object will result in throwing an exception at run time.

Specified by:

clone in interface net.sf.ehcache.event.CacheEventListener

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

See Also:

Cloneable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object