Top Description Methods
org.springframework.cache.annotation

public @Interface CachePut

extends Annotation
Annotations
@Target:TYPE, METHOD
@Retention:RUNTIME
@Inherited
@Documented
@Reflective
Imports
java.lang.annotation.Documented, .ElementType, .Inherited, .Retention, .RetentionPolicy, .Target, org.springframework.aot.hint.annotation.Reflective, org.springframework.core.annotation.AliasFor

Annotation indicating that a method (or all methods on a class) triggers a cache put operation.

In contrast to the @Cacheable annotation, this annotation does not cause the advised method to be skipped. Rather, it always causes the method to be invoked and its result to be stored in the associated cache if the condition() and unless() expressions match accordingly. Note that Java8's Optional return types are automatically handled and its content is stored in the cache if present.

This annotation may be used as a meta-annotation to create custom composed annotations with attribute overrides.

Authors
Costin Leau, Phillip Webb, Stephane Nicoll, Sam Brannen
Since
3.1
See Also
CacheConfig

Method Summary

Modifier and TypeMethod and Description
public String
cacheManager()

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

public String[]
cacheNames()

Names of the caches to use for the cache put operation.

public String
public String
condition()

Spring Expression Language (SpEL) expression used for making the cache put operation conditional.

public String
key()

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

public String
public String
unless()

Spring Expression Language (SpEL) expression used to veto the cache put operation.

public String[]
value()

Alias for cacheNames.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

cacheManagerback to summary
public String cacheManager()

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

Mutually exclusive with the cacheResolver attribute.

See Also
org.springframework.cache.interceptor.SimpleCacheResolver, CacheConfig#cacheManager
cacheNamesback to summary
public String[] cacheNames()

Names of the caches to use for the cache put operation.

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

Annotations
@AliasFor:value
Since
4.2
See Also
value, CacheConfig#cacheNames
cacheResolverback to summary
public String cacheResolver()

The bean name of the custom org.springframework.cache.interceptor.CacheResolver to use.

See Also
CacheConfig#cacheResolver
conditionback to summary
public String condition()

Spring Expression Language (SpEL) expression used for making the cache put operation conditional. Update the cache if the condition evaluates to true.

This expression is evaluated after the method has been called due to the nature of the put operation and can therefore refer to the result.

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

The SpEL expression evaluates against a dedicated context that provides the following meta-data:

  • #result for a reference to the result of the method invocation. For supported wrappers such as Optional, #result refers to the actual object, not the wrapper
  • #root.method, #root.target, and #root.caches for references to the method, target object, and affected cache(s) respectively.
  • Shortcuts for the method name (#root.methodName) and target class (#root.targetClass) are also available.
  • Method arguments can be accessed by index. For instance the second argument can be accessed via #root.args[1], #p1 or #a1. Arguments can also be accessed by name if that information is available.
keyback to summary
public String key()

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

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

The SpEL expression evaluates against a dedicated context that provides the following meta-data:

  • #result for a reference to the result of the method invocation. For supported wrappers such as Optional, #result refers to the actual object, not the wrapper
  • #root.method, #root.target, and #root.caches for references to the method, target object, and affected cache(s) respectively.
  • Shortcuts for the method name (#root.methodName) and target class (#root.targetClass) are also available.
  • Method arguments can be accessed by index. For instance the second argument can be accessed via #root.args[1], #p1 or #a1. Arguments can also be accessed by name if that information is available.
keyGeneratorback to summary
public String keyGenerator()

The bean name of the custom org.springframework.cache.interceptor.KeyGenerator to use.

Mutually exclusive with the key attribute.

See Also
CacheConfig#keyGenerator
unlessback to summary
public String unless()

Spring Expression Language (SpEL) expression used to veto the cache put operation. Veto updating the cache if the condition evaluates to true.

Default is "", meaning that caching is never vetoed.

The SpEL expression evaluates against a dedicated context that provides the following meta-data:

  • #result for a reference to the result of the method invocation. For supported wrappers such as Optional, #result refers to the actual object, not the wrapper
  • #root.method, #root.target, and #root.caches for references to the method, target object, and affected cache(s) respectively.
  • Shortcuts for the method name (#root.methodName) and target class (#root.targetClass) are also available.
  • Method arguments can be accessed by index. For instance the second argument can be accessed via #root.args[1], #p1 or #a1. Arguments can also be accessed by name if that information is available.
Since
3.2
valueback to summary
public String[] value()

Alias for cacheNames.

Annotations
@AliasFor:cacheNames