Improve documentation of Caching annotations #28183
Conversation
There was missing basic information for `conditional` attribute of `Cacheable` annotation. Perhaps something similar should be added also to `unless` attribute.
There was a problem hiding this comment.
Thanks for the PR. Making it obvious that the expression should return a Boolean and what the value should be to cache the item is a nice improvement to the Javadoc.
I've made a comment of moving this as an opening statement, rather than at the end. Would you be willing to upgrade your PR in that direction?
| @@ -137,6 +137,7 @@ | |||
| * can be accessed via {@code #root.args[1]}, {@code #p1} or {@code #a1}. Arguments | |||
| * can also be accessed by name if that information is available.</li> | |||
| * </ul> | |||
| * If condition is evaluated to {@code true}, result is cached. | |||
There was a problem hiding this comment.
I think this would be better as an opening statements, rather than at the end. We should also update the paragraph about the default to mention that if no expression is set, the method result is always cached.
There was a problem hiding this comment.
Nice words for me, thanks. I am on it.
There was a problem hiding this comment.
Is it better now?
Should I squash / rebase?
snicoll
changed the title
Apply the same improvements to CacheEvict and CachePut. See gh-28183
|
@luvarqpp thank you for making your first contribution to Spring Framework. |
There was missing basic information for
conditionalattribute ofCacheableannotation. Perhaps something similar should be added also tounlessattribute.