root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 6 Packages Projects Releases Wiki Activity

Document which @Scheduled attributes support SpEL expressions 

Closes gh-29290
This commit is contained in:
Juergen Hoeller 2023-06-12 12:55:09 +02:00
parent cc8c852c2b
commit f8c8873c99
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
spring-context/src/main/java/org/springframework/scheduling/annotation/Scheduled.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2021 the original author or authors. * Copyright 2002-2023 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -122,9 +122,12 @@ public @interface Scheduled {
* last invocation and the start of the next. * last invocation and the start of the next.
* <p>The time unit is milliseconds by default but can be overridden via * <p>The time unit is milliseconds by default but can be overridden via
* {@link #timeUnit}. * {@link #timeUnit}.
* <p>This attribute variant supports Spring-style "${...}" placeholders
* as well as SpEL expressions.
* @return the delay as a String value &mdash; for example, a placeholder * @return the delay as a String value &mdash; for example, a placeholder
* or a {@link java.time.Duration#parse java.time.Duration} compliant value * or a {@link java.time.Duration#parse java.time.Duration} compliant value
* @since 3.2.2 * @since 3.2.2
* @see #fixedDelay()
*/ */
String fixedDelayString() default ""; String fixedDelayString() default "";
@ -140,9 +143,12 @@ public @interface Scheduled {
* Execute the annotated method with a fixed period between invocations. * Execute the annotated method with a fixed period between invocations.
* <p>The time unit is milliseconds by default but can be overridden via * <p>The time unit is milliseconds by default but can be overridden via
* {@link #timeUnit}. * {@link #timeUnit}.
* <p>This attribute variant supports Spring-style "${...}" placeholders
* as well as SpEL expressions.
* @return the period as a String value &mdash; for example, a placeholder * @return the period as a String value &mdash; for example, a placeholder
* or a {@link java.time.Duration#parse java.time.Duration} compliant value * or a {@link java.time.Duration#parse java.time.Duration} compliant value
* @since 3.2.2 * @since 3.2.2
* @see #fixedRate()
*/ */
String fixedRateString() default ""; String fixedRateString() default "";
@ -161,9 +167,12 @@ public @interface Scheduled {
* {@link #fixedRate} or {@link #fixedDelay} task. * {@link #fixedRate} or {@link #fixedDelay} task.
* <p>The time unit is milliseconds by default but can be overridden via * <p>The time unit is milliseconds by default but can be overridden via
* {@link #timeUnit}. * {@link #timeUnit}.
* <p>This attribute variant supports Spring-style "${...}" placeholders
* as well as SpEL expressions.
* @return the initial delay as a String value &mdash; for example, a placeholder * @return the initial delay as a String value &mdash; for example, a placeholder
* or a {@link java.time.Duration#parse java.time.Duration} compliant value * or a {@link java.time.Duration#parse java.time.Duration} compliant value
* @since 3.2.2 * @since 3.2.2
* @see #initialDelay()
*/ */
String initialDelayString() default ""; String initialDelayString() default "";