root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Polish Javadoc in @Cache* annotations

This commit is contained in:
Sam Brannen 2015-12-17 17:05:33 +01:00
parent 752d3c715a
commit 93de3553c1
3 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -62,18 +62,18 @@ public @interface CacheEvict {
* Spring Expression Language (SpEL) expression for computing the key dynamically. * Spring Expression Language (SpEL) expression for computing the key dynamically.
* <p>Default is {@code ""}, meaning all method parameters are considered as a key, * <p>Default is {@code ""}, meaning all method parameters are considered as a key,
* unless a custom {@link #keyGenerator} has been set. * unless a custom {@link #keyGenerator} has been set.
* <p>The SpEL expression evaluates again a dedicated context that provides the * <p>The SpEL expression evaluates against a dedicated context that provides the
* following meta-data: * following meta-data:
* <ul> * <ul>
* <li>{@code #result} for a reference to the result of the method invocation, which * <li>{@code #result} for a reference to the result of the method invocation, which
* can only be used if {@link #beforeInvocation()} is {@code false}.</li> * can only be used if {@link #beforeInvocation()} is {@code false}.</li>
* <li>{@code #root.method}, {@code #root.target} and {@code #root.caches} for a * <li>{@code #root.method}, {@code #root.target}, and {@code #root.caches} for
* reference to the {@link java.lang.reflect.Method method}, target object and * references to the {@link java.lang.reflect.Method method}, target object, and
* affected cache(s) respectively.</li> * affected cache(s) respectively.</li>
* <li>Shortcuts for the method name ({@code #root.methodName}) and target class * <li>Shortcuts for the method name ({@code #root.methodName}) and target class
* ({@code #root.targetClass}) are also available. * ({@code #root.targetClass}) are also available.
* <li>Method arguments can be accessed by index. For instance the second argument * <li>Method arguments can be accessed by index. For instance the second argument
* can be access via {@code #root.args[1]}, {@code #p1} or {@code #a1}. Arguments * 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> * can also be accessed by name if that information is available.</li>
* </ul> * </ul>
*/ */
@ -108,16 +108,16 @@ 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.
* <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 again a dedicated context that provides the * <p>The SpEL expression evaluates against a dedicated context that provides the
* following meta-data: * following meta-data:
* <ul> * <ul>
* <li>{@code #root.method}, {@code #root.target} and {@code #root.caches} for a * <li>{@code #root.method}, {@code #root.target}, and {@code #root.caches} for
* reference to the {@link java.lang.reflect.Method method}, target object and * references to the {@link java.lang.reflect.Method method}, target object, and
* affected cache(s) respectively.</li> * affected cache(s) respectively.</li>
* <li>Shortcuts for the method name ({@code #root.methodName}) and target class * <li>Shortcuts for the method name ({@code #root.methodName}) and target class
* ({@code #root.targetClass}) are also available. * ({@code #root.targetClass}) are also available.
* <li>Method arguments can be accessed by index. For instance the second argument * <li>Method arguments can be accessed by index. For instance the second argument
* can be access via {@code #root.args[1]}, {@code #p1} or {@code #a1}. Arguments * 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> * can also be accessed by name if that information is available.</li>
* </ul> * </ul>
*/ */

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

@ -67,17 +67,17 @@ public @interface CachePut {
* Spring Expression Language (SpEL) expression for computing the key dynamically. * Spring Expression Language (SpEL) expression for computing the key dynamically.
* <p>Default is {@code ""}, meaning all method parameters are considered as a key, * <p>Default is {@code ""}, meaning all method parameters are considered as a key,
* unless a custom {@link #keyGenerator} has been set. * unless a custom {@link #keyGenerator} has been set.
* <p>The SpEL expression evaluates again a dedicated context that provides the * <p>The SpEL expression evaluates against a dedicated context that provides the
* following meta-data: * following meta-data:
* <ul> * <ul>
* <li>{@code #result} for a reference to the result of the method invocation.</li> * <li>{@code #result} for a reference to the result of the method invocation.</li>
* <li>{@code #root.method}, {@code #root.target} and {@code #root.caches} for a * <li>{@code #root.method}, {@code #root.target}, and {@code #root.caches} for
* reference to the {@link java.lang.reflect.Method method}, target object and * references to the {@link java.lang.reflect.Method method}, target object, and
* affected cache(s) respectively.</li> * affected cache(s) respectively.</li>
* <li>Shortcuts for the method name ({@code #root.methodName}) and target class * <li>Shortcuts for the method name ({@code #root.methodName}) and target class
* ({@code #root.targetClass}) are also available. * ({@code #root.targetClass}) are also available.
* <li>Method arguments can be accessed by index. For instance the second argument * <li>Method arguments can be accessed by index. For instance the second argument
* can be access via {@code #root.args[1]}, {@code #p1} or {@code #a1}. Arguments * 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> * can also be accessed by name if that information is available.</li>
* </ul> * </ul>
*/ */
@ -112,16 +112,16 @@ 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.
* <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 again a dedicated context that provides the * <p>The SpEL expression evaluates against a dedicated context that provides the
* following meta-data: * following meta-data:
* <ul> * <ul>
* <li>{@code #root.method}, {@code #root.target} and {@code #root.caches} for a * <li>{@code #root.method}, {@code #root.target}, and {@code #root.caches} for
* reference to the {@link java.lang.reflect.Method method}, target object and * references to the {@link java.lang.reflect.Method method}, target object, and
* affected cache(s) respectively.</li> * affected cache(s) respectively.</li>
* <li>Shortcuts for the method name ({@code #root.methodName}) and target class * <li>Shortcuts for the method name ({@code #root.methodName}) and target class
* ({@code #root.targetClass}) are also available. * ({@code #root.targetClass}) are also available.
* <li>Method arguments can be accessed by index. For instance the second argument * <li>Method arguments can be accessed by index. For instance the second argument
* can be access via {@code #root.args[1]}, {@code #p1} or {@code #a1}. Arguments * 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> * can also be accessed by name if that information is available.</li>
* </ul> * </ul>
*/ */
@ -132,17 +132,17 @@ public @interface CachePut {
* <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.
* <p>The SpEL expression evaluates again a dedicated context that provides the * <p>The SpEL expression evaluates against a dedicated context that provides the
* following meta-data: * following meta-data:
* <ul> * <ul>
* <li>{@code #result} for a reference to the result of the method invocation.</li> * <li>{@code #result} for a reference to the result of the method invocation.</li>
* <li>{@code #root.method}, {@code #root.target} and {@code #root.caches} for a * <li>{@code #root.method}, {@code #root.target}, and {@code #root.caches} for
* reference to the {@link java.lang.reflect.Method method}, target object and * references to the {@link java.lang.reflect.Method method}, target object, and
* affected cache(s) respectively.</li> * affected cache(s) respectively.</li>
* <li>Shortcuts for the method name ({@code #root.methodName}) and target class * <li>Shortcuts for the method name ({@code #root.methodName}) and target class
* ({@code #root.targetClass}) are also available. * ({@code #root.targetClass}) are also available.
* <li>Method arguments can be accessed by index. For instance the second argument * <li>Method arguments can be accessed by index. For instance the second argument
* can be access via {@code #root.args[1]}, {@code #p1} or {@code #a1}. Arguments * 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> * can also be accessed by name if that information is available.</li>
* </ul> * </ul>
* @since 3.2 * @since 3.2

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

@ -73,16 +73,16 @@ public @interface Cacheable {
* Spring Expression Language (SpEL) expression for computing the key dynamically. * Spring Expression Language (SpEL) expression for computing the key dynamically.
* <p>Default is {@code ""}, meaning all method parameters are considered as a key, * <p>Default is {@code ""}, meaning all method parameters are considered as a key,
* unless a custom {@link #keyGenerator} has been configured. * unless a custom {@link #keyGenerator} has been configured.
* <p>The SpEL expression evaluates again a dedicated context that provides the * <p>The SpEL expression evaluates against a dedicated context that provides the
* following meta-data: * following meta-data:
* <ul> * <ul>
* <li>{@code #root.method}, {@code #root.target} and {@code #root.caches} for a * <li>{@code #root.method}, {@code #root.target}, and {@code #root.caches} for
* reference to the {@link java.lang.reflect.Method method}, target object and * references to the {@link java.lang.reflect.Method method}, target object, and
* affected cache(s) respectively.</li> * affected cache(s) respectively.</li>
* <li>Shortcuts for the method name ({@code #root.methodName}) and target class * <li>Shortcuts for the method name ({@code #root.methodName}) and target class
* ({@code #root.targetClass}) are also available. * ({@code #root.targetClass}) are also available.
* <li>Method arguments can be accessed by index. For instance the second argument * <li>Method arguments can be accessed by index. For instance the second argument
* can be access via {@code #root.args[1]}, {@code #p1} or {@code #a1}. Arguments * 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> * can also be accessed by name if that information is available.</li>
* </ul> * </ul>
*/ */
@ -117,16 +117,16 @@ 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. * caching conditional.
* <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 again a dedicated context that provides the * <p>The SpEL expression evaluates against a dedicated context that provides the
* following meta-data: * following meta-data:
* <ul> * <ul>
* <li>{@code #root.method}, {@code #root.target} and {@code #root.caches} for a * <li>{@code #root.method}, {@code #root.target}, and {@code #root.caches} for
* reference to the {@link java.lang.reflect.Method method}, target object and * references to the {@link java.lang.reflect.Method method}, target object, and
* affected cache(s) respectively.</li> * affected cache(s) respectively.</li>
* <li>Shortcuts for the method name ({@code #root.methodName}) and target class * <li>Shortcuts for the method name ({@code #root.methodName}) and target class
* ({@code #root.targetClass}) are also available. * ({@code #root.targetClass}) are also available.
* <li>Method arguments can be accessed by index. For instance the second argument * <li>Method arguments can be accessed by index. For instance the second argument
* can be access via {@code #root.args[1]}, {@code #p1} or {@code #a1}. Arguments * 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> * can also be accessed by name if that information is available.</li>
* </ul> * </ul>
*/ */
@ -137,17 +137,17 @@ public @interface Cacheable {
* <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.
* <p>The SpEL expression evaluates again a dedicated context that provides the * <p>The SpEL expression evaluates against a dedicated context that provides the
* following meta-data: * following meta-data:
* <ul> * <ul>
* <li>{@code #result} for a reference to the result of the method invocation.</li> * <li>{@code #result} for a reference to the result of the method invocation.</li>
* <li>{@code #root.method}, {@code #root.target} and {@code #root.caches} for a * <li>{@code #root.method}, {@code #root.target}, and {@code #root.caches} for
* reference to the {@link java.lang.reflect.Method method}, target object and * references to the {@link java.lang.reflect.Method method}, target object, and
* affected cache(s) respectively.</li> * affected cache(s) respectively.</li>
* <li>Shortcuts for the method name ({@code #root.methodName}) and target class * <li>Shortcuts for the method name ({@code #root.methodName}) and target class
* ({@code #root.targetClass}) are also available. * ({@code #root.targetClass}) are also available.
* <li>Method arguments can be accessed by index. For instance the second argument * <li>Method arguments can be accessed by index. For instance the second argument
* can be access via {@code #root.args[1]}, {@code #p1} or {@code #a1}. Arguments * 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> * can also be accessed by name if that information is available.</li>
* </ul> * </ul>
* @since 3.2 * @since 3.2