程序包 cn.taketoday.scheduling.support

类 TaskSchedulerBuilder

java.lang.Object

cn.taketoday.scheduling.support.TaskSchedulerBuilder

public class TaskSchedulerBuilder
extends Object

Builder that can be used to configure and create a TaskScheduler. Provides convenience methods to set common ThreadPoolTaskScheduler settings. For advanced configuration, consider using TaskSchedulerCustomizer.

In a typical auto-configured Spring Boot application this builder is available as a bean and can be injected whenever a TaskScheduler is needed.

从以下版本开始:

4.0

作者:

Stephane Nicoll, Harry Yang

构造器概要

构造器

构造器	说明
TaskSchedulerBuilder()
TaskSchedulerBuilder(Integer poolSize, Boolean awaitTermination, Duration awaitTerminationPeriod, String threadNamePrefix, Set<TaskSchedulerCustomizer> taskSchedulerCustomizers)

方法概要

修饰符和类型	方法	说明
TaskSchedulerBuilder	additionalCustomizers(TaskSchedulerCustomizer... customizers)	Add taskSchedulerCustomizers that should be applied to the ThreadPoolTaskScheduler.
TaskSchedulerBuilder	additionalCustomizers(Iterable<TaskSchedulerCustomizer> customizers)	Add taskSchedulerCustomizers that should be applied to the ThreadPoolTaskScheduler.
TaskSchedulerBuilder	awaitTermination(boolean awaitTermination)	Set whether the executor should wait for scheduled tasks to complete on shutdown, not interrupting running tasks and executing all tasks in the queue.
TaskSchedulerBuilder	awaitTerminationPeriod(Duration awaitTerminationPeriod)	Set the maximum time the executor is supposed to block on shutdown.
ThreadPoolTaskScheduler	build()	Build a new ThreadPoolTaskScheduler instance and configure it using this builder.
<T extends ThreadPoolTaskScheduler> T	configure(T taskScheduler)	Configure the provided ThreadPoolTaskScheduler instance using this builder.
TaskSchedulerBuilder	customizers(TaskSchedulerCustomizer... customizers)	Set the TaskSchedulerCustomizers that should be applied to the ThreadPoolTaskScheduler.
TaskSchedulerBuilder	customizers(Iterable<TaskSchedulerCustomizer> customizers)	Set the taskSchedulerCustomizers that should be applied to the ThreadPoolTaskScheduler.
TaskSchedulerBuilder	poolSize(int poolSize)	Set the maximum allowed number of threads.
TaskSchedulerBuilder	threadNamePrefix(String threadNamePrefix)	Set the prefix to use for the names of newly created threads.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

TaskSchedulerBuilder

public TaskSchedulerBuilder()

TaskSchedulerBuilder

public TaskSchedulerBuilder(@Nullable
 Integer poolSize,
 @Nullable
 Boolean awaitTermination,
 @Nullable
 Duration awaitTerminationPeriod,
 @Nullable
 String threadNamePrefix,
 @Nullable
 Set<TaskSchedulerCustomizer> taskSchedulerCustomizers)

方法详细资料

poolSize

public TaskSchedulerBuilder poolSize(int poolSize)

Set the maximum allowed number of threads.

参数:

poolSize - the pool size to set

返回:

a new builder instance

awaitTermination

public TaskSchedulerBuilder awaitTermination(boolean awaitTermination)

Set whether the executor should wait for scheduled tasks to complete on shutdown, not interrupting running tasks and executing all tasks in the queue.

参数:

awaitTermination - whether the executor needs to wait for the tasks to complete on shutdown

返回:

a new builder instance

另请参阅:

• awaitTerminationPeriod(Duration)

awaitTerminationPeriod

public TaskSchedulerBuilder awaitTerminationPeriod(@Nullable
 Duration awaitTerminationPeriod)

Set the maximum time the executor is supposed to block on shutdown. When set, the executor blocks on shutdown in order to wait for remaining tasks to complete their execution before the rest of the container continues to shut down. This is particularly useful if your remaining tasks are likely to need access to other resources that are also managed by the container.

参数:

awaitTerminationPeriod - the await termination period to set

返回:

a new builder instance

threadNamePrefix

public TaskSchedulerBuilder threadNamePrefix(@Nullable
 String threadNamePrefix)

Set the prefix to use for the names of newly created threads.

参数:

threadNamePrefix - the thread name prefix to set

返回:

a new builder instance

customizers

public TaskSchedulerBuilder customizers(TaskSchedulerCustomizer... customizers)

Set the TaskSchedulerCustomizers that should be applied to the ThreadPoolTaskScheduler. Customizers are applied in the order that they were added after builder configuration has been applied. Setting this value will replace any previously configured customizers.

参数:

customizers - the customizers to set

返回:

a new builder instance

另请参阅:

• additionalCustomizers(TaskSchedulerCustomizer...)

customizers

public TaskSchedulerBuilder customizers(Iterable<TaskSchedulerCustomizer> customizers)

Set the taskSchedulerCustomizers that should be applied to the ThreadPoolTaskScheduler. Customizers are applied in the order that they were added after builder configuration has been applied. Setting this value will replace any previously configured customizers.

参数:

customizers - the customizers to set

返回:

a new builder instance

另请参阅:

• additionalCustomizers(TaskSchedulerCustomizer...)

additionalCustomizers

public TaskSchedulerBuilder additionalCustomizers(TaskSchedulerCustomizer... customizers)

Add taskSchedulerCustomizers that should be applied to the ThreadPoolTaskScheduler. Customizers are applied in the order that they were added after builder configuration has been applied.

参数:

customizers - the customizers to add

返回:

a new builder instance

另请参阅:

• customizers(TaskSchedulerCustomizer...)

additionalCustomizers

public TaskSchedulerBuilder additionalCustomizers(Iterable<TaskSchedulerCustomizer> customizers)

Add taskSchedulerCustomizers that should be applied to the ThreadPoolTaskScheduler. Customizers are applied in the order that they were added after builder configuration has been applied.

参数:

customizers - the customizers to add

返回:

a new builder instance

另请参阅:

• customizers(TaskSchedulerCustomizer...)

build

public ThreadPoolTaskScheduler build()

Build a new ThreadPoolTaskScheduler instance and configure it using this builder.

返回:

a configured ThreadPoolTaskScheduler instance.

另请参阅:

• configure(ThreadPoolTaskScheduler)

configure

public <T extends ThreadPoolTaskScheduler> T configure(T taskScheduler)

Configure the provided ThreadPoolTaskScheduler instance using this builder.

类型参数:

T - the type of task scheduler

参数:

taskScheduler - the ThreadPoolTaskScheduler to configure

返回:

the task scheduler instance

另请参阅:

• build()