Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: REQUIRED | OPTIONAL DETAIL: ELEMENT

grails.plugin.cache
[Java] Annotation Type CachePut

java.lang.Object
  grails.plugin.cache.CachePut

@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@GroovyASTTransformationClass("grails.plugin.cache.compiler.CacheTransformation")
public @interface CachePut

Indicates that a method (or all methods on a class) trigger(s) a Cache#put(Object, Object)#put(Object, Object) operation. As opposed to Cacheable annotation, this annotation does not cause the target method to be skipped - rather it always causes the method to be invoked and its result to be placed into the cache.

Authors:
Jeff Brown

Required Element Summary
java.lang.String value

Name of the caches in which the update takes place.
 
Optional Element Summary
java.lang.String condition

Spring Expression Language (SpEL) attribute used for conditioning the cache update.
java.lang.String key

Spring Expression Language (SpEL) attribute for computing the key dynamically.
 
Method Summary
 
Methods inherited from class java.lang.Object
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Element Detail

condition

java.lang.String condition
Spring Expression Language (SpEL) attribute used for conditioning the cache update.

Default is "", meaning the method result is always cached. @default String condition() default ""

key

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

Default is "", meaning all method parameters are considered as a key. @default String key() default ""

value

java.lang.String[] value
Name of the caches in which the update takes place.

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

 

Groovy Documentation