类 ThreadPoolTaskScheduler

构造器详细资料

• 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

  @UsesJava7
  public void setRemoveOnCancelPolicy​(boolean removeOnCancelPolicy)

  Set the remove-on-cancel mode on ScheduledThreadPoolExecutor (JDK 7+).

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

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

• setErrorHandler

  public void setErrorHandler​(ErrorHandler errorHandler)

  Set a custom ErrorHandler strategy.

• initializeExecutor

  @UsesJava7
  protected ExecutorService initializeExecutor​(ThreadFactory threadFactory,
                                               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 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.

  参数:

  poolSize - the specified pool size

  threadFactory - the ThreadFactory to use

  rejectedExecutionHandler - the RejectedExecutionHandler to use

  返回:

  a new ScheduledExecutorService instance

  另请参阅:

  ExecutorConfigurationSupport.afterPropertiesSet(), ScheduledThreadPoolExecutor

• getScheduledExecutor

  public ScheduledExecutorService getScheduledExecutor()
                                                throws IllegalStateException

  Return the underlying ScheduledExecutorService for native access.

  返回:

  the underlying ScheduledExecutorService (never null)

  抛出:

  IllegalStateException - if the ThreadPoolTaskScheduler hasn't been initialized yet

• getScheduledThreadPoolExecutor

  public ScheduledThreadPoolExecutor getScheduledThreadPoolExecutor()
                                                             throws IllegalStateException

  Return the underlying ScheduledThreadPoolExecutor, if available.

  返回:

  the underlying ScheduledExecutorService (never null)

  抛出:

  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

  @UsesJava7
  public boolean isRemoveOnCancelPolicy()

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

  Requires an underlying ScheduledThreadPoolExecutor.

• getActiveCount

  public int getActiveCount()

  Return the number of currently active threads.

  Requires an underlying ScheduledThreadPoolExecutor.

  另请参阅:

  getScheduledThreadPoolExecutor(), ThreadPoolExecutor.getActiveCount()

• execute

  public void execute​(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 在接口中 Executor

  指定者:

  execute 在接口中 TaskExecutor

  参数:

  task - the Runnable to execute (never null)

• execute

  public void execute​(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 Future<?> submit​(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> Future<T> submit​(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​(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​(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 ScheduledFuture<?> schedule​(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 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.springframework.scheduling.TriggerContext))

  另请参阅:

  CronTrigger

• schedule

  public ScheduledFuture<?> schedule​(Runnable task,
                                     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 ScheduledFuture<?> scheduleAtFixedRate​(Runnable task,
                                                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 ScheduledFuture<?> scheduleAtFixedRate​(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 ScheduledFuture<?> scheduleWithFixedDelay​(Runnable task,
                                                   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 ScheduledFuture<?> scheduleWithFixedDelay​(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