com.googlecode.ehcache.annotations.key
Class DelegateCacheKeyGenerator

java.lang.Object
  com.googlecode.ehcache.annotations.key.AbstractCacheKeyGenerator<java.io.Serializable>
      com.googlecode.ehcache.annotations.key.DelegateCacheKeyGenerator

All Implemented Interfaces:

CacheKeyGenerator<java.io.Serializable>

public abstract class DelegateCacheKeyGenerator
extends AbstractCacheKeyGenerator<java.io.Serializable>

AbstractCacheKeyGenerator implementation designed for subclassing. Subclasses can implement the getAdditionalDataForKeyGeneration() method to seed additional data into the call to generateKey(Object...).

Version:

$Id: DelegateCacheKeyGenerator.java 656 2011-04-21 19:54:27Z eric.dalquist@gmail.com $

Author:

Nicholas Blair

Constructor Summary

DelegateCacheKeyGenerator(AbstractCacheKeyGenerator<? extends java.io.Serializable> delegate)

Method Summary

java.io.Serializable	generateKey(java.lang.Object... data) Calls generateKey(Object...) on the delegate passing in data argument AND the result from getAdditionalDataForKeyGeneration().
abstract java.io.Serializable	getAdditionalDataForKeyGeneration()

Methods inherited from class com.googlecode.ehcache.annotations.key.AbstractCacheKeyGenerator

generateKey, isCheckforCycles, isIncludeMethod, isIncludeParameterTypes, register, setCheckforCycles, setIncludeMethod, setIncludeParameterTypes, unregister

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegateCacheKeyGenerator

public DelegateCacheKeyGenerator(AbstractCacheKeyGenerator<? extends java.io.Serializable> delegate)

Parameters:

delegate -

Method Detail

generateKey

public final java.io.Serializable generateKey(java.lang.Object... data)

Calls generateKey(Object...) on the delegate passing in data argument AND the result from getAdditionalDataForKeyGeneration().

Specified by:

generateKey in interface CacheKeyGenerator<java.io.Serializable>

Specified by:

generateKey in class AbstractCacheKeyGenerator<java.io.Serializable>

Parameters:

data - the objects to use when generating the key

Returns:

The Serializable cache key for the method invocation.

See Also:

getAdditionalDataForKeyGeneration(), AbstractCacheKeyGenerator.generateKey(java.lang.Object[])

getAdditionalDataForKeyGeneration

public abstract java.io.Serializable getAdditionalDataForKeyGeneration()

Returns:

a Serializable object to inject into the calls to generateKey(Object...)