Spring Context 6.1.4 · org.springframework.scheduling.TaskScheduler

Method Summary

Modifier and Type	Method and Description
public default Clock	getClock() Return the clock to use for scheduling purposes.
public ScheduledFuture<?>	Returns: a `ScheduledFuture` representing pending completion of the task, or `null` if the given Trigger object never fires (i.e. returns `null` from `Trigger#nextExecution`) schedule(Runnable the Runnable to execute whenever the trigger fires task, Trigger an implementation of the `Trigger` interface, e.g. a `org.springframework.scheduling.support.CronTrigger` object wrapping a cron expression trigger) Schedule the given `Runnable`, invoking it whenever the trigger indicates a next execution time.
public ScheduledFuture<?>	Returns: a `ScheduledFuture` representing pending completion of the task schedule(Runnable the Runnable to execute whenever the trigger fires task, Instant the desired execution time for the task (if this is in the past, the task will be executed immediately, i.e. as soon as possible) startTime) Schedule the given `Runnable`, invoking it at the specified execution time.
public default ScheduledFuture<?>	Returns: a `ScheduledFuture` representing pending completion of the task schedule(Runnable the Runnable to execute whenever the trigger fires task, Date the desired execution time for the task (if this is in the past, the task will be executed immediately, i.e. as soon as possible) startTime) Deprecated since 6.0. as of 6.0, in favor of `schedule(Runnable, Instant)` Schedule the given `Runnable`, invoking it at the specified execution time.
public ScheduledFuture<?>	Returns: a `ScheduledFuture` representing pending completion of the task scheduleAtFixedRate(Runnable the Runnable to execute whenever the trigger fires task, Instant the desired first execution time for the task (if this is in the past, the task will be executed immediately, i.e. as soon as possible) startTime, Duration the interval between successive executions of the task period) Schedule the given `Runnable`, invoking it at the specified execution time and subsequently with the given period.
public default ScheduledFuture<?>	Returns: a `ScheduledFuture` representing pending completion of the task scheduleAtFixedRate(Runnable the Runnable to execute whenever the trigger fires task, Date the desired first execution time for the task (if this is in the past, the task will be executed immediately, i.e. as soon as possible) startTime, long the interval between successive executions of the task (in milliseconds) period) Deprecated since 6.0. as of 6.0, in favor of `scheduleAtFixedRate(Runnable, Instant, Duration)` Schedule the given `Runnable`, invoking it at the specified execution time and subsequently with the given period.
public ScheduledFuture<?>	Returns: a `ScheduledFuture` representing pending completion of the task scheduleAtFixedRate(Runnable the Runnable to execute whenever the trigger fires task, Duration the interval between successive executions of the task period) Schedule the given `Runnable`, starting as soon as possible and invoking it with the given period.
public default ScheduledFuture<?>	Returns: a `ScheduledFuture` representing pending completion of the task scheduleAtFixedRate(Runnable the Runnable to execute whenever the trigger fires task, long the interval between successive executions of the task (in milliseconds) period) Deprecated since 6.0. as of 6.0, in favor of `scheduleAtFixedRate(Runnable, Duration)` Schedule the given `Runnable`, starting as soon as possible and invoking it with the given period.
public ScheduledFuture<?>	Returns: a `ScheduledFuture` representing pending completion of the task scheduleWithFixedDelay(Runnable the Runnable to execute whenever the trigger fires task, Instant the desired first execution time for the task (if this is in the past, the task will be executed immediately, i.e. as soon as possible) startTime, Duration the delay between the completion of one execution and the start of the next delay) Schedule the given `Runnable`, invoking it at the specified execution time and subsequently with the given delay between the completion of one execution and the start of the next.
public default ScheduledFuture<?>	Returns: a `ScheduledFuture` representing pending completion of the task scheduleWithFixedDelay(Runnable the Runnable to execute whenever the trigger fires task, Date the desired first execution time for the task (if this is in the past, the task will be executed immediately, i.e. as soon as possible) startTime, long the delay between the completion of one execution and the start of the next (in milliseconds) delay) Deprecated since 6.0. as of 6.0, in favor of `scheduleWithFixedDelay(Runnable, Instant, Duration)` Schedule the given `Runnable`, invoking it at the specified execution time and subsequently with the given delay between the completion of one execution and the start of the next.
public ScheduledFuture<?>	Returns: a `ScheduledFuture` representing pending completion of the task scheduleWithFixedDelay(Runnable the Runnable to execute whenever the trigger fires task, Duration the delay between the completion of one execution and the start of the next delay) Schedule the given `Runnable`, starting as soon as possible and invoking it with the given delay between the completion of one execution and the start of the next.
public default ScheduledFuture<?>	Returns: a `ScheduledFuture` representing pending completion of the task scheduleWithFixedDelay(Runnable the Runnable to execute whenever the trigger fires task, long the delay between the completion of one execution and the start of the next (in milliseconds) delay) Deprecated since 6.0. as of 6.0, in favor of `scheduleWithFixedDelay(Runnable, Duration)` Schedule the given `Runnable`, starting as soon as possible and invoking it with the given delay between the completion of one execution and the start of the next.

