Spring Context 6.1.4 · org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler

Modifier and Type	Class and Description
private static class	ThreadPoolTaskScheduler.DelegatingErrorHandlingCallable<V>

Modifier and Type	Field and Description
private Clock	clock
private volatile boolean	continueExistingPeriodicTasksAfterShutdownPolicy
private volatile ErrorHandler	errorHandler
private volatile boolean	executeExistingDelayedTasksAfterShutdownPolicy
private final Map<Object, ListenableFuture<?>>	listenableFutureMap
private static final TimeUnit	NANO
private volatile int	poolSize
private volatile boolean	removeOnCancelPolicy
private ScheduledExecutorService	scheduledExecutor

Access	Constructor and Description
public	ThreadPoolTaskScheduler()

Method Summary

Modifier and Type	Method and Description
protected void	cancelRemainingTask(Runnable the task to cancel (typically a `RunnableFuture`) task) Overrides org.springframework.scheduling.concurrent.ExecutorConfigurationSupport.cancelRemainingTask. Cancel the given remaining task which never commenced execution, as returned from `ExecutorService#shutdownNow()`.
protected ScheduledExecutorService	Returns: a new ScheduledExecutorService instance createExecutor(int the specified pool size poolSize, ThreadFactory the ThreadFactory to use threadFactory, RejectedExecutionHandler the RejectedExecutionHandler to use rejectedExecutionHandler) Create a new `ScheduledExecutorService` instance.
private Runnable	errorHandlingTask(Runnable task, boolean isRepeatingTask)
public void	execute(Runnable the `Runnable` to execute (never `null`) task) Implements org.springframework.core.task.TaskExecutor.execute. Execute the given `task`.
private void	executeAndTrack(ExecutorService executor, ListenableFutureTask<?> listenableFuture) Deprecated as a consequence of `ListenableFutureTask` being deprecated.
public int	getActiveCount() Return the number of currently active threads.
public Clock	getClock() Overrides default org.springframework.scheduling.TaskScheduler.getClock. Return the clock to use for scheduling purposes.
public int	getPoolSize() Return the current pool size.
public ScheduledExecutorService	Returns: the underlying ScheduledExecutorService (never `null`) getScheduledExecutor() Return the underlying ScheduledExecutorService for native access.
public ScheduledThreadPoolExecutor	Returns: the underlying ScheduledExecutorService (never `null`) getScheduledThreadPoolExecutor() Return the underlying ScheduledThreadPoolExecutor, if available.
protected ExecutorService	initializeExecutor(ThreadFactory the ThreadFactory to use threadFactory, RejectedExecutionHandler the RejectedExecutionHandler to use rejectedExecutionHandler) Implements abstract org.springframework.scheduling.concurrent.ExecutorConfigurationSupport.initializeExecutor. Create the target `java.util.concurrent.ExecutorService` instance.
public boolean	isRemoveOnCancelPolicy() Deprecated as of 5.3.9, in favor of direct `getScheduledThreadPoolExecutor()` access Return the current setting for the remove-on-cancel mode.
public ScheduledFuture<?>	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) Implements org.springframework.scheduling.TaskScheduler.schedule. Schedule the given `Runnable`, invoking it whenever the trigger indicates a next execution time.
public ScheduledFuture<?>	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) Implements org.springframework.scheduling.TaskScheduler.schedule. Schedule the given `Runnable`, invoking it at the specified execution time.
public ScheduledFuture<?>	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) Implements org.springframework.scheduling.TaskScheduler.scheduleAtFixedRate. Schedule the given `Runnable`, invoking it at the specified execution time and subsequently with the given period.
public ScheduledFuture<?>	scheduleAtFixedRate(Runnable the Runnable to execute whenever the trigger fires task, Duration the interval between successive executions of the task period) Implements org.springframework.scheduling.TaskScheduler.scheduleAtFixedRate. Schedule the given `Runnable`, starting as soon as possible and invoking it with the given period.
public ScheduledFuture<?>	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) Implements org.springframework.scheduling.TaskScheduler.scheduleWithFixedDelay. 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<?>	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) Implements org.springframework.scheduling.TaskScheduler.scheduleWithFixedDelay. 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 void	setClock(Clock clock) Set the clock to use for scheduling purposes.
public void	setContinueExistingPeriodicTasksAfterShutdownPolicy(boolean flag) Set whether to continue existing periodic tasks even when this executor has been shutdown.
public void	setErrorHandler(ErrorHandler errorHandler) Set a custom `ErrorHandler` strategy.
public void	setExecuteExistingDelayedTasksAfterShutdownPolicy(boolean flag) Set whether to execute existing delayed tasks even when this executor has been shutdown.
public void	setPoolSize(int poolSize) Set the ScheduledExecutorService's pool size.
public void	setRemoveOnCancelPolicy(boolean flag) Set the remove-on-cancel mode on `ScheduledThreadPoolExecutor`.
public Future<?>	submit(Runnable the `Runnable` to execute (never `null`) task) Overrides default org.springframework.core.task.AsyncTaskExecutor.submit. Submit a Runnable task for execution, receiving a Future representing that task.
public <T> Future<T>	submit(Callable<T> the `Callable` to execute (never `null`) task) Overrides default org.springframework.core.task.AsyncTaskExecutor.submit. Submit a Callable task for execution, receiving a Future representing that task.
public ListenableFuture<?>	submitListenable(Runnable the `Runnable` to execute (never `null`) task) Implements org.springframework.core.task.AsyncListenableTaskExecutor.submitListenable. Deprecated as a consequence of `ListenableFuture` being deprecated. Submit a `Runnable` task for execution, receiving a `ListenableFuture` representing that task.
public <T> ListenableFuture<T>	submitListenable(Callable<T> the `Callable` to execute (never `null`) task) Implements org.springframework.core.task.AsyncListenableTaskExecutor.submitListenable. Deprecated as a consequence of `ListenableFuture` being deprecated. Submit a `Callable` task for execution, receiving a `ListenableFuture` representing that task.

