Skip to content

Commit 122d347

Browse files
committed
Polish Javadoc for condition annotation attributes
1 parent ad6bea1 commit 122d347

File tree

5 files changed

+24
-19
lines changed

5 files changed

+24
-19
lines changed

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2014 the original author or authors.
2+
* Copyright 2002-2015 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -25,7 +25,7 @@
2525

2626
/**
2727
* Annotation indicating that a method (or all methods on a class) trigger(s)
28-
* a cache invalidate operation.
28+
* a cache eviction operation.
2929
*
3030
* @author Costin Leau
3131
* @author Stephane Nicoll
@@ -73,8 +73,9 @@
7373
String cacheResolver() default "";
7474

7575
/**
76-
* Spring Expression Language (SpEL) attribute used for conditioning the method caching.
77-
* <p>Default is "", meaning the method is always cached.
76+
* Spring Expression Language (SpEL) attribute used for making the cache
77+
* eviction operation conditional.
78+
* <p>Default is "", meaning the cache eviction is always performed.
7879
*/
7980
String condition() default "";
8081

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2014 the original author or authors.
2+
* Copyright 2002-2015 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -78,7 +78,8 @@
7878
String cacheResolver() default "";
7979

8080
/**
81-
* Spring Expression Language (SpEL) attribute used for conditioning the cache update.
81+
* Spring Expression Language (SpEL) attribute used for making the cache
82+
* put operation conditional.
8283
* <p>Default is "", meaning the method result is always cached.
8384
*/
8485
String condition() default "";

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2014 the original author or authors.
2+
* Copyright 2002-2015 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -34,7 +34,7 @@
3434
* can replace the default one ({@link #keyGenerator()}).
3535
*
3636
* <p>If no value is found in the cache for the computed key, the method is executed
37-
* and the returned instance is used as the cache value.
37+
* and the returned value is used as the cache value.
3838
*
3939
* @author Costin Leau
4040
* @author Phillip Webb
@@ -83,8 +83,9 @@
8383
String cacheResolver() default "";
8484

8585
/**
86-
* Spring Expression Language (SpEL) attribute used for conditioning the method caching.
87-
* <p>Default is "", meaning the method is always cached.
86+
* Spring Expression Language (SpEL) attribute used for making the method
87+
* caching conditional.
88+
* <p>Default is "", meaning the method result is always cached.
8889
*/
8990
String condition() default "";
9091

spring-context/src/main/java/org/springframework/context/event/EventListener.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,8 @@
5555
public @interface EventListener {
5656

5757
/**
58-
* Spring Expression Language (SpEL) attribute used for conditioning the event handling.
58+
* Spring Expression Language (SpEL) attribute used for making the event
59+
* handling conditional.
5960
* <p>Default is "", meaning the event is always handled.
6061
*/
6162
String condition() default "";

spring-tx/src/main/java/org/springframework/transaction/event/TransactionalEventListener.java

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@
2626

2727
/**
2828
* An {@link EventListener} that is invoked according to a {@link TransactionPhase}.
29-
* <p>
30-
* If the event is not published in the boundaries of a managed transaction, the event
29+
*
30+
* <p>If the event is not published within the boundaries of a managed transaction, the event
3131
* is discarded unless the {@link #fallbackExecution()} flag is explicitly set. If a
3232
* transaction is running, the event is processed according to its {@link TransactionPhase}.
33-
* <p>
34-
* Adding {@link org.springframework.core.annotation.Order @Order} on your annotated method
35-
* allows you to prioritize that listener amongst other listeners running on the same phase.
33+
*
34+
* <p>Adding {@link org.springframework.core.annotation.Order @Order} on your annotated method
35+
* allows you to prioritize that listener amongst other listeners running in the same phase.
3636
*
3737
* @author Stephane Nicoll
3838
* @since 4.2
@@ -45,7 +45,7 @@
4545

4646
/**
4747
* Phase to bind the handling of an event to. If no transaction is in progress, the
48-
* event is not processed at all unless {@link #fallbackExecution()} has been
48+
* event is not processed at all unless {@link #fallbackExecution} has been
4949
* enabled explicitly.
5050
*/
5151
TransactionPhase phase() default TransactionPhase.AFTER_COMMIT;
@@ -56,9 +56,10 @@
5656
boolean fallbackExecution() default false;
5757

5858
/**
59-
* Spring Expression Language (SpEL) attribute used for conditioning the event handling.
59+
* Spring Expression Language (SpEL) attribute used for making the event
60+
* handling conditional.
6061
* <p>Default is "", meaning the event is always handled.
61-
* @see EventListener#condition()
62+
* @see EventListener#condition
6263
*/
6364
String condition() default "";
6465

0 commit comments

Comments
 (0)