org.springframework.cache.jcache.interceptor

Class AbstractJCacheKeyOperation<A extends java.lang.annotation.Annotation>

java.lang.Object

org.springframework.cache.jcache.interceptor.AbstractJCacheOperation<A>

org.springframework.cache.jcache.interceptor.AbstractJCacheKeyOperation<A>

All Implemented Interfaces:

BasicOperation, JCacheOperation<A>

Direct Known Subclasses:

CachePutOperation, CacheRemoveOperation, CacheResultOperation

abstract class AbstractJCacheKeyOperation<A extends java.lang.annotation.Annotation>
extends AbstractJCacheOperation<A>

A base JCacheOperation that operates with a key.

Since:

4.1

Author:

Stephane Nicoll

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.cache.jcache.interceptor.AbstractJCacheOperation

AbstractJCacheOperation.CacheInvocationParameterImpl, AbstractJCacheOperation.CacheParameterDetail

Field Summary

Fields

Modifier and Type	Field and Description
private KeyGenerator	keyGenerator
private java.util.List<AbstractJCacheOperation.CacheParameterDetail>	keyParameterDetails

Fields inherited from class org.springframework.cache.jcache.interceptor.AbstractJCacheOperation

allParameterDetails

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJCacheKeyOperation(<any> methodDetails, CacheResolver cacheResolver, KeyGenerator keyGenerator) Create a new instance.

Method Summary

Modifier and Type	Method and Description
KeyGenerator	getKeyGenerator() Return the KeyGenerator to use to compute cache keys.
CacheInvocationParameter[]	getKeyParameters(java.lang.Object... values) Return the CacheInvocationParameter for the parameters that are to be used to compute the key.
private static java.util.List<AbstractJCacheOperation.CacheParameterDetail>	initializeKeyParameterDetails(java.util.List<AbstractJCacheOperation.CacheParameterDetail> allParameters)

Methods inherited from class org.springframework.cache.jcache.interceptor.AbstractJCacheOperation

createExceptionTypeFilter, getAllParameters, getAnnotations, getCacheAnnotation, getCacheName, getCacheNames, getCacheResolver, getExceptionTypeFilter, getMethod, getOperationDescription, toString

Methods inherited from class java.lang.Object

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

Field Detail

keyGenerator

private final KeyGenerator keyGenerator

keyParameterDetails

private final java.util.List<AbstractJCacheOperation.CacheParameterDetail> keyParameterDetails

Constructor Detail

AbstractJCacheKeyOperation

protected AbstractJCacheKeyOperation(<any> methodDetails,
                                     CacheResolver cacheResolver,
                                     KeyGenerator keyGenerator)

Create a new instance.

Parameters:

methodDetails - the CacheMethodDetails related to the cached method

cacheResolver - the cache resolver to resolve regular caches

keyGenerator - the key generator to compute cache keys

Method Detail

getKeyGenerator

public KeyGenerator getKeyGenerator()

Return the KeyGenerator to use to compute cache keys.

getKeyParameters

public CacheInvocationParameter[] getKeyParameters(java.lang.Object... values)

Return the CacheInvocationParameter for the parameters that are to be used to compute the key.

Per the spec, if some method parameters are annotated with javax.cache.annotation.CacheKey, only those parameters should be part of the key. If none are annotated, all parameters except the parameter annotated with javax.cache.annotation.CacheValue should be part of the key.

The method arguments must match the signature of the related method invocation

Parameters:

values - the parameters value for a particular invocation

Returns:

the CacheInvocationParameter instances for the parameters to be used to compute the key

initializeKeyParameterDetails

private static java.util.List<AbstractJCacheOperation.CacheParameterDetail> initializeKeyParameterDetails(java.util.List<AbstractJCacheOperation.CacheParameterDetail> allParameters)