クラス ThreadPoolTaskScheduler

メソッドの詳細

• setPoolSize

  public void setPoolSize(int poolSize)

  ScheduledExecutorService のプールサイズを設定します。デフォルトは 1 です。

  この設定は、JMX などを介して実行時に変更できます。

• setRemoveOnCancelPolicy

  public void setRemoveOnCancelPolicy(boolean flag)

  ScheduledThreadPoolExecutorSE でキャンセル時に削除モードを設定します。

  デフォルトは false です。true に設定されている場合、ターゲットエグゼキュータは削除オンキャンセルモードに切り替えられます（可能な場合）。

  この設定は、JMX などを介して実行時に変更できます。

  関連事項:

  • ScheduledThreadPoolExecutor.setRemoveOnCancelPolicy(boolean)SE

• setContinueExistingPeriodicTasksAfterShutdownPolicy

  public void setContinueExistingPeriodicTasksAfterShutdownPolicy(boolean flag)

  このエグゼキュータがシャットダウンされた場合でも、既存の定期的なタスクを続行するかどうかを設定します。

  デフォルトは false です。true に設定されている場合、ターゲットエグゼキュータは継続的な定期タスクに切り替えられます（可能な場合）。

  この設定は、JMX などを介して実行時に変更できます。

  導入:

  5.3.9

  関連事項:

  • ScheduledThreadPoolExecutor.setContinueExistingPeriodicTasksAfterShutdownPolicy(boolean)SE

• setExecuteExistingDelayedTasksAfterShutdownPolicy

  public void setExecuteExistingDelayedTasksAfterShutdownPolicy(boolean flag)

  このエグゼキュータがシャットダウンされている場合でも、既存の遅延タスクを実行するかどうかを設定します。

  デフォルトは true です。false に設定されている場合、ターゲットエグゼキュータは残りのタスクをドロップするように切り替えられます（可能な場合）。

  この設定は、JMX などを介して実行時に変更できます。

  導入:

  5.3.9

  関連事項:

  • ScheduledThreadPoolExecutor.setExecuteExistingDelayedTasksAfterShutdownPolicy(boolean)SE

• setTaskDecorator

  public void setTaskDecorator(TaskDecorator taskDecorator)

  実行しようとしている RunnableSE に適用するカスタム TaskDecorator を指定します。

  このようなデコレータは、ユーザー指定の Runnable/Callable には適用されず、スケジュールされた実行コールバック (ユーザー指定のタスクのラッパー) に適用されることに注意してください。

  主な使用例は、タスクの呼び出しの周囲に実行コンテキストを設定するか、タスク実行の監視 / 統計を提供することです。

  導入:

  6.2

• setErrorHandler

  public void setErrorHandler(ErrorHandler errorHandler)

  カスタム ErrorHandler 戦略を設定します。

• setClock

  public void setClock(ClockSE clock)

  スケジューリングの目的で使用する監視を設定します。

  デフォルトのクロックは、デフォルトのタイムゾーンのシステムクロックです。

  導入:

  5.3

  関連事項:

  • Clock.systemDefaultZone()

• getClock

  public ClockSE getClock()

  インターフェースからコピーされた説明: TaskScheduler

  スケジューリングの目的で使用する監視を返します。

  次で指定:

  インターフェース TaskScheduler の getClock 

  関連事項:

  • Clock.systemDefaultZone()

• 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()

• getActiveCount

  public int getActiveCount()

  現在アクティブなスレッドの数を返します。

  基礎となる ScheduledThreadPoolExecutorSE が必要です。

  関連事項:

  • getScheduledThreadPoolExecutor()
  • ThreadPoolExecutor.getActiveCount()

• isRemoveOnCancelPolicy

  @DeprecatedSE public boolean isRemoveOnCancelPolicy()

  使用すべきではありません。

  5.3.9 の時点で、getScheduledThreadPoolExecutor() への直接アクセスを優先

  キャンセル時に削除モードの現在の設定を返します。

  基礎となる ScheduledThreadPoolExecutorSE が必要です。

• execute

  public void execute(RunnableSE task)

  インターフェースからコピーされた説明: TaskExecutor

  指定された task を実行します。

  実装が非同期実行戦略を使用している場合、呼び出しはすぐに戻るか、同期実行の場合はブロックする可能性があります。

  次で指定:

  インターフェース ExecutorSE の executeSE 

  次で指定:

  インターフェース TaskExecutor の execute 

  パラメーター:

  task - 実行する Runnable (非 null)