clock	back to summary
private Clock clock

continueExistingPeriodicTasksAfterShutdownPolicy	back to summary
private volatile boolean continueExistingPeriodicTasksAfterShutdownPolicy

errorHandler	back to summary
private volatile ErrorHandler errorHandler Annotations @Nullable

executeExistingDelayedTasksAfterShutdownPolicy	back to summary
private volatile boolean executeExistingDelayedTasksAfterShutdownPolicy

listenableFutureMap	back to summary
private final Map<Object, ListenableFuture<?>> listenableFutureMap

NANO	back to summary
private static final TimeUnit NANO

poolSize	back to summary
private volatile int poolSize

removeOnCancelPolicy	back to summary
private volatile boolean removeOnCancelPolicy

scheduledExecutor	back to summary
private ScheduledExecutorService scheduledExecutor Annotations @Nullable

ThreadPoolTaskScheduler	back to summary
public ThreadPoolTaskScheduler()

Method Detail

cancelRemainingTask back to summary

cancelRemainingTask	back to summary
protected void cancelRemainingTask(Runnable task) Overrides org.springframework.scheduling.concurrent.ExecutorConfigurationSupport.cancelRemainingTask. Doc from org.springframework.scheduling.concurrent.ExecutorConfigurationSupport.cancelRemainingTask. Cancel the given remaining task which never commenced execution, as returned from `ExecutorService#shutdownNow()`. Parameters task:Runnable the task to cancel (typically a `RunnableFuture`) Annotations @Override

protected void cancelRemainingTask(Runnable task)

Overrides org.springframework.scheduling.concurrent.ExecutorConfigurationSupport.cancelRemainingTask.

Doc from org.springframework.scheduling.concurrent.ExecutorConfigurationSupport.cancelRemainingTask.

Cancel the given remaining task which never commenced execution, as returned from ExecutorService#shutdownNow().

Parameters

task:Runnable: the task to cancel (typically a RunnableFuture)

