Cacheable (Grace Framework - 2024.0.0-SNAPSHOT)

grails.cache.Cacheable

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@GroovyASTTransformationClass("org.grails.datastore.gorm.transform.OrderedGormTransformation")
@org.grails.datastore.gorm.transform.GormASTTransformationClass("org.grails.cache.compiler.CacheableTransformation")
public @interface Cacheable

Indicates that a method (or all the methods on a class) can be cached.

The method arguments and signature are used for computing the key while the returned instance is used as the cache value.

Authors:: Jeff Brown; Graeme Rocher

Since:: 2024.0.0

Element Summary

Required Element Summary
Type	Name and Description
`String[]`	`value` Name of the caches in which the update takes place.

Optional Element Summary
Type	Name and Description
`Class[]`	`condition` A closure used for conditioning the method caching.
`Class[]`	`key` A closure for computing the key dynamically.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Element Detail
  - public Class[] condition
    
    A closure used for conditioning the method caching.
    Default is null, meaning the method is always cached.
    Default:
    {}
  - public Class[] key
    
    A closure for computing the key dynamically.
    Default is null, meaning all method parameters are considered as a key.
    Default:
    {}
  - public 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.

Summary:
Required
Optional

| Detail:
Element

[Java] Annotation Type Cacheable

Element Summary

Inherited Methods Summary

Element Detail

public Class[] condition

public Class[] key

public String[] value