ThreadPoolTaskScheduler (Spring Framework 5.2.4.RELEASE API)

java.lang.ObjectSE
- org.springframework.util.CustomizableThreadCreator
- - org.springframework.scheduling.concurrent.CustomizableThreadFactory
  - - org.springframework.scheduling.concurrent.ExecutorConfigurationSupport
    - - org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler

実装されているすべてのインターフェース:
SerializableSE, ExecutorSE, ThreadFactorySE, Aware, BeanNameAware, DisposableBean, InitializingBean, AsyncListenableTaskExecutor, AsyncTaskExecutor, TaskExecutor, SchedulingTaskExecutor, TaskScheduler
```
public class ThreadPoolTaskScheduler
extends ExecutorConfigurationSupport
implements AsyncListenableTaskExecutor, SchedulingTaskExecutor, TaskScheduler
```
ネイティブ ScheduledThreadPoolExecutorSE をラップする Spring の TaskScheduler インターフェースの実装。
導入:
3.0
作成者:
Juergen Hoeller, Mark Fisher
関連事項:
setPoolSize(int), setRemoveOnCancelPolicy(boolean), ExecutorConfigurationSupport.setThreadFactory(java.util.concurrent.ThreadFactory), setErrorHandler(org.springframework.util.ErrorHandler), 連載形式

フィールドのサマリー
- クラス org.springframework.scheduling.concurrent.ExecutorConfigurationSupport から継承されたフィールド
  logger
- インターフェース org.springframework.core.task.AsyncTaskExecutor から継承されたフィールド
  TIMEOUT_IMMEDIATE, TIMEOUT_INDEFINITE

コンストラクターの概要
コンストラクター
コンストラクターと説明
ThreadPoolTaskScheduler()

コンストラクター
コンストラクターと説明
`ThreadPoolTaskScheduler()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected void`	`cancelRemainingTask(RunnableSE task)` `ExecutorService.shutdownNow()`SE から返された、実行を決して推奨しない残りのタスクをキャンセルします。
`protected ScheduledExecutorServiceSE`	`createExecutor(int poolSize, ThreadFactorySE threadFactory, RejectedExecutionHandlerSE rejectedExecutionHandler)` 新しい `ScheduledExecutorService`SE インスタンスを作成します。
`void`	`execute(RunnableSE task)` 指定された `task` を実行します。
`void`	`execute(RunnableSE task, long startTimeout)` 指定された `task` を実行します。
`int`	`getActiveCount()` 現在アクティブなスレッドの数を返します。
`int`	`getPoolSize()` 現在のプールサイズを返します。
`ScheduledExecutorServiceSE`	`getScheduledExecutor()` ネイティブアクセスの基になる ScheduledExecutorService を返します。
`ScheduledThreadPoolExecutorSE`	`getScheduledThreadPoolExecutor()` 可能であれば、基礎となる ScheduledThreadPoolExecutor を返します。
`protected ExecutorServiceSE`	`initializeExecutor(ThreadFactorySE threadFactory, RejectedExecutionHandlerSE rejectedExecutionHandler)` ターゲット `ExecutorService`SE インスタンスを作成します。
`boolean`	`isRemoveOnCancelPolicy()` キャンセル時に削除モードの現在の設定を返します。
`ScheduledFutureSE<?>`	`schedule(RunnableSE task, DateSE startTime)` 指定された `Runnable`SE をスケジュールし、指定された実行時間に呼び出します。
`ScheduledFutureSE<?>`	`schedule(RunnableSE task, Trigger trigger)` 指定された `Runnable`SE をスケジュールし、トリガーが次の実行時間を示すたびに呼び出します。
`ScheduledFutureSE<?>`	`scheduleAtFixedRate(RunnableSE task, DateSE startTime, long period)` 指定された `Runnable`SE をスケジュールし、指定された実行時間に呼び出し、その後、指定された期間で呼び出します。
`ScheduledFutureSE<?>`	`scheduleAtFixedRate(RunnableSE task, long period)` 指定された `Runnable`SE をスケジュールします。できるだけ早く開始し、指定された期間で呼び出します。
`ScheduledFutureSE<?>`	`scheduleWithFixedDelay(RunnableSE task, DateSE startTime, long delay)` 指定された `Runnable`SE をスケジュールし、指定された実行時間に呼び出し、その後、1 つの実行が完了してから次の実行が開始されるまでの間に指定された遅延で呼び出します。
`ScheduledFutureSE<?>`	`scheduleWithFixedDelay(RunnableSE task, long delay)` 指定された `Runnable`SE をスケジュールします。できるだけ早く開始し、1 つの実行が完了してから次の実行が開始されるまでの間に指定された遅延で呼び出します。
`void`	`setErrorHandler(ErrorHandler errorHandler)` カスタム `ErrorHandler` 戦略を設定します。
`void`	`setPoolSize(int poolSize)` ScheduledExecutorService のプールサイズを設定します。
`void`	`setRemoveOnCancelPolicy(boolean removeOnCancelPolicy)` `ScheduledThreadPoolExecutor`SE でキャンセル時に削除モードを設定します。
`<T> FutureSE<T>`	`submit(CallableSE<T> task)` Callable タスクを送信して実行し、そのタスクを表す Future を受け取ります。
`FutureSE<?>`	`submit(RunnableSE task)` 実行可能な Runnable タスクを送信し、そのタスクを表す Future を受け取ります。
`<T> ListenableFuture<T>`	`submitListenable(CallableSE<T> task)` `Callable` タスクを実行のために送信し、そのタスクを表す `ListenableFuture` を受け取ります。
`ListenableFuture<?>`	`submitListenable(RunnableSE task)` `Runnable` タスクを実行のために送信し、そのタスクを表す `ListenableFuture` を受け取ります。

