CacheEvict (Grails 7.0.1)

grails.plugin.cache.CacheEvict

@java.lang.annotation.Target({ElementType.METHOD, ElementType.TYPE})
@java.lang.annotation.Retention(RetentionPolicy.RUNTIME)
@java.lang.annotation.Inherited
@java.lang.annotation.Documented
@org.codehaus.groovy.transform.GroovyASTTransformationClass("org.grails.plugin.cache.compiler.CacheEvictTransformation")
public @interface CacheEvict

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

Authors:: Jeff Brown; Graeme Rocher

Element Summary

Required Element Summary
Type	Name and Description
`java.lang.String[]`	`value` Qualifier value for the specified cached operation.

Optional Element Summary
Type	Name and Description
`boolean`	`allEntries` Whether or not all the entries inside the cache(s) are removed or not.
`java.lang.Class[]`	`condition` A closure used for conditioning the method caching.
`java.lang.Class[]`	`key` A closure for computing the key dynamically.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)`

- Element Detail
  - public 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 specifying setting this parameter to true and specifying a CacheKey is not allowed.
    Default:
    false
  - public java.lang.Class[] condition
    
    A closure used for conditioning the method caching.
    Default is null, meaning the method is always cached.
    Default:
    {}
  - public java.lang.Class[] key
    
    A closure for computing the key dynamically.
    Default is null, meaning all method parameters are considered as a key.
    Default:
    {}
  - public java.lang.String[] value
    
    Qualifier value for the specified cached operation.
    May be used to determine the target cache (or caches), matching the qualifier value.

Summary:
Required
Optional

| Detail:
Element

Groovy Documentation

[Java] Annotation Type CacheEvict

Element Summary

Inherited Methods Summary

Element Detail

public boolean allEntries

public java.lang.Class[] condition

public java.lang.Class[] key

public java.lang.String[] value