Package io.micronaut.scheduling
Interface TaskScheduler
- All Known Implementing Classes:
ScheduledExecutorTaskScheduler
public interface TaskScheduler
Interface for Scheduling tasks.
- Since:
- 1.0
- Author:
- graemerocher
-
Method Summary
Modifier and TypeMethodDescriptiondefault ScheduledFuture<?>
Creates and executes a one-shot action that becomes enabled after the given delay.default <V> ScheduledFuture<V>
Creates and executes a one-shot action that becomes enabled after the given delay.Creates and executes a one-shot action that becomes enabled after the given delay.<V> ScheduledFuture<V>
Creates and executes a one-shot action that becomes enabled after the given delay.Creates and executes a one-shot action that becomes enabled after the given delay.<V> ScheduledFuture<V>
Creates and executes a ScheduledFuture that becomes enabled after the given delay.scheduleAtFixedRate
(@Nullable Duration initialDelay, Duration period, Runnable command) Creates and executes a periodic action that becomes enabled first after the given initial delay, and subsequently with the given period; that is executions will commence afterinitialDelay
theninitialDelay+period
, theninitialDelay + 2 * period
, and so on.scheduleWithFixedDelay
(@Nullable Duration initialDelay, Duration delay, Runnable command) Creates and executes a periodic action that becomes enabled first after the given initial delay, and subsequently with the given delay between the termination of one execution and the commencement of the next.
-
Method Details
-
schedule
Creates and executes a one-shot action that becomes enabled after the given delay.- Parameters:
cron
- The cron expressioncommand
- the task to execute- Returns:
- a ScheduledFuture representing pending completion of
the task and whose
get()
method will returnnull
upon completion - Throws:
RejectedExecutionException
- if the task cannot be scheduled for executionNullPointerException
- if command or delay is null
-
schedule
Creates and executes a one-shot action that becomes enabled after the given delay.- Type Parameters:
V
- The type of the callable's result- Parameters:
cron
- The cron expressioncommand
- The task to execute- Returns:
- a ScheduledFuture representing pending completion of
the task and whose
get()
method will returnnull
upon completion - Throws:
RejectedExecutionException
- if the task cannot be scheduled for executionNullPointerException
- if command or delay is null
-
schedule
default ScheduledFuture<?> schedule(@NonNull @NonNull String cron, @Nullable @Nullable String timezoneId, @NonNull @NonNull Runnable command) Creates and executes a one-shot action that becomes enabled after the given delay.- Parameters:
cron
- The cron expressiontimezoneId
- The timezoneId to base the cron expression on. Defaults to system time zonecommand
- the task to execute- Returns:
- a ScheduledFuture representing pending completion of
the task and whose
get()
method will returnnull
upon completion - Throws:
RejectedExecutionException
- if the task cannot be scheduled for executionNullPointerException
- if command or delay is null
-
schedule
default <V> ScheduledFuture<V> schedule(@NonNull @NonNull String cron, @Nullable @Nullable String timezoneId, @NonNull @NonNull Callable<V> command) Creates and executes a one-shot action that becomes enabled after the given delay.- Type Parameters:
V
- The type of the callable's result- Parameters:
cron
- The cron expressiontimezoneId
- The time zone to base the cron expression on. Defaults to system time zonecommand
- The task to execute- Returns:
- a ScheduledFuture representing pending completion of
the task and whose
get()
method will returnnull
upon completion - Throws:
RejectedExecutionException
- if the task cannot be scheduled for executionNullPointerException
- if command or delay is null
-
schedule
Creates and executes a one-shot action that becomes enabled after the given delay.- Parameters:
delay
- the time from now to delay executioncommand
- the task to execute- Returns:
- a ScheduledFuture representing pending completion of
the task and whose
get()
method will returnnull
upon completion - Throws:
RejectedExecutionException
- if the task cannot be scheduled for executionNullPointerException
- if command or delay is null
-
schedule
Creates and executes a ScheduledFuture that becomes enabled after the given delay.- Type Parameters:
V
- The type of the callable's result- Parameters:
delay
- The time from now to delay executioncallable
- The function to execute- Returns:
- a ScheduledFuture that can be used to extract result or cancel
- Throws:
RejectedExecutionException
- if the task cannot be scheduled for executionNullPointerException
- if callable or delay is null
-
scheduleAtFixedRate
ScheduledFuture<?> scheduleAtFixedRate(@Nullable @Nullable Duration initialDelay, Duration period, Runnable command) Creates and executes a periodic action that becomes enabled first after the given initial delay, and subsequently with the given period; that is executions will commence afterinitialDelay
theninitialDelay+period
, theninitialDelay + 2 * period
, and so on. If any execution of the task encounters an exception, subsequent executions are suppressed. Otherwise, the task will only terminate via cancellation or termination of the executor. If any execution of this task takes longer than its period, then subsequent executions may start late, but will not concurrently execute.- Parameters:
initialDelay
- the time to delay first executionperiod
- the period between successive executionscommand
- the task to execute- Returns:
- a ScheduledFuture representing pending completion of
the task, and whose
get()
method will throw an exception upon cancellation - Throws:
RejectedExecutionException
- if the task cannot be scheduled for executionNullPointerException
- if command or period is nullIllegalArgumentException
- if period less than or equal to zero
-
scheduleWithFixedDelay
ScheduledFuture<?> scheduleWithFixedDelay(@Nullable @Nullable Duration initialDelay, Duration delay, Runnable command) Creates and executes a periodic action that becomes enabled first after the given initial delay, and subsequently with the given delay between the termination of one execution and the commencement of the next. If any execution of the task encounters an exception, subsequent executions are suppressed. Otherwise, the task will only terminate via cancellation or termination of the executor.- Parameters:
initialDelay
- the time to delay first executiondelay
- the delay between the termination of onecommand
- the task to execute execution and the commencement of the next- Returns:
- a ScheduledFuture representing pending completion of
the task, and whose
get()
method will throw an exception upon cancellation - Throws:
RejectedExecutionException
- if the task cannot be scheduled for executionNullPointerException
- if command or delay is nullIllegalArgumentException
- if delay less than or equal to zero
-