Top Description Methods
javax.cache.annotation

public @Interface CachePut

extends Annotation
Annotations
@Target:METHOD, TYPE
@Retention:RUNTIME
Imports
javax.cache.Cache, .CacheManager, javax.enterprise.util.Nonbinding, java.lang.annotation.ElementType, .Retention, .RetentionPolicy, .Target, java.util.Arrays
When a method annotated with CachePut is invoked a GeneratedCacheKey will be generated and Cache#put(Object, Object) will be invoked on the specified cache storing the value marked with CacheValue.

The default behavior is to call Cache#put(Object, Object) after the annotated method is invoked, this behavior can be changed by setting afterInvocation() to false in which case Cache#put(Object, Object) will be called before the annotated method is invoked.

Example of caching the Domain object with a key generated from the String and int parameters. The CacheValue annotation is used to designate which parameter should be stored in the "domainDao" cache. 


package my.app;

public class DomainDao {
  @CachePut(cacheName="domainCache")
  public void updateDomain(String domainId, int index, @CacheValue Domain
domain) {
    ...
  }
}

Exception Handling, only used if afterInvocation() is true.

  1. If cacheFor() and noCacheFor() are both empty then all exceptions prevent the put
  2. If cacheFor() is specified and noCacheFor() is not specified then only exceptions that pass an instanceof check against the cacheFor list result in a put
  3. If noCacheFor() is specified and cacheFor() is not specified then all exceptions that do not pass an instanceof check against the noCacheFor result in a put
  4. If cacheFor() and noCacheFor() are both specified then exceptions that pass an instanceof check against the cacheFor list but do not pass an instanceof check against the noCacheFor list result in a put
Authors
Eric Dalquist, Rick Hightower
Since
1.0
See Also
CacheValue, CacheKey

Method Summary

Modifier and TypeMethod and Description
public boolean
afterInvocation()

When Cache#put(Object, Object) should be called.

public Class<? extends Throwable>[]
cacheFor()

Defines zero (0) or more exception classes, that must be a subclass of Throwable, indicating the exception types that must cause the parameter to be cached.

public Class<? extends CacheKeyGenerator>
cacheKeyGenerator()

The CacheKeyGenerator to use to generate the GeneratedCacheKey for interacting with the specified Cache.

public String
cacheName()

The name of the cache.

public Class<? extends CacheResolverFactory>
cacheResolverFactory()

The CacheResolverFactory used to find the CacheResolver to use at runtime.

public Class<? extends Throwable>[]
noCacheFor()

Defines zero (0) or more exception Classes, which must be a subclass of Throwable, indicating which exception types must not cause the parameter to be cached.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

afterInvocationback to summary
public boolean afterInvocation()

When Cache#put(Object, Object) should be called. If true it is called after the annotated method invocation completes successfully. If false it is called before the annotated method is invoked.

Defaults to true.

If true and the annotated method throws an exception the rules governing cacheFor() and noCacheFor() will be followed.

Annotations
@Nonbinding
cacheForback to summary
public Class<? extends Throwable>[] cacheFor()

Defines zero (0) or more exception classes, that must be a subclass of Throwable, indicating the exception types that must cause the parameter to be cached. Only used if afterInvocation() is true.

Annotations
@Nonbinding
cacheKeyGeneratorback to summary
public Class<? extends CacheKeyGenerator> cacheKeyGenerator()

The CacheKeyGenerator to use to generate the GeneratedCacheKey for interacting with the specified Cache.

Defaults to a key generator that uses Arrays#deepHashCode(Object[]) and Arrays#deepEquals(Object[], Object[]) with the array returned by CacheKeyInvocationContext#getKeyParameters()

Annotations
@Nonbinding
See Also
CacheKey
cacheNameback to summary
public String cacheName()

The name of the cache.

If not specified defaults first to CacheDefaults#cacheName() and if that is not set it defaults to: package.name.ClassName.methodName(package.ParameterType,package.ParameterType)

Annotations
@Nonbinding
cacheResolverFactoryback to summary
public Class<? extends CacheResolverFactory> cacheResolverFactory()

The CacheResolverFactory used to find the CacheResolver to use at runtime.

The default resolver pair will resolve the cache by name from the default CacheManager

Annotations
@Nonbinding
noCacheForback to summary
public Class<? extends Throwable>[] noCacheFor()

Defines zero (0) or more exception Classes, which must be a subclass of Throwable, indicating which exception types must not cause the parameter to be cached. Only used if afterInvocation() is true.

Annotations
@Nonbinding