Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polish "Improve documentation of Cacheable"

Browse Source 
Apply the same improvements to CacheEvict and CachePut.

See gh-28183
This commit is contained in:
Stephane Nicoll
2022-07-29 18:04:23 +02:00
parent 3a61930bd0
commit 04209def46
3 changed files with 11 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
spring-context/src/main/java/org/springframework/cache/annotation/CacheEvict.java vendored
View File

@@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2016 the original author or authors. * Copyright 2002-2022 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@@ -111,7 +111,8 @@ public @interface CacheEvict {
/** /**
* Spring Expression Language (SpEL) expression used for making the cache * Spring Expression Language (SpEL) expression used for making the cache
* eviction operation conditional. * eviction operation conditional. Evict that cache if the condition evaluates
* to {@code true}.
* <p>Default is {@code ""}, meaning the cache eviction is always performed. * <p>Default is {@code ""}, meaning the cache eviction is always performed.
* <p>The SpEL expression evaluates against a dedicated context that provides the * <p>The SpEL expression evaluates against a dedicated context that provides the
* following meta-data: * following meta-data:

6
spring-context/src/main/java/org/springframework/cache/annotation/CachePut.java vendored
View File

@@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2021 the original author or authors. * Copyright 2002-2022 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@@ -118,7 +118,8 @@ public @interface CachePut {
/** /**
* Spring Expression Language (SpEL) expression used for making the cache * Spring Expression Language (SpEL) expression used for making the cache
* put operation conditional. * put operation conditional. Update the cache if the condition evaluates to
* {@code true}.
* <p>This expression is evaluated after the method has been called due to the * <p>This expression is evaluated after the method has been called due to the
* nature of the put operation and can therefore refer to the {@code result}. * nature of the put operation and can therefore refer to the {@code result}.
* <p>Default is {@code ""}, meaning the method result is always cached. * <p>Default is {@code ""}, meaning the method result is always cached.
@@ -142,6 +143,7 @@ public @interface CachePut {
/** /**
* Spring Expression Language (SpEL) expression used to veto the cache put operation. * Spring Expression Language (SpEL) expression used to veto the cache put operation.
* Veto updating the cache if the condition evaluates to {@code true}.
* <p>Default is {@code ""}, meaning that caching is never vetoed. * <p>Default is {@code ""}, meaning that caching is never vetoed.
* <p>The SpEL expression evaluates against a dedicated context that provides the * <p>The SpEL expression evaluates against a dedicated context that provides the
* following meta-data: * following meta-data:

7
spring-context/src/main/java/org/springframework/cache/annotation/Cacheable.java vendored
View File

@@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2021 the original author or authors. * Copyright 2002-2022 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@@ -123,8 +123,8 @@ public @interface Cacheable {
/** /**
* Spring Expression Language (SpEL) expression used for making the method * Spring Expression Language (SpEL) expression used for making the method
* caching conditional. If condition is evaluated to {@code true}, result * caching conditional. Cache the result if the condition evaluates to
* is cached. * {@code true}.
* <p>Default is {@code ""}, meaning the method result is always cached. * <p>Default is {@code ""}, meaning the method result is always cached.
* <p>The SpEL expression evaluates against a dedicated context that provides the * <p>The SpEL expression evaluates against a dedicated context that provides the
* following meta-data: * following meta-data:
@@ -143,6 +143,7 @@ public @interface Cacheable {
/** /**
* Spring Expression Language (SpEL) expression used to veto method caching. * Spring Expression Language (SpEL) expression used to veto method caching.
* Veto caching the result if the condition evaluates to {@code true}.
* <p>Unlike {@link #condition}, this expression is evaluated after the method * <p>Unlike {@link #condition}, this expression is evaluated after the method
* has been called and can therefore refer to the {@code result}. * has been called and can therefore refer to the {@code result}.
* <p>Default is {@code ""}, meaning that caching is never vetoed. * <p>Default is {@code ""}, meaning that caching is never vetoed.