Browse Source

Improve Javadoc for caching annotations

pull/35405/head
Sam Brannen 5 months ago
parent
commit
ad00aebaa3
  1. 2
      spring-context/src/main/java/org/springframework/cache/annotation/CacheConfig.java
  2. 4
      spring-context/src/main/java/org/springframework/cache/annotation/CacheEvict.java
  3. 4
      spring-context/src/main/java/org/springframework/cache/annotation/CachePut.java
  4. 4
      spring-context/src/main/java/org/springframework/cache/annotation/Cacheable.java

2
spring-context/src/main/java/org/springframework/cache/annotation/CacheConfig.java vendored

@ -35,6 +35,8 @@ import org.springframework.core.annotation.AliasFor; @@ -35,6 +35,8 @@ import org.springframework.core.annotation.AliasFor;
* @author Sam Brannen
* @since 4.1
* @see Cacheable
* @see CachePut
* @see CacheEvict
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)

4
spring-context/src/main/java/org/springframework/cache/annotation/CacheEvict.java vendored

@ -38,6 +38,8 @@ import org.springframework.core.annotation.AliasFor; @@ -38,6 +38,8 @@ import org.springframework.core.annotation.AliasFor;
* @author Sam Brannen
* @since 3.1
* @see CacheConfig
* @see Cacheable
* @see CachePut
*/
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@ -48,6 +50,8 @@ public @interface CacheEvict { @@ -48,6 +50,8 @@ public @interface CacheEvict {
/**
* Alias for {@link #cacheNames}.
* <p>Intended to be used when no other attributes are needed, for example:
* {@code @CacheEvict("books")}.
*/
@AliasFor("cacheNames")
String[] value() default {};

4
spring-context/src/main/java/org/springframework/cache/annotation/CachePut.java vendored

@ -46,6 +46,8 @@ import org.springframework.core.annotation.AliasFor; @@ -46,6 +46,8 @@ import org.springframework.core.annotation.AliasFor;
* @author Sam Brannen
* @since 3.1
* @see CacheConfig
* @see Cacheable
* @see CacheEvict
*/
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@ -56,6 +58,8 @@ public @interface CachePut { @@ -56,6 +58,8 @@ public @interface CachePut {
/**
* Alias for {@link #cacheNames}.
* <p>Intended to be used when no other attributes are needed, for example:
* {@code @CachePut("books")}.
*/
@AliasFor("cacheNames")
String[] value() default {};

4
spring-context/src/main/java/org/springframework/cache/annotation/Cacheable.java vendored

@ -54,6 +54,8 @@ import org.springframework.core.annotation.AliasFor; @@ -54,6 +54,8 @@ import org.springframework.core.annotation.AliasFor;
* @author Sam Brannen
* @since 3.1
* @see CacheConfig
* @see CachePut
* @see CacheEvict
*/
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@ -64,6 +66,8 @@ public @interface Cacheable { @@ -64,6 +66,8 @@ public @interface Cacheable {
/**
* Alias for {@link #cacheNames}.
* <p>Intended to be used when no other attributes are needed, for example:
* {@code @Cacheable("books")}.
*/
@AliasFor("cacheNames")
String[] value() default {};

Loading…
Cancel
Save