javax.cache.annotation
Annotation Type CacheRemoveEntry

@Target(value={METHOD,TYPE})
@Retention(value=RUNTIME)
public @interface CacheRemoveEntry

When a method annotated with CacheRemoveEntry is invoked a CacheKey will be generated and Cache.remove(Object) will be invoked on the specified cache.

Example of removing a specific Domain object from the "domainCache". A CacheKey will be generated from the String and int parameters and used to call Cache.remove(Object) after the deleteDomain method completes successfully.

 package my.app;
 
 public class DomainDao {
   @CacheRemoveEntry(cacheName="domainCache")
   public void deleteDomain(String domainId, int index) {
     ...
   }
 }
 

Since:

1.0

Author:

Eric Dalquist, Rick Hightower

Optional Element Summary

boolean	afterInvocation (Optional) When Cache.remove(Object) should be called.
Class<? extends CacheKeyGenerator>	cacheKeyGenerator (Optional) The CacheKeyGenerator to use to generate the cache key used to call Cache.remove(Object) Defaults to a key generator that uses Arrays.deepHashCode(Object[]) and Arrays.deepEquals(Object[], Object[]) with the array returned by CacheKeyInvocationContext.getKeyParameters()
String	cacheName (Optional) name of the cache.
Class<? extends CacheResolverFactory>	cacheResolverFactory (Optional) The CacheResolverFactory to use to find the CacheResolver the intercepter will interact with.

cacheName

public abstract String cacheName

(Optional) name of the cache.

If not specified defaults first to CacheDefaults.cacheName() an if that is not set it an unspecified exception will be thrown by the provider.

Default:

""

afterInvocation

public abstract boolean afterInvocation

(Optional) When Cache.remove(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 put will not be executed.

Default:

true

cacheResolverFactory

public abstract Class<? extends CacheResolverFactory> cacheResolverFactory

(Optional) The CacheResolverFactory to use to find the CacheResolver the intercepter will interact with.

Defaults to resolving the cache by name from the default CacheManager

Default:

javax.cache.annotation.CacheResolverFactory.class

cacheKeyGenerator

public abstract Class<? extends CacheKeyGenerator> cacheKeyGenerator

(Optional) The CacheKeyGenerator to use to generate the cache key used to call Cache.remove(Object)

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

Default:

javax.cache.annotation.CacheKeyGenerator.class