Annotations

@Override

createExecutor back to summary

createExecutor	back to summary
protected ScheduledExecutorService createExecutor(int poolSize, ThreadFactory threadFactory, RejectedExecutionHandler rejectedExecutionHandler) Create a new `ScheduledExecutorService` instance. The default implementation creates a `ScheduledThreadPoolExecutor`. Can be overridden in subclasses to provide custom `ScheduledExecutorService` instances. Parameters poolSize:int the specified pool size threadFactory:ThreadFactory the ThreadFactory to use rejectedExecutionHandler:RejectedExecutionHandler the RejectedExecutionHandler to use Returns:ScheduledExecutorService a new ScheduledExecutorService instance See Also `afterPropertiesSet()`, `java.util.concurrent.ScheduledThreadPoolExecutor`

protected ScheduledExecutorService createExecutor(int poolSize, ThreadFactory threadFactory, RejectedExecutionHandler rejectedExecutionHandler)

Create a new ScheduledExecutorService instance.

The default implementation creates a ScheduledThreadPoolExecutor. Can be overridden in subclasses to provide custom ScheduledExecutorService instances.

Parameters

poolSize:int: the specified pool size
threadFactory:ThreadFactory: the ThreadFactory to use
rejectedExecutionHandler:RejectedExecutionHandler: the RejectedExecutionHandler to use

Returns:ScheduledExecutorService

a new ScheduledExecutorService instance

errorHandlingTask	back to summary
private Runnable errorHandlingTask(Runnable task, boolean isRepeatingTask)

execute back to summary

execute	back to summary
public void execute(Runnable task) Implements org.springframework.core.task.TaskExecutor.execute. Doc from org.springframework.core.task.TaskExecutor.execute. Execute the given `task`. The call might return immediately if the implementation uses an asynchronous execution strategy, or might block in the case of synchronous execution. Parameters task:Runnable the `Runnable` to execute (never `null`) Annotations @Override

public void execute(Runnable task)

Implements org.springframework.core.task.TaskExecutor.execute.

Doc from org.springframework.core.task.TaskExecutor.execute.

Execute the given task.

The call might return immediately if the implementation uses an asynchronous execution strategy, or might block in the case of synchronous execution.

Parameters

task:Runnable: the Runnable to execute (never null)

Annotations

@Override

executeAndTrack	back to summary
private void executeAndTrack(ExecutorService executor, ListenableFutureTask<?> listenableFuture) Deprecated as a consequence of `ListenableFutureTask` being deprecated. See corresponding docs for further information.

getActiveCount back to summary

getActiveCount	back to summary
public int getActiveCount() Return the number of currently active threads. Requires an underlying `ScheduledThreadPoolExecutor`. See Also `getScheduledThreadPoolExecutor()`, `java.util.concurrent.ScheduledThreadPoolExecutor#getActiveCount()`

public int getActiveCount()

Return the number of currently active threads.

Requires an underlying ScheduledThreadPoolExecutor.

See Also: getScheduledThreadPoolExecutor(), java.util.concurrent.ScheduledThreadPoolExecutor#getActiveCount()

getClock	back to summary
public Clock getClock() Overrides default org.springframework.scheduling.TaskScheduler.getClock. Doc from org.springframework.scheduling.TaskScheduler.getClock. Return the clock to use for scheduling purposes. Annotations @Override

getClock

back to summary

public Clock getClock()

Overrides default org.springframework.scheduling.TaskScheduler.getClock.

Doc from org.springframework.scheduling.TaskScheduler.getClock.

Return the clock to use for scheduling purposes.

Annotations

@Override

getPoolSize back to summary

getPoolSize	back to summary
public int getPoolSize() Return the current pool size. Requires an underlying `ScheduledThreadPoolExecutor`. See Also `getScheduledThreadPoolExecutor()`, `java.util.concurrent.ScheduledThreadPoolExecutor#getPoolSize()`

public int getPoolSize()

Return the current pool size.

