Package net.sf.ehcache.constructs.blocking

Interface UpdatingCacheEntryFactory

All Superinterfaces:

CacheEntryFactory

public interface UpdatingCacheEntryFactory
extends CacheEntryFactory

A CacheEntryFactory with one additional method, updateEntryValue((Serializable key, Serializable value) which allows the cache entry to updated rather than replaced. This has the following potential benefits:

• Where only part of the value needs to be updated, it is quicker
• Memory use can be smoothed, which is useful for particularly large objects which are being refreshed contrinuously

Version:

$Id$

Author:

Greg Luck

Method Summary

Modifier and Type	Method	Description
void	updateEntryValue(java.lang.Object key, java.lang.Object value)	Perform an incremental update of data within a CacheEntry.

Methods inherited from interface net.sf.ehcache.constructs.blocking.CacheEntryFactory

createEntry

Method Detail

updateEntryValue

void updateEntryValue(java.lang.Object key,
                      java.lang.Object value)
               throws java.lang.Exception

Perform an incremental update of data within a CacheEntry. Based on identification of dirty values within a CacheEntry Insert Update or Delete those entries based on the existing value.

This method does not return a modified value, because it modifies the value passed into it, relying on the pass by reference feature of Java. Implementations of this method must be thread safe.

Parameters:

key - the cache Key

value - a value copied from the value that belonged to the Element in the cache. Value must be mutable

Throws:

java.lang.Exception