クラス org.springframework.scheduling.concurrent.ExecutorConfigurationSupport から継承されたメソッド
afterPropertiesSet, destroy, initialize, setAwaitTerminationMillis, setAwaitTerminationSeconds, setBeanName, setRejectedExecutionHandler, setThreadFactory, setThreadNamePrefix, setWaitForTasksToCompleteOnShutdown, shutdown

クラス org.springframework.scheduling.concurrent.CustomizableThreadFactory から継承されたメソッド
newThread

クラス org.springframework.util.CustomizableThreadCreator から継承されたメソッド
createThread, getDefaultThreadNamePrefix, getThreadGroup, getThreadNamePrefix, getThreadPriority, isDaemon, nextThreadName, setDaemon, setThreadGroup, setThreadGroupName, setThreadPriority

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

インターフェース org.springframework.scheduling.SchedulingTaskExecutor から継承されたメソッド
prefersShortLivedTasks

インターフェース org.springframework.scheduling.TaskScheduler から継承されたメソッド
schedule, scheduleAtFixedRate, scheduleAtFixedRate, scheduleWithFixedDelay, scheduleWithFixedDelay

- コンストラクターの詳細
  - ThreadPoolTaskScheduler
```
public ThreadPoolTaskScheduler()
```
- メソッドの詳細
  - setPoolSize
```
public void setPoolSize(int poolSize)
```
    ScheduledExecutorService のプールサイズを設定します。デフォルトは 1 です。
    この設定は、JMX などを介して実行時に変更できます。
  - setRemoveOnCancelPolicy
```
public void setRemoveOnCancelPolicy(boolean removeOnCancelPolicy)
```
    ScheduledThreadPoolExecutorSE でキャンセル時に削除モードを設定します。
    デフォルトは false です。true に設定されている場合、ターゲットエグゼキューターはキャンセル時に削除モードに切り替えられます（可能な場合は、ソフトフォールバックが使用されます）。
    この設定は、JMX などを介して実行時に変更できます。
  - setErrorHandler
```
public void setErrorHandler(ErrorHandler errorHandler)
```
    カスタム ErrorHandler 戦略を設定します。
  - initializeExecutor
```
protected ExecutorServiceSE initializeExecutor(ThreadFactorySE threadFactory,
                                             RejectedExecutionHandlerSE rejectedExecutionHandler)
```
    クラスからコピーされた説明: ExecutorConfigurationSupport
    ターゲット ExecutorServiceSE インスタンスを作成します。afterPropertiesSet によって呼び出されます。
    次で指定:
    クラス ExecutorConfigurationSupport の initializeExecutor
    パラメーター:
    threadFactory - 使用する ThreadFactory
    rejectedExecutionHandler - 使用する RejectedExecutionHandler
    戻り値:
    新しい ExecutorService インスタンス
    関連事項:
    ExecutorConfigurationSupport.afterPropertiesSet()
  - createExecutor