Method Detail

getClock back to summary

getClock	back to summary
public default Clock getClock() Return the clock to use for scheduling purposes. Since 5.3 See Also `Clock#systemDefaultZone()`

public default Clock getClock()

Return the clock to use for scheduling purposes.

Since: 5.3
See Also: Clock#systemDefaultZone()

schedule back to summary

schedule	back to summary
public ScheduledFuture<?> schedule(Runnable task, Trigger trigger) Schedule the given `Runnable`, invoking it whenever the trigger indicates a next execution time. Execution will end once the scheduler shuts down or the returned `ScheduledFuture` gets cancelled. Parameters task:Runnable the Runnable to execute whenever the trigger fires trigger:Trigger an implementation of the `Trigger` interface, e.g. a `org.springframework.scheduling.support.CronTrigger` object wrapping a cron expression Returns:ScheduledFuture<?> a `ScheduledFuture` representing pending completion of the task, or `null` if the given Trigger object never fires (i.e. returns `null` from `Trigger#nextExecution`) Annotations @Nullable Exceptions TaskRejectedException: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress) See Also `org.springframework.scheduling.support.CronTrigger`

public ScheduledFuture<?> schedule(Runnable task, Trigger trigger)

Schedule the given Runnable, invoking it whenever the trigger indicates a next execution time.

Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.

Parameters

task:Runnable: the Runnable to execute whenever the trigger fires
trigger:Trigger: an implementation of the Trigger interface, e.g. a org.springframework.scheduling.support.CronTrigger object wrapping a cron expression

Returns:ScheduledFuture<?>

a ScheduledFuture representing pending completion of the task, or null if the given Trigger object never fires (i.e. returns null from Trigger#nextExecution)

Annotations

@Nullable

Exceptions

TaskRejectedException:: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

schedule back to summary

schedule	back to summary
public ScheduledFuture<?> schedule(Runnable task, Instant startTime) Schedule the given `Runnable`, invoking it at the specified execution time. Execution will end once the scheduler shuts down or the returned `ScheduledFuture` gets cancelled. Parameters task:Runnable the Runnable to execute whenever the trigger fires startTime:Instant the desired execution time for the task (if this is in the past, the task will be executed immediately, i.e. as soon as possible) Returns:ScheduledFuture<?> a `ScheduledFuture` representing pending completion of the task Exceptions TaskRejectedException: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress) Since 5.0

public ScheduledFuture<?> schedule(Runnable task, Instant startTime)

Schedule the given Runnable, invoking it at the specified execution time.

Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.

Parameters

task:Runnable: the Runnable to execute whenever the trigger fires
startTime:Instant: the desired execution time for the task (if this is in the past, the task will be executed immediately, i.e. as soon as possible)

Returns:ScheduledFuture<?>