Requires an underlying ScheduledThreadPoolExecutor.

See Also: getScheduledThreadPoolExecutor(), java.util.concurrent.ScheduledThreadPoolExecutor#getPoolSize()

getScheduledExecutor back to summary

getScheduledExecutor	back to summary
public ScheduledExecutorService getScheduledExecutor() throws IllegalStateException Return the underlying ScheduledExecutorService for native access. Returns:ScheduledExecutorService the underlying ScheduledExecutorService (never `null`) Exceptions IllegalStateException: if the ThreadPoolTaskScheduler hasn't been initialized yet

public ScheduledExecutorService getScheduledExecutor() throws IllegalStateException

Return the underlying ScheduledExecutorService for native access.

Returns:ScheduledExecutorService

the underlying ScheduledExecutorService (never null)

Exceptions

IllegalStateException:: if the ThreadPoolTaskScheduler hasn't been initialized yet

getScheduledThreadPoolExecutor back to summary

getScheduledThreadPoolExecutor	back to summary
public ScheduledThreadPoolExecutor getScheduledThreadPoolExecutor() throws IllegalStateException Return the underlying ScheduledThreadPoolExecutor, if available. Returns:ScheduledThreadPoolExecutor the underlying ScheduledExecutorService (never `null`) Exceptions IllegalStateException: if the ThreadPoolTaskScheduler hasn't been initialized yet or if the underlying ScheduledExecutorService isn't a ScheduledThreadPoolExecutor See Also `getScheduledExecutor()`

public ScheduledThreadPoolExecutor getScheduledThreadPoolExecutor() throws IllegalStateException

Return the underlying ScheduledThreadPoolExecutor, if available.

Returns:ScheduledThreadPoolExecutor

the underlying ScheduledExecutorService (never null)

Exceptions

IllegalStateException:: if the ThreadPoolTaskScheduler hasn't been initialized yet or if the underlying ScheduledExecutorService isn't a ScheduledThreadPoolExecutor

See Also

getScheduledExecutor()

initializeExecutor back to summary

initializeExecutor	back to summary
protected ExecutorService initializeExecutor(ThreadFactory threadFactory, RejectedExecutionHandler rejectedExecutionHandler) Implements abstract org.springframework.scheduling.concurrent.ExecutorConfigurationSupport.initializeExecutor. Doc from org.springframework.scheduling.concurrent.ExecutorConfigurationSupport.initializeExecutor. Create the target `java.util.concurrent.ExecutorService` instance. Called by `afterPropertiesSet`. Parameters threadFactory:ThreadFactory the ThreadFactory to use rejectedExecutionHandler:RejectedExecutionHandler the RejectedExecutionHandler to use Returns:ExecutorService a new ExecutorService instance Annotations @Override

protected ExecutorService initializeExecutor(ThreadFactory threadFactory, RejectedExecutionHandler rejectedExecutionHandler)

Implements abstract org.springframework.scheduling.concurrent.ExecutorConfigurationSupport.initializeExecutor.

Doc from org.springframework.scheduling.concurrent.ExecutorConfigurationSupport.initializeExecutor.

Create the target java.util.concurrent.ExecutorService instance. Called by afterPropertiesSet.

Parameters

threadFactory:ThreadFactory: the ThreadFactory to use
rejectedExecutionHandler:RejectedExecutionHandler: the RejectedExecutionHandler to use

Returns:ExecutorService

a new ExecutorService instance

Annotations

@Override

isRemoveOnCancelPolicy back to summary

isRemoveOnCancelPolicy	back to summary
public boolean isRemoveOnCancelPolicy() Deprecated as of 5.3.9, in favor of direct `getScheduledThreadPoolExecutor()` access Return the current setting for the remove-on-cancel mode. Requires an underlying `ScheduledThreadPoolExecutor`. Annotations @Deprecated

public boolean isRemoveOnCancelPolicy()

Deprecated

as of 5.3.9, in favor of direct getScheduledThreadPoolExecutor() access