```
protected ScheduledExecutorServiceSE createExecutor(int poolSize,
                                                  ThreadFactorySE threadFactory,
                                                  RejectedExecutionHandlerSE rejectedExecutionHandler)
```
    新しい ScheduledExecutorServiceSE インスタンスを作成します。
    デフォルト実装は ScheduledThreadPoolExecutorSE を作成します。サブクラスでオーバーライドして、カスタム ScheduledExecutorServiceSE インスタンスを提供できます。
    パラメーター:
    poolSize - 指定されたプールサイズ
    threadFactory - 使用する ThreadFactory
    rejectedExecutionHandler - 使用する RejectedExecutionHandler
    戻り値:
    新しい ScheduledExecutorService インスタンス
    関連事項:
    ExecutorConfigurationSupport.afterPropertiesSet(), ScheduledThreadPoolExecutorSE
  - getScheduledExecutor
```
public ScheduledExecutorServiceSE getScheduledExecutor()
                                              throws IllegalStateExceptionSE
```
    ネイティブアクセスの基になる ScheduledExecutorService を返します。
    戻り値:
    基になる ScheduledExecutorService (非 null)
    例外:
    IllegalStateExceptionSE - ThreadPoolTaskScheduler がまだ初期化されていない場合
  - getScheduledThreadPoolExecutor
```
public ScheduledThreadPoolExecutorSE getScheduledThreadPoolExecutor()
                                                           throws IllegalStateExceptionSE
```
    可能であれば、基礎となる ScheduledThreadPoolExecutor を返します。
    戻り値:
    基になる ScheduledExecutorService (非 null)
    例外:
    IllegalStateExceptionSE - ThreadPoolTaskScheduler がまだ初期化されていない場合、または基礎となる ScheduledExecutorService が ScheduledThreadPoolExecutor でない場合
    関連事項:
    getScheduledExecutor()
  - getPoolSize
```
public int getPoolSize()
```
    現在のプールサイズを返します。
    基礎となる ScheduledThreadPoolExecutorSE が必要です。
    関連事項:
    getScheduledThreadPoolExecutor(), ThreadPoolExecutor.getPoolSize()SE
  - isRemoveOnCancelPolicy
```
public boolean isRemoveOnCancelPolicy()
```
    キャンセル時に削除モードの現在の設定を返します。
    基礎となる ScheduledThreadPoolExecutorSE が必要です。
  - getActiveCount
```
public int getActiveCount()
```
    現在アクティブなスレッドの数を返します。
    基礎となる ScheduledThreadPoolExecutorSE が必要です。
    関連事項:
    getScheduledThreadPoolExecutor(), ThreadPoolExecutor.getActiveCount()SE
  - execute
```
public void execute(RunnableSE task)
```
    インターフェースからコピーされた説明: TaskExecutor
    指定された task を実行します。
    実装が非同期実行戦略を使用している場合、呼び出しはすぐに戻るか、同期実行の場合はブロックする可能性があります。
    次で指定:
    インターフェース ExecutorSE の executeSE
    次で指定:
    インターフェース TaskExecutor の execute
    パラメーター:
    task - 実行する Runnable (非 null)
  - execute
```
public void execute(RunnableSE task,
                    long startTimeout)
```
    インターフェースからコピーされた説明: AsyncTaskExecutor
    指定された task を実行します。
    次で指定:
    インターフェース AsyncTaskExecutor の execute
    パラメーター:
    task - 実行する Runnable (非 null)
    startTimeout - タスクが開始される予定の期間（ミリ秒）。これはエグゼキューターへのヒントとして意図されており、即時タスクの優先処理を可能にします。一般的な値は AsyncTaskExecutor.TIMEOUT_IMMEDIATE または AsyncTaskExecutor.TIMEOUT_INDEFINITE（TaskExecutor.execute(Runnable) で使用されるデフォルト）です。
  - submit
