RESOLVED - issue SPR-6398: Document attributes in @Scheduled and friends

http://jira.springframework.org/browse/SPR-6398
This commit is contained in:
David Syer 2009-11-20 12:36:02 +00:00
parent 5716360936
commit af674bfac4
2 changed files with 21 additions and 1 deletions

View File

@ -31,6 +31,7 @@ import java.lang.annotation.Target;
* <code>void</code> return type.
*
* @author Mark Fisher
* @author Dave Syer
* @since 3.0
* @see ScheduledAnnotationBeanPostProcessor
*/
@ -39,10 +40,29 @@ import java.lang.annotation.Target;
@Documented
public @interface Scheduled {
/**
* A cron-like expression, extending the usual UN*X definition to include
* triggers on the second as well as minute, hour, day of month, month
* and day of week. e.g. <code>"0 * * * * MON-FRI"</code> means once
* per minute on weekdays (at the top of the minute - the 0th second).
*
* @return an expression that can be parsed to a cron schedule
*/
String cron() default "";
/**
* Execute the annotated method with a fixed period between the end
* of the last invocation and the start of the next.
*
* @return the delay in milliseconds
*/
long fixedDelay() default -1;
/**
* Execute the annotated method with a fixed period between invocations.
*
* @return the period in milliseconds
*/
long fixedRate() default -1;
}

View File

@ -20,7 +20,7 @@
<xsd:element name="annotation-driven">
<xsd:annotation>
<xsd:documentation><![CDATA[
Enables the detection of @Async annotations on any Spring-managed object. If present,
Enables the detection of @Async and @Scheduled annotations on any Spring-managed object. If present,
a proxy will be generated for executing the annotated methods asynchronously.
]]></xsd:documentation>
</xsd:annotation>