java.lang.Object | |
↳ | org.springframework.scheduling.support.PeriodicTrigger |
A trigger for periodic task execution. The period may be applied as either
fixed-rate or fixed-delay, and an initial delay value may also be configured.
The default initial delay is 0, and the default behavior is fixed-delay
(i.e. the interval between successive executions is measured from each
true
.
Note that the TaskScheduler interface already defines methods for scheduling tasks at fixed-rate or with fixed-delay. Both also support an optional value for the initial delay. Those methods should be used directly whenever possible. The value of this Trigger implementation is that it can be used within components that rely on the Trigger abstraction. For example, it may be convenient to allow periodic triggers, cron-based triggers, and even custom Trigger implementations to be used interchangeably.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Create a trigger with the given period in milliseconds.
| |||||||||||
Create a trigger with the given period and time unit.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns the time after which a task should run again.
| |||||||||||
Specify whether the periodic interval should be measured between the
scheduled start times rather than between actual completion times.
| |||||||||||
Specify the delay for the initial execution.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
org.springframework.scheduling.Trigger
|
Create a trigger with the given period in milliseconds.
Create a trigger with the given period and time unit. The time unit will
apply not only to the period but also to any 'initialDelay' value, if
configured on this Trigger later via setInitialDelay(long)
.
Returns the time after which a task should run again.
triggerContext | context object encapsulating last execution times and last completion time |
---|
null
if the trigger won't fire anymore
Specify whether the periodic interval should be measured between the scheduled start times rather than between actual completion times. The latter, "fixed delay" behavior, is the default.
Specify the delay for the initial execution. It will be evaluated in
terms of this trigger's TimeUnit
. If no time unit was explicitly
provided upon instantiation, the default is milliseconds.