a ScheduledFuture representing pending completion of the task

Exceptions

TaskRejectedException:: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

Since

5.0

schedule back to summary

schedule	back to summary
public default ScheduledFuture<?> schedule(Runnable task, Date startTime) Deprecated since 6.0. as of 6.0, in favor of `schedule(Runnable, Instant)` Schedule the given `Runnable`, invoking it at the specified execution time. Execution will end once the scheduler shuts down or the returned `ScheduledFuture` gets cancelled. Parameters task:Runnable the Runnable to execute whenever the trigger fires startTime:Date the desired execution time for the task (if this is in the past, the task will be executed immediately, i.e. as soon as possible) Returns:ScheduledFuture<?> a `ScheduledFuture` representing pending completion of the task Annotations @Deprecated since:6.0 Exceptions TaskRejectedException: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

public default ScheduledFuture<?> schedule(Runnable task, Date startTime)

Deprecated

since 6.0.

as of 6.0, in favor of schedule(Runnable, Instant)

Schedule the given Runnable, invoking it at the specified execution time.

Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.

Parameters

task:Runnable: the Runnable to execute whenever the trigger fires
startTime:Date: the desired execution time for the task (if this is in the past, the task will be executed immediately, i.e. as soon as possible)

Returns:ScheduledFuture<?>

a ScheduledFuture representing pending completion of the task

Annotations

@Deprecated
since:6.0

Exceptions

TaskRejectedException:: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

scheduleAtFixedRate back to summary

scheduleAtFixedRate	back to summary
public ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Instant startTime, Duration period) Schedule the given `Runnable`, invoking it at the specified execution time and subsequently with the given period. Execution will end once the scheduler shuts down or the returned `ScheduledFuture` gets cancelled. Parameters task:Runnable the Runnable to execute whenever the trigger fires startTime:Instant the desired first execution time for the task (if this is in the past, the task will be executed immediately, i.e. as soon as possible) period:Duration the interval between successive executions of the task Returns:ScheduledFuture<?> a `ScheduledFuture` representing pending completion of the task Exceptions TaskRejectedException: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress) Since 5.0

public ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Instant startTime, Duration period)

Schedule the given Runnable, invoking it at the specified execution time and subsequently with the given period.

Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.

Parameters

task:Runnable: the Runnable to execute whenever the trigger fires
startTime:Instant: the desired first execution time for the task (if this is in the past, the task will be executed immediately, i.e. as soon as possible)
period:Duration: the interval between successive executions of the task

Returns:ScheduledFuture<?>

a ScheduledFuture representing pending completion of the task

Exceptions

TaskRejectedException:: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

Since

5.0

scheduleAtFixedRate back to summary

scheduleAtFixedRate	back to summary
public default ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Date startTime, long period) Deprecated since 6.0. as of 6.0, in favor of `scheduleAtFixedRate(Runnable, Instant, Duration)` Schedule the given `Runnable`, invoking it at the specified execution time and subsequently with the given period. Execution will end once the scheduler shuts down or the returned `ScheduledFuture` gets cancelled. Parameters task:Runnable the Runnable to execute whenever the trigger fires startTime:Date the desired first execution time for the task (if this is in the past, the task will be executed immediately, i.e. as soon as possible) period:long the interval between successive executions of the task (in milliseconds) Returns:ScheduledFuture<?> a `ScheduledFuture` representing pending completion of the task Annotations @Deprecated since:6.0 Exceptions TaskRejectedException: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

public default ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Date startTime, long period)

Deprecated

since 6.0.

as of 6.0, in favor of scheduleAtFixedRate(Runnable, Instant, Duration)

Schedule the given Runnable, invoking it at the specified execution time and subsequently with the given period.

Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.

Parameters

task:Runnable: the Runnable to execute whenever the trigger fires
startTime:Date: the desired first execution time for the task (if this is in the past, the task will be executed immediately, i.e. as soon as possible)
period:long: the interval between successive executions of the task (in milliseconds)

