Improve Javadoc for caching annotations

This commit is contained in:
Sam Brannen
2025-07-07 12:11:41 +02:00
parent d07ed31fed
commit ad00aebaa3
4 changed files with 14 additions and 0 deletions
@@ -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)
@@ -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 {
/**
* 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 {};
@@ -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 {
/**
* 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 {};
@@ -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 {
/**
* 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 {};