org.cache2k.integration

Class CacheWriter<K,V>

java.lang.Object

org.cache2k.integration.CacheWriter<K,V>

public abstract class CacheWriter<K,V>
extends Object

Writer for write-through configurations. Any mutation of the cache via the Cache interface, e.g. Cache.put(Object, Object) or Cache.remove(Object) will cause a writer call.

Author:

Jens Wilke

Constructor Summary

Constructors

Constructor and Description
CacheWriter()

Method Summary

Modifier and Type	Method and Description
abstract void	delete(K key) Called when a mapping is removed from the cache.
abstract void	write(K key, V value) Called when the value was updated or inserted into the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheWriter

public CacheWriter()

Method Detail

write

public abstract void write(K key,
                           V value)
                    throws Exception

Called when the value was updated or inserted into the cache.

Calling cache operations: It is illegal to call any cache methods from this method. This may have an undesired effect and can cause a deadlock.

Parameters:

key - key of the value to be written, never null.

value - the value to be written, may be null if null is permitted.

Throws:

Exception - if an exception occurs, the cache update will not occur and this exception will be wrapped in a CacheWriterException

delete

public abstract void delete(K key)
                     throws Exception

Called when a mapping is removed from the cache. The removal was done by Cache.remove(K) or Cache.removeAll(). An expiry does not trigger a call to this method.

Parameters:

key - key of the value removed from the cache, never null.

Throws:

Exception - if an exception occurs, the cache update will not occur and this exception will be wrapped in a CacheWriterException