Returns:ScheduledFuture<?>

a ScheduledFuture representing pending completion of the task

Annotations

@Deprecated
since:6.0

Exceptions

TaskRejectedException:: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

scheduleAtFixedRate back to summary

scheduleAtFixedRate	back to summary
public ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Duration period) Schedule the given `Runnable`, starting as soon as possible and invoking it with the given period. Execution will end once the scheduler shuts down or the returned `ScheduledFuture` gets cancelled. Parameters task:Runnable the Runnable to execute whenever the trigger fires period:Duration the interval between successive executions of the task Returns:ScheduledFuture<?> a `ScheduledFuture` representing pending completion of the task Exceptions TaskRejectedException: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress) Since 5.0

public ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Duration period)

Schedule the given Runnable, starting as soon as possible and invoking it with the given period.

Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.

Parameters

task:Runnable: the Runnable to execute whenever the trigger fires
period:Duration: the interval between successive executions of the task

Returns:ScheduledFuture<?>

a ScheduledFuture representing pending completion of the task

Exceptions

TaskRejectedException:: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

Since

5.0

scheduleAtFixedRate back to summary

scheduleAtFixedRate	back to summary
public default ScheduledFuture<?> scheduleAtFixedRate(Runnable task, long period) Deprecated since 6.0. as of 6.0, in favor of `scheduleAtFixedRate(Runnable, Duration)` Schedule the given `Runnable`, starting as soon as possible and invoking it with the given period. Execution will end once the scheduler shuts down or the returned `ScheduledFuture` gets cancelled. Parameters task:Runnable the Runnable to execute whenever the trigger fires period:long the interval between successive executions of the task (in milliseconds) Returns:ScheduledFuture<?> a `ScheduledFuture` representing pending completion of the task Annotations @Deprecated since:6.0 Exceptions TaskRejectedException: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

public default ScheduledFuture<?> scheduleAtFixedRate(Runnable task, long period)

Deprecated

since 6.0.

as of 6.0, in favor of scheduleAtFixedRate(Runnable, Duration)

Schedule the given Runnable, starting as soon as possible and invoking it with the given period.

Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.

Parameters

task:Runnable: the Runnable to execute whenever the trigger fires
period:long: the interval between successive executions of the task (in milliseconds)

Returns:ScheduledFuture<?>

a ScheduledFuture representing pending completion of the task

Annotations

@Deprecated
since:6.0

Exceptions

TaskRejectedException:: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

scheduleWithFixedDelay back to summary

scheduleWithFixedDelay	back to summary
public ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Instant startTime, Duration delay) Schedule the given `Runnable`, invoking it at the specified execution time and subsequently with the given delay between the completion of one execution and the start of the next. Execution will end once the scheduler shuts down or the returned `ScheduledFuture` gets cancelled. Parameters task:Runnable the Runnable to execute whenever the trigger fires startTime:Instant the desired first execution time for the task (if this is in the past, the task will be executed immediately, i.e. as soon as possible) delay:Duration the delay between the completion of one execution and the start of the next Returns:ScheduledFuture<?> a `ScheduledFuture` representing pending completion of the task Exceptions TaskRejectedException: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress) Since 5.0

public ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Instant startTime, Duration delay)

Schedule the given Runnable, invoking it at the specified execution time and subsequently with the given delay between the completion of one execution and the start of the next.

Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.

Parameters

task:Runnable: the Runnable to execute whenever the trigger fires
startTime:Instant: the desired first execution time for the task (if this is in the past, the task will be executed immediately, i.e. as soon as possible)
delay:Duration: the delay between the completion of one execution and the start of the next

Returns:ScheduledFuture<?>

a ScheduledFuture representing pending completion of the task

Exceptions

TaskRejectedException:: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

Since

5.0

scheduleWithFixedDelay back to summary

