org.frameworkset.schedule

类 ThreadPoolTaskScheduler

java.lang.Object

org.frameworkset.util.CustomizableThreadCreator

org.frameworkset.schedule.CustomizableThreadFactory

org.frameworkset.schedule.ExecutorConfigurationSupport

org.frameworkset.schedule.ThreadPoolTaskScheduler

所有已实现的接口:

java.io.Serializable, java.util.concurrent.Executor, java.util.concurrent.ThreadFactory, AsyncListenableTaskExecutor, AsyncTaskExecutor, SchedulingTaskExecutor, TaskExecutor, TaskScheduler, BeanNameAware, DisposableBean, InitializingBean

public class ThreadPoolTaskScheduler
extends ExecutorConfigurationSupport
implements AsyncListenableTaskExecutor, SchedulingTaskExecutor, TaskScheduler

另请参阅:

序列化表格

字段概要

从类继承的字段 org.frameworkset.schedule.ExecutorConfigurationSupport

logger

从接口继承的字段 org.frameworkset.schedule.AsyncTaskExecutor

TIMEOUT_IMMEDIATE, TIMEOUT_INDEFINITE

构造器概要

构造器

构造器和说明
ThreadPoolTaskScheduler()

方法概要

限定符和类型	方法和说明
protected java.util.concurrent.ScheduledExecutorService	createExecutor(int poolSize, java.util.concurrent.ThreadFactory threadFactory, java.util.concurrent.RejectedExecutionHandler rejectedExecutionHandler) Create a new ScheduledExecutorService instance.
void	execute(java.lang.Runnable task) Execute the given task.
void	execute(java.lang.Runnable task, long startTimeout) Execute the given task.
int	getActiveCount() Return the number of currently active threads.
int	getPoolSize() Return the current pool size.
java.util.concurrent.ScheduledExecutorService	getScheduledExecutor() Return the underlying ScheduledExecutorService for native access.
java.util.concurrent.ScheduledThreadPoolExecutor	getScheduledThreadPoolExecutor() Return the underlying ScheduledThreadPoolExecutor, if available.
protected java.util.concurrent.ExecutorService	initializeExecutor(java.util.concurrent.ThreadFactory threadFactory, java.util.concurrent.RejectedExecutionHandler rejectedExecutionHandler) Create the target ExecutorService instance.
boolean	isRemoveOnCancelPolicy() Return the current setting of removeOnCancelPolicy.
boolean	prefersShortLivedTasks() Does this TaskExecutor prefer short-lived tasks over long-lived tasks?
java.util.concurrent.ScheduledFuture<?>	schedule(java.lang.Runnable task, java.util.Date startTime) Schedule the given Runnable, invoking it at the specified execution time.
java.util.concurrent.ScheduledFuture<?>	schedule(java.lang.Runnable task, Trigger trigger) Schedule the given Runnable, invoking it whenever the trigger indicates a next execution time.
java.util.concurrent.ScheduledFuture<?>	scheduleAtFixedRate(java.lang.Runnable task, java.util.Date startTime, long period) Schedule the given Runnable, invoking it at the specified execution time and subsequently with the given period.
java.util.concurrent.ScheduledFuture<?>	scheduleAtFixedRate(java.lang.Runnable task, long period) Schedule the given Runnable, starting as soon as possible and invoking it with the given period.
java.util.concurrent.ScheduledFuture<?>	scheduleWithFixedDelay(java.lang.Runnable task, java.util.Date startTime, long 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.
java.util.concurrent.ScheduledFuture<?>	scheduleWithFixedDelay(java.lang.Runnable task, long 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.
void	setErrorHandler(ErrorHandler errorHandler) Set a custom ErrorHandler strategy.
void	setPoolSize(int poolSize) Set the ScheduledExecutorService's pool size.
void	setRemoveOnCancelPolicy(boolean removeOnCancelPolicy) Set the same property on ScheduledExecutorService (JDK 1.7+).
<T> java.util.concurrent.Future<T>	submit(java.util.concurrent.Callable<T> task) Submit a Callable task for execution, receiving a Future representing that task.
java.util.concurrent.Future<?>	submit(java.lang.Runnable task) Submit a Runnable task for execution, receiving a Future representing that task.
<T> ListenableFuture<T>	submitListenable(java.util.concurrent.Callable<T> task) Submit a Callable task for execution, receiving a ListenableFuture representing that task.
ListenableFuture<?>	submitListenable(java.lang.Runnable task) Submit a Runnable task for execution, receiving a ListenableFuture representing that task.

从类继承的方法 org.frameworkset.schedule.ExecutorConfigurationSupport

afterPropertiesSet, destroy, initialize, setAwaitTerminationSeconds, setBeanName, setRejectedExecutionHandler, setThreadFactory, setThreadNamePrefix, setWaitForTasksToCompleteOnShutdown, shutdown

从类继承的方法 org.frameworkset.schedule.CustomizableThreadFactory

newThread

从类继承的方法 org.frameworkset.util.CustomizableThreadCreator

createThread, getDefaultThreadNamePrefix, getThreadGroup, getThreadNamePrefix, getThreadPriority, isDaemon, nextThreadName, setDaemon, setThreadGroup, setThreadGroupName, setThreadPriority

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

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

构造器详细资料

ThreadPoolTaskScheduler

public ThreadPoolTaskScheduler()

方法详细资料

setPoolSize

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

public void setRemoveOnCancelPolicy(boolean removeOnCancelPolicy)

Set the same property on ScheduledExecutorService (JDK 1.7+). There is no default. If not set, the executor property is not set.

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

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)

Set a custom ErrorHandler strategy.

initializeExecutor

protected java.util.concurrent.ExecutorService initializeExecutor(java.util.concurrent.ThreadFactory threadFactory,
                                                                  java.util.concurrent.RejectedExecutionHandler rejectedExecutionHandler)

从类复制的说明: ExecutorConfigurationSupport

Create the target ExecutorService instance. Called by afterPropertiesSet.

指定者:

initializeExecutor 在类中 ExecutorConfigurationSupport

参数:

threadFactory - the ThreadFactory to use

rejectedExecutionHandler - the RejectedExecutionHandler to use

返回:

a new ExecutorService instance

另请参阅:

ExecutorConfigurationSupport.afterPropertiesSet()

createExecutor

protected java.util.concurrent.ScheduledExecutorService createExecutor(int poolSize,
                                                                       java.util.concurrent.ThreadFactory threadFactory,
                                                                       java.util.concurrent.RejectedExecutionHandler rejectedExecutionHandler)

Create a new ScheduledExecutorService instance.

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

参数:

poolSize - the specified pool size

threadFactory - the ThreadFactory to use

rejectedExecutionHandler - the RejectedExecutionHandler to use

返回:

a new ScheduledExecutorService instance

另请参阅:

ExecutorConfigurationSupport.afterPropertiesSet(), ScheduledThreadPoolExecutor

getScheduledExecutor

public java.util.concurrent.ScheduledExecutorService getScheduledExecutor()
                                                                   throws java.lang.IllegalStateException

Return the underlying ScheduledExecutorService for native access.

返回:

the underlying ScheduledExecutorService (never null)

抛出:

java.lang.IllegalStateException - if the ThreadPoolTaskScheduler hasn't been initialized yet

getScheduledThreadPoolExecutor

public java.util.concurrent.ScheduledThreadPoolExecutor getScheduledThreadPoolExecutor()
                                                                                throws java.lang.IllegalStateException

Return the underlying ScheduledThreadPoolExecutor, if available.

返回:

the underlying ScheduledExecutorService (never null)

抛出:

java.lang.IllegalStateException - if the ThreadPoolTaskScheduler hasn't been initialized yet or if the underlying ScheduledExecutorService isn't a ScheduledThreadPoolExecutor

另请参阅:

getScheduledExecutor()

getPoolSize

public int getPoolSize()

Return the current pool size.

Requires an underlying ScheduledThreadPoolExecutor.

另请参阅:

getScheduledThreadPoolExecutor(), ThreadPoolExecutor.getPoolSize()

isRemoveOnCancelPolicy

public boolean isRemoveOnCancelPolicy()

Return the current setting of removeOnCancelPolicy.

Requires an underlying ScheduledThreadPoolExecutor and JDK 1.7+.

getActiveCount

public int getActiveCount()

Return the number of currently active threads.

Requires an underlying ScheduledThreadPoolExecutor.

另请参阅:

getScheduledThreadPoolExecutor(), ThreadPoolExecutor.getActiveCount()

execute

public void execute(java.lang.Runnable task)

从接口复制的说明: TaskExecutor

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.

指定者:

execute 在接口中 java.util.concurrent.Executor

指定者:

execute 在接口中 TaskExecutor

参数:

task - the Runnable to execute (never null)

execute

public void execute(java.lang.Runnable task,
                    long startTimeout)

从接口复制的说明: AsyncTaskExecutor

Execute the given task.

指定者:

execute 在接口中 AsyncTaskExecutor

参数:

task - the Runnable to execute (never null)

startTimeout - the time duration (milliseconds) within which the task is supposed to start. This is intended as a hint to the executor, allowing for preferred handling of immediate tasks. Typical values are AsyncTaskExecutor.TIMEOUT_IMMEDIATE or AsyncTaskExecutor.TIMEOUT_INDEFINITE (the default as used by TaskExecutor.execute(Runnable)).

submit

public java.util.concurrent.Future<?> submit(java.lang.Runnable task)

从接口复制的说明: AsyncTaskExecutor

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

指定者:

submit 在接口中 AsyncTaskExecutor

参数:

task - the Runnable to execute (never null)

返回:

a Future representing pending completion of the task

submit

public <T> java.util.concurrent.Future<T> submit(java.util.concurrent.Callable<T> task)

从接口复制的说明: AsyncTaskExecutor

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

指定者:

submit 在接口中 AsyncTaskExecutor

参数:

task - the Callable to execute (never null)

返回:

a Future representing pending completion of the task

submitListenable

public ListenableFuture<?> submitListenable(java.lang.Runnable task)

从接口复制的说明: AsyncListenableTaskExecutor

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

指定者:

submitListenable 在接口中 AsyncListenableTaskExecutor

参数:

task - the Runnable to execute (never null)

返回:

a ListenableFuture representing pending completion of the task

submitListenable

public <T> ListenableFuture<T> submitListenable(java.util.concurrent.Callable<T> task)

从接口复制的说明: AsyncListenableTaskExecutor

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

指定者:

submitListenable 在接口中 AsyncListenableTaskExecutor

参数:

task - the Callable to execute (never null)

返回:

a ListenableFuture representing pending completion of the task

prefersShortLivedTasks

public boolean prefersShortLivedTasks()

从接口复制的说明: SchedulingTaskExecutor

Does this TaskExecutor prefer short-lived tasks over long-lived tasks?

A SchedulingTaskExecutor implementation can indicate whether it prefers submitted tasks to perform as little work as they can within a single task execution. For example, submitted tasks might break a repeated loop into individual subtasks which submit a follow-up task afterwards (if feasible).

This should be considered a hint. Of course TaskExecutor clients are free to ignore this flag and hence the SchedulingTaskExecutor interface overall. However, thread pools will usually indicated a preference for short-lived tasks, to be able to perform more fine-grained scheduling.

指定者:

prefersShortLivedTasks 在接口中 SchedulingTaskExecutor

返回:

true if this TaskExecutor prefers short-lived tasks

schedule

public java.util.concurrent.ScheduledFuture<?> schedule(java.lang.Runnable task,
                                                        Trigger trigger)

从接口复制的说明: TaskScheduler

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.

指定者:

schedule 在接口中 TaskScheduler

参数:

task - the Runnable to execute whenever the trigger fires

trigger - an implementation of the Trigger interface, e.g. a org.frameworkset.scheduling.support.CronTrigger object wrapping a cron expression

返回:

a ScheduledFuture representing pending completion of the task, or null if the given Trigger object never fires (i.e. returns null from Trigger.nextExecutionTime(org.frameworkset.schedule.TriggerContext))

另请参阅:

org.frameworkset.scheduling.support.CronTrigger

schedule

public java.util.concurrent.ScheduledFuture<?> schedule(java.lang.Runnable task,
                                                        java.util.Date startTime)

从接口复制的说明: TaskScheduler

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.

指定者:

schedule 在接口中 TaskScheduler

参数:

task - the Runnable to execute whenever the trigger fires

startTime - 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)