Return the current setting for the remove-on-cancel mode.

Requires an underlying ScheduledThreadPoolExecutor.

Annotations

@Deprecated

schedule back to summary

schedule	back to summary
public ScheduledFuture<?> schedule(Runnable task, Trigger trigger) Implements org.springframework.scheduling.TaskScheduler.schedule. Doc from org.springframework.scheduling.TaskScheduler.schedule. 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 @Override @Nullable

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

Implements org.springframework.scheduling.TaskScheduler.schedule.

Doc from org.springframework.scheduling.TaskScheduler.schedule.

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

@Override
@Nullable

schedule back to summary

schedule	back to summary
public ScheduledFuture<?> schedule(Runnable task, Instant startTime) Implements org.springframework.scheduling.TaskScheduler.schedule. Doc from org.springframework.scheduling.TaskScheduler.schedule. 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 Annotations @Override

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

Implements org.springframework.scheduling.TaskScheduler.schedule.

Doc from org.springframework.scheduling.TaskScheduler.schedule.

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

Annotations

@Override

scheduleAtFixedRate back to summary

scheduleAtFixedRate	back to summary
public ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Instant startTime, Duration period) Implements org.springframework.scheduling.TaskScheduler.scheduleAtFixedRate. Doc from org.springframework.scheduling.TaskScheduler.scheduleAtFixedRate. 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 Annotations @Override

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

Implements org.springframework.scheduling.TaskScheduler.scheduleAtFixedRate.

Doc from org.springframework.scheduling.TaskScheduler.scheduleAtFixedRate.

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

Annotations

@Override

scheduleAtFixedRate back to summary

scheduleAtFixedRate	back to summary
public ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Duration period) Implements org.springframework.scheduling.TaskScheduler.scheduleAtFixedRate. Doc from org.springframework.scheduling.TaskScheduler.scheduleAtFixedRate. 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 Annotations @Override

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

Implements org.springframework.scheduling.TaskScheduler.scheduleAtFixedRate.

Doc from org.springframework.scheduling.TaskScheduler.scheduleAtFixedRate.

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

Annotations

@Override

scheduleWithFixedDelay back to summary

scheduleWithFixedDelay	back to summary
public ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Instant startTime, Duration delay) Implements org.springframework.scheduling.TaskScheduler.scheduleWithFixedDelay. Doc from org.springframework.scheduling.TaskScheduler.scheduleWithFixedDelay. 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 Annotations @Override

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

Implements org.springframework.scheduling.TaskScheduler.scheduleWithFixedDelay.

Doc from org.springframework.scheduling.TaskScheduler.scheduleWithFixedDelay.

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

Annotations

@Override

scheduleWithFixedDelay back to summary

scheduleWithFixedDelay	back to summary
public ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Duration delay) Implements org.springframework.scheduling.TaskScheduler.scheduleWithFixedDelay. Doc from org.springframework.scheduling.TaskScheduler.scheduleWithFixedDelay. 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 Annotations @Override

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

Implements org.springframework.scheduling.TaskScheduler.scheduleWithFixedDelay.

Doc from org.springframework.scheduling.TaskScheduler.scheduleWithFixedDelay.

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

Annotations

@Override

setClock back to summary

setClock	back to summary
public void setClock(Clock clock) Set the clock to use for scheduling purposes. The default clock is the system clock for the default time zone. Since 5.3 See Also `Clock#systemDefaultZone()`

public void setClock(Clock clock)

Set the clock to use for scheduling purposes.

The default clock is the system clock for the default time zone.

Since: 5.3
See Also: Clock#systemDefaultZone()

setContinueExistingPeriodicTasksAfterShutdownPolicy back to summary

setContinueExistingPeriodicTasksAfterShutdownPolicy	back to summary
public void setContinueExistingPeriodicTasksAfterShutdownPolicy(boolean flag) Set whether to continue existing periodic tasks even when this executor has been shutdown. Default is `false`. If set to `true`, the target executor will be switched into continuing periodic tasks (if possible). This setting can be modified at runtime, for example through JMX. Since 5.3.9 See Also `ScheduledThreadPoolExecutor#setContinueExistingPeriodicTasksAfterShutdownPolicy`

