org.springframework.cache.annotation

Annotation Type CacheEvict

@Target(value={METHOD,TYPE})
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
public @interface CacheEvict

Annotation indicating that a method (or all methods on a class) trigger(s) a cache invalidate operation.

Since:

3.1

Author:

Costin Leau, Stephane Nicoll

See Also:

CacheConfig

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	allEntries Whether or not all the entries inside the cache(s) are removed or not.
boolean	beforeInvocation Whether the eviction should occur after the method is successfully invoked (default) or before.
String	cacheManager The bean name of the custom CacheManager to use to create a default CacheResolver if none is set already.
String	cacheResolver The bean name of the custom CacheResolver to use.
String	condition Spring Expression Language (SpEL) attribute used for conditioning the method caching.
String	key Spring Expression Language (SpEL) attribute for computing the key dynamically.
String	keyGenerator The bean name of the custom KeyGenerator to use.
String[]	value Qualifier value for the specified cached operation.

Element Detail

value

public abstract String[] value

Qualifier value for the specified cached operation.

May be used to determine the target cache (or caches), matching the qualifier value (or the bean name(s)) of (a) specific bean definition.

Default:

{}

key

public abstract String key

Spring Expression Language (SpEL) attribute for computing the key dynamically.

Default is "", meaning all method parameters are considered as a key, unless a custom keyGenerator() has been set.

Default:

""

keyGenerator

public abstract String keyGenerator

The bean name of the custom KeyGenerator to use.

Mutually exclusive with the key() attribute.

Default:

""

cacheManager

public abstract String cacheManager

The bean name of the custom CacheManager to use to create a default CacheResolver if none is set already.

Mutually exclusive with the cacheResolver() attribute.

See Also:

SimpleCacheResolver

Default:

""

cacheResolver

public abstract String cacheResolver

The bean name of the custom CacheResolver to use.

Default:

""

condition

public abstract String condition

Spring Expression Language (SpEL) attribute used for conditioning the method caching.

Default is "", meaning the method is always cached.

Default:

""

allEntries

public abstract boolean allEntries

Whether or not all the entries inside the cache(s) are removed or not. By default, only the value under the associated key is removed.

Note that setting this parameter to true and specifying a key() is not allowed.

Default:

false

beforeInvocation

public abstract boolean beforeInvocation

Whether the eviction should occur after the method is successfully invoked (default) or before. The latter causes the eviction to occur irrespective of the method outcome (whether it threw an exception or not) while the former does not.

Default:

false