org.axonframework.common.caching

Class EhCacheAdapter

java.lang.Object

org.axonframework.common.caching.AbstractCacheAdapter<net.sf.ehcache.event.CacheEventListener>

org.axonframework.common.caching.EhCacheAdapter

All Implemented Interfaces:

Cache

public class EhCacheAdapter
extends AbstractCacheAdapter<net.sf.ehcache.event.CacheEventListener>

Cache implementation that delegates all calls to an EhCache instance.

Since:

2.1.2

Author:

Allard Buijze

Nested Class Summary

Nested classes/interfaces inherited from interface org.axonframework.common.caching.Cache

Cache.EntryListener, Cache.EntryListenerAdapter

Constructor Summary

Constructors

Constructor and Description
EhCacheAdapter(net.sf.ehcache.Ehcache ehCache) Initialize the adapter to forward all call to the given ehCache instance

Method Summary

Modifier and Type	Method and Description
<K> boolean	containsKey(K key) Indicates whether there is an item stored under given key.
protected org.axonframework.common.caching.EhCacheAdapter.CacheEventListenerAdapter	createListenerAdapter(Cache.EntryListener cacheEntryListener) Creates an adapter for the given cacheEntryListener.
protected Registration	doRegisterListener(net.sf.ehcache.event.CacheEventListener listenerAdapter) Registers the given listener with the cache implementation
<K,V> V	get(K key) Returns an item from the cache, or null if no item was stored under that key
<K,V> void	put(K key, V value) Stores the given value in the cache, under given key.
<K,V> boolean	putIfAbsent(K key, V value) Stores the given value in the cache, under given key, if no element is yet available under that key.
<K> boolean	remove(K key) Removes the entry stored under given key.

Methods inherited from class org.axonframework.common.caching.AbstractCacheAdapter

registerCacheEntryListener

Methods inherited from class java.lang.Object

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

Constructor Detail

EhCacheAdapter

public EhCacheAdapter(net.sf.ehcache.Ehcache ehCache)

Initialize the adapter to forward all call to the given ehCache instance

Parameters:

ehCache - The cache instance to forward calls to

Method Detail

get

public <K,V> V get(K key)

Description copied from interface: Cache

Returns an item from the cache, or null if no item was stored under that key

Type Parameters:

K - The type of key used

V - The type of value stored

Parameters:

key - The key under which the item was cached

Returns:

the item stored under the given key

put

public <K,V> void put(K key,
                      V value)

Description copied from interface: Cache

Stores the given value in the cache, under given key. If an item already exists, it is updated with the new value.

Type Parameters:

K - The type of key used

V - The type of value stored

Parameters:

key - The key under which to store the item

value - The item to cache

putIfAbsent

public <K,V> boolean putIfAbsent(K key,
                                 V value)

Description copied from interface: Cache

Stores the given value in the cache, under given key, if no element is yet available under that key. This operation is performed atomically.

Type Parameters:

K - The type of key used

V - The type of value stored

Parameters:

key - The key under which to store the item

value - The item to cache

Returns:

true if no value was previously assigned to the key, false otherwise.

remove

public <K> boolean remove(K key)

Description copied from interface: Cache

Removes the entry stored under given key. If no such entry exists, nothing happens.

Type Parameters:

K - The type of key used

Parameters:

key - The key under which the item was stored

Returns:

true if a value was previously assigned to the key and has been removed, false otherwise.

containsKey

public <K> boolean containsKey(K key)

Description copied from interface: Cache

Indicates whether there is an item stored under given key.

Type Parameters:

K - The type of key

Parameters:

key - The key to check

Returns:

true if an item is available under that key, false otherwise.

createListenerAdapter

protected org.axonframework.common.caching.EhCacheAdapter.CacheEventListenerAdapter createListenerAdapter(Cache.EntryListener cacheEntryListener)

Description copied from class: AbstractCacheAdapter

Creates an adapter for the given cacheEntryListener. The adapter must forward all incoming notifications to the respective methods on the cacheEntryListener.

Specified by:

createListenerAdapter in class AbstractCacheAdapter<net.sf.ehcache.event.CacheEventListener>

Parameters:

cacheEntryListener - The listener to create an adapter for

Returns:

an adapter that forwards notifications

doRegisterListener

protected Registration doRegisterListener(net.sf.ehcache.event.CacheEventListener listenerAdapter)

Description copied from class: AbstractCacheAdapter

Registers the given listener with the cache implementation

Specified by:

doRegisterListener in class AbstractCacheAdapter<net.sf.ehcache.event.CacheEventListener>

Parameters:

listenerAdapter - the listener to register

Returns:

a handle to unregister the listener