public void setContinueExistingPeriodicTasksAfterShutdownPolicy(boolean flag)

Set whether to continue existing periodic tasks even when this executor has been shutdown.

Default is false. If set to true, the target executor will be switched into continuing periodic tasks (if possible).

This setting can be modified at runtime, for example through JMX.

Since: 5.3.9
See Also: ScheduledThreadPoolExecutor#setContinueExistingPeriodicTasksAfterShutdownPolicy

setErrorHandler	back to summary
public void setErrorHandler(ErrorHandler errorHandler) Set a custom `ErrorHandler` strategy.

setExecuteExistingDelayedTasksAfterShutdownPolicy back to summary

setExecuteExistingDelayedTasksAfterShutdownPolicy	back to summary
public void setExecuteExistingDelayedTasksAfterShutdownPolicy(boolean flag) Set whether to execute existing delayed tasks even when this executor has been shutdown. Default is `true`. If set to `false`, the target executor will be switched into dropping remaining tasks (if possible). This setting can be modified at runtime, for example through JMX. Since 5.3.9 See Also `ScheduledThreadPoolExecutor#setExecuteExistingDelayedTasksAfterShutdownPolicy`

public void setExecuteExistingDelayedTasksAfterShutdownPolicy(boolean flag)

Set whether to execute existing delayed tasks even when this executor has been shutdown.

Default is true. If set to false, the target executor will be switched into dropping remaining tasks (if possible).

This setting can be modified at runtime, for example through JMX.

Since: 5.3.9
See Also: ScheduledThreadPoolExecutor#setExecuteExistingDelayedTasksAfterShutdownPolicy

setPoolSize	back to summary
public void setPoolSize(int poolSize) Set the ScheduledExecutorService's pool size. Default is 1. This setting can be modified at runtime, for example through JMX.

setPoolSize

back to summary

public void setPoolSize(int poolSize)

Set the ScheduledExecutorService's pool size. Default is 1.

This setting can be modified at runtime, for example through JMX.

setRemoveOnCancelPolicy back to summary

setRemoveOnCancelPolicy	back to summary
public void setRemoveOnCancelPolicy(boolean flag) Set the remove-on-cancel mode on `ScheduledThreadPoolExecutor`. Default is `false`. If set to `true`, the target executor will be switched into remove-on-cancel mode (if possible). This setting can be modified at runtime, for example through JMX. See Also `ScheduledThreadPoolExecutor#setRemoveOnCancelPolicy`

public void setRemoveOnCancelPolicy(boolean flag)

Set the remove-on-cancel mode on ScheduledThreadPoolExecutor.

Default is false. If set to true, the target executor will be switched into remove-on-cancel mode (if possible).

This setting can be modified at runtime, for example through JMX.

See Also: ScheduledThreadPoolExecutor#setRemoveOnCancelPolicy

submit back to summary

submit	back to summary
public Future<?> submit(Runnable task) Overrides default org.springframework.core.task.AsyncTaskExecutor.submit. Doc from org.springframework.core.task.AsyncTaskExecutor.submit. Submit a Runnable task for execution, receiving a Future representing that task. The Future will return a `null` result upon completion. As of 6.1, this method comes with a default implementation that delegates to `execute(Runnable)`. Parameters task:Runnable the `Runnable` to execute (never `null`) Returns:Future<?> a Future representing pending completion of the task Annotations @Override

public Future<?> submit(Runnable task)

Overrides default org.springframework.core.task.AsyncTaskExecutor.submit.

Doc from org.springframework.core.task.AsyncTaskExecutor.submit.

Submit a Runnable task for execution, receiving a Future representing that task. The Future will return a null result upon completion.

As of 6.1, this method comes with a default implementation that delegates to execute(Runnable).

Parameters

task:Runnable: the Runnable to execute (never null)