```
public FutureSE<?> submit(RunnableSE task)
```
    インターフェースからコピーされた説明: AsyncTaskExecutor
    実行可能な Runnable タスクを送信し、そのタスクを表す Future を受け取ります。Future は完了時に null の結果を返します。
    次で指定:
    インターフェース AsyncTaskExecutor の submit
    パラメーター:
    task - 実行する Runnable (非 null)
    戻り値:
    タスクの保留中の完了を表す Future
  - submit
```
public <T> FutureSE<T> submit(CallableSE<T> task)
```
    インターフェースからコピーされた説明: AsyncTaskExecutor
    Callable タスクを送信して実行し、そのタスクを表す Future を受け取ります。Future は、完了時に Callable の結果を返します。
    次で指定:
    インターフェース AsyncTaskExecutor の submit
    パラメーター:
    task - 実行する Callable (非 null)
    戻り値:
    タスクの保留中の完了を表す Future
  - submitListenable
```
public ListenableFuture<?> submitListenable(RunnableSE task)
```
    インターフェースからコピーされた説明: AsyncListenableTaskExecutor
    Runnable タスクを実行のために送信し、そのタスクを表す ListenableFuture を受け取ります。Future は完了時に null の結果を返します。
    次で指定:
    インターフェース AsyncListenableTaskExecutor の submitListenable
    パラメーター:
    task - 実行する Runnable (非 null)
    戻り値:
    保留中のタスクの完了を表す ListenableFuture
  - submitListenable
```
public <T> ListenableFuture<T> submitListenable(CallableSE<T> task)
```
    インターフェースからコピーされた説明: AsyncListenableTaskExecutor
    Callable タスクを実行のために送信し、そのタスクを表す ListenableFuture を受け取ります。Future は、完了時に Callable の結果を返します。
    次で指定:
    インターフェース AsyncListenableTaskExecutor の submitListenable
    パラメーター:
    task - 実行する Callable (非 null)
    戻り値:
    保留中のタスクの完了を表す ListenableFuture
  - cancelRemainingTask
```
protected void cancelRemainingTask(RunnableSE task)
```
    クラスからコピーされた説明: ExecutorConfigurationSupport
    ExecutorService.shutdownNow()SE から返された、実行を決して推奨しない残りのタスクをキャンセルします。
    オーバーライド:
    クラス ExecutorConfigurationSupport の cancelRemainingTask
    パラメーター:
    task - キャンセルするタスク (通常、RunnableFutureSE )
    関連事項:
    ExecutorConfigurationSupport.shutdown(), Future.cancel(boolean)SE
  - schedule
```
@Nullable
public ScheduledFutureSE<?> schedule(RunnableSE task,
                                             Trigger trigger)
```
    インターフェースからコピーされた説明: TaskScheduler
    指定された RunnableSE をスケジュールし、トリガーが次の実行時間を示すたびに呼び出します。
    スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。
    次で指定:
    インターフェース TaskScheduler の schedule
    パラメーター:
    task - トリガーが起動するたびに実行する Runnable
    trigger - Trigger インターフェースの実装。cron 式をラップする CronTrigger オブジェクト
    戻り値:
    タスクの保留中の完了を表す ScheduledFutureSE、または指定された Trigger オブジェクトが起動しない場合は null (つまり、Trigger.nextExecutionTime(org.springframework.scheduling.TriggerContext) から null を返します)
    関連事項:
    CronTrigger
  - schedule
```
public ScheduledFutureSE<?> schedule(RunnableSE task,
                                   DateSE startTime)
```
    インターフェースからコピーされた説明: TaskScheduler
    指定された RunnableSE をスケジュールし、指定された実行時間に呼び出します。
    スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。
    次で指定:
    インターフェース TaskScheduler の schedule
    パラメーター:
    task - トリガーが起動するたびに実行する Runnable
    startTime - タスクの望ましい実行時間 (これが過去の場合、タスクはすぐに、つまりできるだけ早く実行されます)
    戻り値:
    保留中のタスクの完了を表す ScheduledFutureSE
  - scheduleAtFixedRate
