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 for condition annotation attributes

This commit is contained in:
Sam Brannen 2015-04-24 01:38:13 +02:00
parent ad6bea1cda
commit 122d3476d9
5 changed files with 24 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,5 +1,5 @@
/*
* Copyright 2002-2014 the original author or authors.
* Copyright 2002-2015 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -25,7 +25,7 @@ import java.lang.annotation.Target;
/**
* Annotation indicating that a method (or all methods on a class) trigger(s)
* a cache invalidate operation.
* a cache eviction operation.
*
* @author Costin Leau
* @author Stephane Nicoll
@ -73,8 +73,9 @@ public @interface CacheEvict {
String cacheResolver() default "";
/**
* Spring Expression Language (SpEL) attribute used for conditioning the method caching.
* <p>Default is "", meaning the method is always cached.
* Spring Expression Language (SpEL) attribute used for making the cache
* eviction operation conditional.
* <p>Default is "", meaning the cache eviction is always performed.
*/
String condition() default "";

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

@ -1,5 +1,5 @@
/*
* Copyright 2002-2014 the original author or authors.
* Copyright 2002-2015 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -78,7 +78,8 @@ public @interface CachePut {
String cacheResolver() default "";
/**
* Spring Expression Language (SpEL) attribute used for conditioning the cache update.
* Spring Expression Language (SpEL) attribute used for making the cache
* put operation conditional.
* <p>Default is "", meaning the method result is always cached.
*/
String condition() default "";

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

@ -1,5 +1,5 @@
/*
* Copyright 2002-2014 the original author or authors.
* Copyright 2002-2015 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -34,7 +34,7 @@ import java.lang.annotation.Target;
* can replace the default one ({@link #keyGenerator()}).
*
* <p>If no value is found in the cache for the computed key, the method is executed
* and the returned instance is used as the cache value.
* and the returned value is used as the cache value.
*
* @author Costin Leau
* @author Phillip Webb
@ -83,8 +83,9 @@ public @interface Cacheable {
String cacheResolver() default "";
/**
* Spring Expression Language (SpEL) attribute used for conditioning the method caching.
* <p>Default is "", meaning the method is always cached.
* Spring Expression Language (SpEL) attribute used for making the method
* caching conditional.
* <p>Default is "", meaning the method result is always cached.
*/
String condition() default "";

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

@ -55,7 +55,8 @@ import org.springframework.context.ApplicationEvent;
public @interface EventListener {
/**
* Spring Expression Language (SpEL) attribute used for conditioning the event handling.
* Spring Expression Language (SpEL) attribute used for making the event
* handling conditional.
* <p>Default is "", meaning the event is always handled.
*/
String condition() default "";

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

@ -26,13 +26,13 @@ import org.springframework.context.event.EventListener;
/**
* An {@link EventListener} that is invoked according to a {@link TransactionPhase}.
* <p>
* If the event is not published in the boundaries of a managed transaction, the event
*
* <p>If the event is not published within the boundaries of a managed transaction, the event
* is discarded unless the {@link #fallbackExecution()} flag is explicitly set. If a
* transaction is running, the event is processed according to its {@link TransactionPhase}.
* <p>
* Adding {@link org.springframework.core.annotation.Order @Order} on your annotated method
* allows you to prioritize that listener amongst other listeners running on the same phase.
*
* <p>Adding {@link org.springframework.core.annotation.Order @Order} on your annotated method
* allows you to prioritize that listener amongst other listeners running in the same phase.
*
* @author Stephane Nicoll
* @since 4.2
@ -45,7 +45,7 @@ public @interface TransactionalEventListener {
/**
* Phase to bind the handling of an event to. If no transaction is in progress, the
* event is not processed at all unless {@link #fallbackExecution()} has been
* event is not processed at all unless {@link #fallbackExecution} has been
* enabled explicitly.
*/
TransactionPhase phase() default TransactionPhase.AFTER_COMMIT;
@ -56,9 +56,10 @@ public @interface TransactionalEventListener {
boolean fallbackExecution() default false;
/**
* Spring Expression Language (SpEL) attribute used for conditioning the event handling.
* Spring Expression Language (SpEL) attribute used for making the event
* handling conditional.
* <p>Default is "", meaning the event is always handled.
* @see EventListener#condition()
* @see EventListener#condition
*/
String condition() default "";