Returns:Future<?>

a Future representing pending completion of the task

Annotations

@Override

submit back to summary

submit	back to summary
public <T> Future<T> submit(Callable<T> task) Overrides default org.springframework.core.task.AsyncTaskExecutor.submit. Doc from org.springframework.core.task.AsyncTaskExecutor.submit. Submit a Callable task for execution, receiving a Future representing that task. The Future will return the Callable's result upon completion. As of 6.1, this method comes with a default implementation that delegates to `execute(Runnable)`. Parameters task:Callable<T> the `Callable` to execute (never `null`) Returns:Future<T> a Future representing pending completion of the task Annotations @Override

public <T> Future<T> submit(Callable<T> task)

Overrides default org.springframework.core.task.AsyncTaskExecutor.submit.

Doc from org.springframework.core.task.AsyncTaskExecutor.submit.

Submit a Callable task for execution, receiving a Future representing that task. The Future will return the Callable's result upon completion.

As of 6.1, this method comes with a default implementation that delegates to execute(Runnable).

Parameters

task:Callable<T>: the Callable to execute (never null)

Returns:Future<T>

a Future representing pending completion of the task

Annotations

@Override

submitListenable back to summary

submitListenable	back to summary
public ListenableFuture<?> submitListenable(Runnable task) Implements org.springframework.core.task.AsyncListenableTaskExecutor.submitListenable. Doc from org.springframework.core.task.AsyncListenableTaskExecutor.submitListenable. Deprecated as a consequence of `ListenableFuture` being deprecated. See corresponding docs for further information. Submit a `Runnable` task for execution, receiving a `ListenableFuture` representing that task. The Future will return a `null` result upon completion. Parameters task:Runnable the `Runnable` to execute (never `null`) Returns:ListenableFuture<?> a `ListenableFuture` representing pending completion of the task Annotations @Override

public ListenableFuture<?> submitListenable(Runnable task)

Implements org.springframework.core.task.AsyncListenableTaskExecutor.submitListenable.

Doc from org.springframework.core.task.AsyncListenableTaskExecutor.submitListenable.

Deprecated

as a consequence of ListenableFuture being deprecated. See corresponding docs for further information.

Submit a Runnable task for execution, receiving a ListenableFuture representing that task. The Future will return a null result upon completion.

Parameters

task:Runnable: the Runnable to execute (never null)

Returns:ListenableFuture<?>

a ListenableFuture representing pending completion of the task

Annotations

@Override

submitListenable back to summary

submitListenable	back to summary
public <T> ListenableFuture<T> submitListenable(Callable<T> task) Implements org.springframework.core.task.AsyncListenableTaskExecutor.submitListenable. Doc from org.springframework.core.task.AsyncListenableTaskExecutor.submitListenable. Deprecated as a consequence of `ListenableFuture` being deprecated. See corresponding docs for further information. Submit a `Callable` task for execution, receiving a `ListenableFuture` representing that task. The Future will return the Callable's result upon completion. Parameters task:Callable<T> the `Callable` to execute (never `null`) Returns:ListenableFuture<T> a `ListenableFuture` representing pending completion of the task Annotations @Override

public <T> ListenableFuture<T> submitListenable(Callable<T> task)

Implements org.springframework.core.task.AsyncListenableTaskExecutor.submitListenable.

Doc from org.springframework.core.task.AsyncListenableTaskExecutor.submitListenable.

Deprecated

as a consequence of ListenableFuture being deprecated. See corresponding docs for further information.

Submit a Callable task for execution, receiving a ListenableFuture representing that task. The Future will return the Callable's result upon completion.

Parameters

task:Callable<T>: the Callable to execute (never null)

Returns:ListenableFuture<T>

a ListenableFuture representing pending completion of the task

Annotations

@Override

public Class ThreadPoolTaskScheduler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ThreadPoolTaskScheduler.DelegatingErrorHandlingCallable<V>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
private final Callable<V>	delegate
private final ErrorHandler	errorHandler