Annotation Type CacheRemoveAll
-
@Target({METHOD,TYPE}) @Retention(RUNTIME) public @interface CacheRemoveAll
When a method annotated withCacheRemoveAll
is invoked all elements in the specified cache will be removed via theCache.removeAll()
methodThe default behavior is to call
Cache.removeAll()
after the annotated method is invoked, this behavior can be changed by settingafterInvocation()
to false in which caseCache.removeAll()
will be called before the annotated method is invoked.Example of removing all Domain objects from the "domainCache".
Cache.removeAll()
will be called after deleteAllDomains() returns successfully.package my.app; public class DomainDao { @CacheRemoveAll(cacheName="domainCache") public void deleteAllDomains() { ... } }
Exception Handling, only used if
afterInvocation()
is true.- If
evictFor()
andnoEvictFor()
are both empty then all exceptions prevent the removeAll - If
evictFor()
is specified andnoEvictFor()
is not specified then only exceptions that pass an instanceof check against the evictFor list result in a removeAll - If
noEvictFor()
is specified andevictFor()
is not specified then all exceptions that do not pass an instanceof check against the noEvictFor result in a removeAll - If
evictFor()
andnoEvictFor()
are both specified then exceptions that pass an instanceof check against the evictFor list but do not pass an instanceof check against the noEvictFor list result in a removeAll
- Since:
- 1.0
- If
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description boolean
afterInvocation
WhenCache.removeAll()
should be called.java.lang.String
cacheName
/** The name of the cache.java.lang.Class<? extends CacheResolverFactory>
cacheResolverFactory
TheCacheResolverFactory
used to find theCacheResolver
to use at runtime.java.lang.Class<? extends java.lang.Throwable>[]
evictFor
Defines zero (0) or more exceptionclasses
, that must be a subclass ofThrowable
, indicating the exception types that must cause a cache eviction.java.lang.Class<? extends java.lang.Throwable>[]
noEvictFor
Defines zero (0) or more exceptionClasses
, that must be a subclass ofThrowable
, indicating the exception types that must not cause a cache eviction.
-
-
-
Element Detail
-
cacheName
java.lang.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)- Default:
- ""
-
-
-
afterInvocation
boolean afterInvocation
WhenCache.removeAll()
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 removeAll will not be executed.
- Default:
- true
-
-
-
cacheResolverFactory
java.lang.Class<? extends CacheResolverFactory> cacheResolverFactory
TheCacheResolverFactory
used to find theCacheResolver
to use at runtime.The default resolver pair will resolve the cache by name from the default
CacheManager
- Default:
- javax.cache.annotation.CacheResolverFactory.class
-
-
-
evictFor
java.lang.Class<? extends java.lang.Throwable>[] evictFor
Defines zero (0) or more exceptionclasses
, that must be a subclass ofThrowable
, indicating the exception types that must cause a cache eviction. Only used ifafterInvocation()
is true.- Default:
- {}
-
-
-
noEvictFor
java.lang.Class<? extends java.lang.Throwable>[] noEvictFor
Defines zero (0) or more exceptionClasses
, that must be a subclass ofThrowable
, indicating the exception types that must not cause a cache eviction. Only used ifafterInvocation()
is true.- Default:
- {}
-
-