CacheKeyInvocationContext

Type Parameters:

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

All Superinterfaces:

CacheInvocationContext<A>, CacheMethodDetails<A>
```
public interface CacheKeyInvocationContext<A extends java.lang.annotation.Annotation>
extends CacheInvocationContext<A>
```
Runtime information about an intercepted method invocation for a method annotated with CacheResult, CachePut, or CacheRemove.
Used with CacheKeyGenerator.generateCacheKey(CacheKeyInvocationContext) to generate a GeneratedCacheKey for the invocation.

See Also:

CacheKeyGenerator

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`CacheInvocationParameter[]`	`getKeyParameters()`	Returns a clone of the array of all method parameters to be used by the `CacheKeyGenerator` in creating a `GeneratedCacheKey`.
`CacheInvocationParameter`	`getValueParameter()`	When a method is annotated with `CachePut` this is the parameter annotated with `CacheValue`

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 GeneratedCacheKey. 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 CacheKey or CacheValue then all parameters are included
    
    If a CacheValue annotation exists and no CacheKey then all parameters except the one annotated with CacheValue are included
    
    If one or more CacheKey annotations exist only those parameters with the CacheKey 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 this is the parameter annotated with CacheValue
    
    Returns:
    
    The parameter to cache, will never be null for methods annotated with CachePut, will be null for methods not annotated with CachePut