javax.cache.annotation
Interface CacheKeyInvocationContext<A extends Annotation>

Type Parameters:

A - The type of annotation this context information is for. One of CacheResult, CachePut, CacheRemoveEntry, or CacheRemoveAll.

All Superinterfaces:

CacheInvocationContext<A>, CacheMethodDetails<A>

public interface CacheKeyInvocationContext<A extends Annotation>
extends CacheInvocationContext<A>

Runtime information about an intercepted method invocation for a method annotated with CacheResult, CachePut, or CacheRemoveEntry.

Used with CacheKeyGenerator.generateCacheKey(CacheKeyInvocationContext) to generate a CacheKey for the invocation.

Version:

$Revision$

Author:

Eric Dalquist

See Also:

CacheKeyGenerator

Method Summary

CacheInvocationParameter[]	getKeyParameters() Returns a clone of the array of all method parameters to be used by the CacheKeyGenerator in creating a CacheKey.
CacheInvocationParameter	getValueParameter() When a method is annotated with CachePut one parameter is the value to be cached.

Methods inherited from interface javax.cache.annotation.CacheInvocationContext

getAllParameters, getTarget, unwrap

Methods inherited from interface javax.cache.annotation.CacheMethodDetails

getAnnotations, getCacheAnnotation, getCacheName, getMethod

Method Detail

getKeyParameters

CacheInvocationParameter[] getKeyParameters()

Returns a clone of the array of all method parameters to be used by the CacheKeyGenerator in creating a CacheKey. The returned array may be the same as or a subset of the array returned by CacheInvocationContext.getAllParameters()

Parameters in this array are selected by the following rules:

• If no parameters are annotated with CacheKeyParam or CacheValue then all parameters are included
• If a CacheValue annotation exists and no CacheKeyParam then all parameters except the one annotated with CacheValue are included
• If one or more CacheKeyParam annotations exist only those parameters with the CacheKeyParam annotation are included

Returns:

An array of all parameters to be used in cache key generation

getValueParameter

CacheInvocationParameter getValueParameter()

When a method is annotated with CachePut one parameter is the value to be cached.

The value to be cached is selected using the following rules:

• If a CacheValue annotation exists the parameter with the annotation is the cached value
• If no CacheValue annotation exists and there is only one parameter it is the cached value
• If no CacheValue annotation exists and there is more than one parameter a CacheException will be thrown.

Returns:

The parameter to cache, will never be null for methods annotated with CachePut, will be null for methods not annotated with CachePut

Throws:

CacheException - thrown if the cache value cannot be determind because there is no CacheValue annotation exists and there is more than one parameter