• submit

  public FutureSE<?> submit(RunnableSE task)

  インターフェースからコピーされた説明: AsyncTaskExecutor

  実行可能な Runnable タスクを送信し、そのタスクを表す Future を受け取ります。Future は完了時に null の結果を返します。

  6.1 では、このメソッドには TaskExecutor.execute(Runnable) に委譲するデフォルトの実装が付属しています。

  次で指定:

  インターフェース AsyncTaskExecutor の submit 

  パラメーター:

  task - 実行する Runnable (非 null)

  戻り値:

  タスクの保留中の完了を表す Future

• submit

  public <T> FutureSE<T> submit(CallableSE<T> task)

  インターフェースからコピーされた説明: AsyncTaskExecutor

  Callable タスクを送信して実行し、そのタスクを表す Future を受け取ります。Future は、完了時に Callable の結果を返します。

  6.1 では、このメソッドには TaskExecutor.execute(Runnable) に委譲するデフォルトの実装が付属しています。

  次で指定:

  インターフェース 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() から返された、実行を開始していない指定された残りのタスクをキャンセルします。

  オーバーライド:

  クラス 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、または指定されたトリガーオブジェクトが決して起動しない場合は null (つまり、Trigger.nextExecution(org.springframework.scheduling.TriggerContext) から null を返します)

  関連事項:

  • CronTrigger

• schedule

  public ScheduledFutureSE<?> schedule(RunnableSE task, InstantSE startTime)

  インターフェースからコピーされた説明: TaskScheduler

  指定された RunnableSE をスケジュールし、指定された実行時間に呼び出します。

  スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。

  次で指定:

  インターフェース TaskScheduler の schedule 

  パラメーター:

  task - トリガーが起動するたびに実行する Runnable

  startTime - タスクの望ましい実行時間 (これが過去の場合、タスクはすぐに、つまりできるだけ早く実行されます)

  戻り値:

  タスクの保留中の実行を表す ScheduledFutureSE

• scheduleAtFixedRate

  public ScheduledFutureSE<?> scheduleAtFixedRate(RunnableSE task, InstantSE startTime, DurationSE period)

  インターフェースからコピーされた説明: TaskScheduler

  指定された RunnableSE をスケジュールし、指定された実行時間に呼び出し、その後、指定された期間で呼び出します。

  スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。

  次で指定:

  インターフェース TaskScheduler の scheduleAtFixedRate 

  パラメーター:

  task - トリガーが起動するたびに実行する Runnable

  startTime - タスクに必要な最初の実行時間 (これが過去の場合、タスクはすぐに、つまりできるだけ早く実行されます)

  period - タスクの連続した実行の間隔

  戻り値:

  タスクの保留中の実行を表す ScheduledFutureSE

• scheduleAtFixedRate

  public ScheduledFutureSE<?> scheduleAtFixedRate(RunnableSE task, DurationSE period)

  インターフェースからコピーされた説明: TaskScheduler

  指定された RunnableSE をスケジュールします。できるだけ早く開始し、指定された期間で呼び出します。

  スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。

  次で指定:

  インターフェース TaskScheduler の scheduleAtFixedRate 

  パラメーター:

  task - トリガーが起動するたびに実行する Runnable

  period - タスクの連続した実行の間隔

  戻り値:

  タスクの保留中の実行を表す ScheduledFutureSE

• scheduleWithFixedDelay

  public ScheduledFutureSE<?> scheduleWithFixedDelay(RunnableSE task, InstantSE startTime, DurationSE delay)

  インターフェースからコピーされた説明: TaskScheduler

  指定された RunnableSE をスケジュールし、指定された実行時間に呼び出し、その後、1 つの実行が完了してから次の実行が開始されるまでの間に指定された遅延で呼び出します。

  スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。

  次で指定:

  インターフェース TaskScheduler の scheduleWithFixedDelay 

  パラメーター:

  task - トリガーが起動するたびに実行する Runnable

  startTime - タスクに必要な最初の実行時間 (これが過去の場合、タスクはすぐに、つまりできるだけ早く実行されます)

  delay - ある実行の補完から次の実行の開始までの遅延

  戻り値:

  タスクの保留中の実行を表す ScheduledFutureSE

• scheduleWithFixedDelay

  public ScheduledFutureSE<?> scheduleWithFixedDelay(RunnableSE task, DurationSE delay)

  インターフェースからコピーされた説明: TaskScheduler

  指定された RunnableSE をスケジュールします。できるだけ早く開始し、1 つの実行が完了してから次の実行が開始されるまでの間に指定された遅延で呼び出します。

  スケジューラがシャットダウンするか、返された ScheduledFutureSE がキャンセルされると、実行は終了します。

  次で指定:

  インターフェース TaskScheduler の scheduleWithFixedDelay 

  パラメーター:

  task - トリガーが起動するたびに実行する Runnable

  delay - ある実行の補完から次の実行の開始までの遅延

  戻り値:

  タスクの保留中の実行を表す ScheduledFutureSE