返回:

a ScheduledFuture representing pending completion of the task

scheduleAtFixedRate

public java.util.concurrent.ScheduledFuture<?> scheduleAtFixedRate(java.lang.Runnable task,
                                                                   java.util.Date startTime,
                                                                   long period)

从接口复制的说明: TaskScheduler

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.

指定者:

scheduleAtFixedRate 在接口中 TaskScheduler

参数:

task - the Runnable to execute whenever the trigger fires

startTime - 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 - the interval between successive executions of the task (in milliseconds)

返回:

a ScheduledFuture representing pending completion of the task

scheduleAtFixedRate

public java.util.concurrent.ScheduledFuture<?> scheduleAtFixedRate(java.lang.Runnable task,
                                                                   long period)

从接口复制的说明: TaskScheduler

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.

指定者:

scheduleAtFixedRate 在接口中 TaskScheduler

参数:

task - the Runnable to execute whenever the trigger fires

period - the interval between successive executions of the task (in milliseconds)

返回:

a ScheduledFuture representing pending completion of the task

scheduleWithFixedDelay

public java.util.concurrent.ScheduledFuture<?> scheduleWithFixedDelay(java.lang.Runnable task,
                                                                      java.util.Date startTime,
                                                                      long delay)

从接口复制的说明: TaskScheduler

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.

指定者:

scheduleWithFixedDelay 在接口中 TaskScheduler

参数:

task - the Runnable to execute whenever the trigger fires

startTime - 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 - the delay between the completion of one execution and the start of the next (in milliseconds)

返回:

a ScheduledFuture representing pending completion of the task

scheduleWithFixedDelay

public java.util.concurrent.ScheduledFuture<?> scheduleWithFixedDelay(java.lang.Runnable task,
                                                                      long delay)

从接口复制的说明: TaskScheduler

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.

指定者:

scheduleWithFixedDelay 在接口中 TaskScheduler

参数:

task - the Runnable to execute whenever the trigger fires

delay - the interval between successive executions of the task (in milliseconds)

返回:

a ScheduledFuture representing pending completion of the task