```
public ScheduledFutureSE<?> scheduleAtFixedRate(RunnableSE task,
                                              DateSE startTime,
                                              long period)
```
    インターフェースからコピーされた説明: TaskScheduler
    指定された RunnableSE をスケジュールし、指定された実行時間に呼び出し、その後、指定された期間で呼び出します。
    スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。
    次で指定:
    インターフェース TaskScheduler の scheduleAtFixedRate
    パラメーター:
    task - トリガーが起動するたびに実行する Runnable
    startTime - タスクに必要な最初の実行時間 (これが過去の場合、タスクはすぐに、つまりできるだけ早く実行されます)
    period - タスクの連続した実行の間隔 (ミリ秒単位)
    戻り値:
    保留中のタスクの完了を表す ScheduledFutureSE
  - scheduleAtFixedRate
```
public ScheduledFutureSE<?> scheduleAtFixedRate(RunnableSE task,
                                              long period)
```
    インターフェースからコピーされた説明: TaskScheduler
    指定された RunnableSE をスケジュールします。できるだけ早く開始し、指定された期間で呼び出します。
    スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。
    次で指定:
    インターフェース TaskScheduler の scheduleAtFixedRate
    パラメーター:
    task - トリガーが起動するたびに実行する Runnable
    period - タスクの連続した実行の間隔 (ミリ秒単位)
    戻り値:
    保留中のタスクの完了を表す ScheduledFutureSE
  - scheduleWithFixedDelay
```
public ScheduledFutureSE<?> scheduleWithFixedDelay(RunnableSE task,
                                                 DateSE startTime,
                                                 long delay)
```
    インターフェースからコピーされた説明: TaskScheduler
    指定された RunnableSE をスケジュールし、指定された実行時間に呼び出し、その後、1 つの実行が完了してから次の実行が開始されるまでの間に指定された遅延で呼び出します。
    スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。
    次で指定:
    インターフェース TaskScheduler の scheduleWithFixedDelay
    パラメーター:
    task - トリガーが起動するたびに実行する Runnable
    startTime - タスクに必要な最初の実行時間 (これが過去の場合、タスクはすぐに、つまりできるだけ早く実行されます)
    delay - ある実行の補完から次の実行の開始までの遅延 (ミリ秒単位)
    戻り値:
    保留中のタスクの完了を表す ScheduledFutureSE
  - scheduleWithFixedDelay
```
public ScheduledFutureSE<?> scheduleWithFixedDelay(RunnableSE task,
                                                 long delay)
```
    インターフェースからコピーされた説明: TaskScheduler
    指定された RunnableSE をスケジュールします。できるだけ早く開始し、1 つの実行が完了してから次の実行が開始されるまでの間に指定された遅延で呼び出します。
    スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。
    次で指定:
    インターフェース TaskScheduler の scheduleWithFixedDelay
    パラメーター:
    task - トリガーが起動するたびに実行する Runnable
    delay - ある実行の補完から次の実行の開始までの遅延 (ミリ秒単位)
    戻り値:
    保留中のタスクの完了を表す ScheduledFutureSE

クラス ThreadPoolTaskScheduler

フィールドのサマリー

クラス org.springframework.scheduling.concurrent.ExecutorConfigurationSupport から継承されたフィールド

インターフェース org.springframework.core.task.AsyncTaskExecutor から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.scheduling.concurrent.ExecutorConfigurationSupport から継承されたメソッド

クラス org.springframework.scheduling.concurrent.CustomizableThreadFactory から継承されたメソッド

クラス org.springframework.util.CustomizableThreadCreator から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

インターフェース org.springframework.scheduling.SchedulingTaskExecutor から継承されたメソッド

インターフェース org.springframework.scheduling.TaskScheduler から継承されたメソッド

コンストラクターの詳細

ThreadPoolTaskScheduler

メソッドの詳細

setPoolSize

setRemoveOnCancelPolicy

setErrorHandler

initializeExecutor

createExecutor

getScheduledExecutor

getScheduledThreadPoolExecutor

getPoolSize

isRemoveOnCancelPolicy

getActiveCount

execute

execute

submit

submit

submitListenable

submitListenable

cancelRemainingTask

schedule

schedule

scheduleAtFixedRate

scheduleAtFixedRate

scheduleWithFixedDelay

scheduleWithFixedDelay