scheduleWithFixedDelay	back to summary
public default ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Date startTime, long delay) Deprecated since 6.0. as of 6.0, in favor of `scheduleWithFixedDelay(Runnable, Instant, Duration)` Schedule the given `Runnable`, invoking it at the specified execution time and subsequently with the given delay between the completion of one execution and the start of the next. Execution will end once the scheduler shuts down or the returned `ScheduledFuture` gets cancelled. Parameters task:Runnable the Runnable to execute whenever the trigger fires startTime:Date the desired first execution time for the task (if this is in the past, the task will be executed immediately, i.e. as soon as possible) delay:long the delay between the completion of one execution and the start of the next (in milliseconds) Returns:ScheduledFuture<?> a `ScheduledFuture` representing pending completion of the task Annotations @Deprecated since:6.0 Exceptions TaskRejectedException: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

public default ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Date startTime, long delay)

Deprecated

since 6.0.

as of 6.0, in favor of scheduleWithFixedDelay(Runnable, Instant, Duration)

Schedule the given Runnable, invoking it at the specified execution time and subsequently with the given delay between the completion of one execution and the start of the next.

Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.

Parameters

task:Runnable: the Runnable to execute whenever the trigger fires
startTime:Date: the desired first execution time for the task (if this is in the past, the task will be executed immediately, i.e. as soon as possible)
delay:long: the delay between the completion of one execution and the start of the next (in milliseconds)

Returns:ScheduledFuture<?>

a ScheduledFuture representing pending completion of the task

Annotations

@Deprecated
since:6.0

Exceptions

TaskRejectedException:: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

scheduleWithFixedDelay back to summary

scheduleWithFixedDelay	back to summary
public ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Duration delay) Schedule the given `Runnable`, starting as soon as possible and invoking it with the given delay between the completion of one execution and the start of the next. Execution will end once the scheduler shuts down or the returned `ScheduledFuture` gets cancelled. Parameters task:Runnable the Runnable to execute whenever the trigger fires delay:Duration the delay between the completion of one execution and the start of the next Returns:ScheduledFuture<?> a `ScheduledFuture` representing pending completion of the task Exceptions TaskRejectedException: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress) Since 5.0

public ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Duration delay)

Schedule the given Runnable, starting as soon as possible and invoking it with the given delay between the completion of one execution and the start of the next.

Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.

Parameters

task:Runnable: the Runnable to execute whenever the trigger fires
delay:Duration: the delay between the completion of one execution and the start of the next

Returns:ScheduledFuture<?>

a ScheduledFuture representing pending completion of the task

Exceptions

TaskRejectedException:: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

Since

5.0

scheduleWithFixedDelay back to summary

scheduleWithFixedDelay	back to summary
public default ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, long delay) Deprecated since 6.0. as of 6.0, in favor of `scheduleWithFixedDelay(Runnable, Duration)` Schedule the given `Runnable`, starting as soon as possible and invoking it with the given delay between the completion of one execution and the start of the next. Execution will end once the scheduler shuts down or the returned `ScheduledFuture` gets cancelled. Parameters task:Runnable the Runnable to execute whenever the trigger fires delay:long the delay between the completion of one execution and the start of the next (in milliseconds) Returns:ScheduledFuture<?> a `ScheduledFuture` representing pending completion of the task Annotations @Deprecated since:6.0 Exceptions TaskRejectedException: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

public default ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, long delay)

Deprecated

since 6.0.

as of 6.0, in favor of scheduleWithFixedDelay(Runnable, Duration)

Schedule the given Runnable, starting as soon as possible and invoking it with the given delay between the completion of one execution and the start of the next.

Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.

Parameters

task:Runnable: the Runnable to execute whenever the trigger fires
delay:long: the delay between the completion of one execution and the start of the next (in milliseconds)

Returns:ScheduledFuture<?>

a ScheduledFuture representing pending completion of the task

Annotations

@Deprecated
since:6.0

Exceptions

TaskRejectedException:: if the given task was not accepted for internal reasons (e.g. a pool overload handling policy or a pool shutdown in progress)

public Interface TaskScheduler

Method Summary

Method Detail