クラス SimpleAsyncTaskExecutor

メソッドの詳細

• setVirtualThreads

  public void setVirtualThreads(boolean virtual)

  このエグゼキュータを仮想スレッドに切り替えます。Java 21 以上が必要です。

  デフォルトは false で、プラットフォームのスレッドを示します。代わりに仮想スレッドを作成するには、このフラグを true に設定します。

  導入:

  6.1

• setThreadFactory

  public void setThreadFactory(@Nullable ThreadFactorySE threadFactory)

  この executor のローカルプロパティに依存する代わりに、新しいスレッドの作成に使用する外部ファクトリを指定します。

  内部 ThreadFactory Bean を指定することも、JZN（Jakarta EE サーバー上）から取得した ThreadFactory 参照やその他のルックアップメカニズムを指定することもできます。

  関連事項:

  • CustomizableThreadCreator.setThreadNamePrefix(String)
  • CustomizableThreadCreator.setThreadPriority(int)

• getThreadFactory

  public final @Nullable ThreadFactorySE getThreadFactory()

  新しいスレッドを作成するために使用する外部ファクトリがあれば、それを返します。

• setTaskDecorator

  public void setTaskDecorator(TaskDecorator taskDecorator)

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

  このようなデコレータは、必ずしもユーザー提供の Runnable/Callable に適用されるのではなく、実際の実行コールバック（ユーザー提供のタスクのラッパーである可能性があります）に適用されることに注意してください。

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

  注意 : TaskDecorator 実装での例外処理は、execute 呼び出しによる単純な Runnable 実行に制限されています。#submit 呼び出しの場合、公開された Runnable は、例外を伝搬しない FutureTask になります。例外を評価するには、キャストして Future#get を呼び出す必要がある場合があります。

  導入:

  4.3

• setTaskTerminationTimeout

  public void setTaskTerminationTimeout(long timeout)

  このエグゼキューターを閉じるときのタスク終了のタイムアウト (ミリ秒) を指定します。デフォルトは 0 で、タスクの終了をまったく待機しません。

  ここで具体的に>0 のタイムアウトを指定すると、送信されたすべてのタスクがタスク追跡ランナブルにラップされ、タスクの数が多い場合にはかなりのオーバーヘッドが発生することに注意してください。ただし、実行時間が長いタスクを含む中程度のレベルの送信では、正常にシャットダウンするためにこれが可能です。

  SimpleAsyncTaskExecutor は調整されたライフサイクル停止には参加せず、close() でのタスクの終了を待つだけであることに注意してください。

  パラメーター:

  timeout - ミリ秒単位のタイムアウト

  導入:

  6.1

  関連事項:

  • close()
  • setCancelRemainingTasksOnClose(boolean)
  • ExecutorConfigurationSupport.setAwaitTerminationMillis(long)

• setCancelRemainingTasksOnClose

  public void setCancelRemainingTasksOnClose(boolean cancelRemainingTasksOnClose)

  閉じるときに残りのタスクをキャンセルするかどうか、つまり、close() 呼び出し時にアクティブなスレッドを中断するかどうかを指定します。

  デフォルトは false で、アクティブなスレッドを一切追跡しないか、指定された taskTerminationTimeout 経過後もまだ終了していない残りのスレッドのみを中断します。これを true に切り替えると、クローズ時に即時に中断されます。これは、taskTerminationTimeout も指定されているかどうかに応じて、後続の終了タイムアウトと組み合わせて、または全く待機せずに実行されます。

  導入:

  6.2.11

  関連事項:

  • close()
  • setTaskTerminationTimeout(long)
  • ExecutorConfigurationSupport.setWaitForTasksToCompleteOnShutdown(boolean)

• setRejectTasksWhenLimitReached

  public void setRejectTasksWhenLimitReached(boolean rejectTasksWhenLimitReached)

  同時実行制限に達したときにタスクを拒否し、それ以降の実行試行時に TaskRejectedException (共通の RejectedExecutionExceptionSE を継承) をスローするかどうかを指定します。

  デフォルトは false で、送信が受け入れられるまで呼び出し元をブロックします。これを true に切り替えると、即座に拒否されます。

  導入:

  6.2.6

  関連事項:

  • setConcurrencyLimit(int)

• setConcurrencyLimit

  public void setConcurrencyLimit(int concurrencyLimit)

  許可されるタスクの並列実行の最大数を設定します。デフォルトの -1 は、同時実行制限がまったくないことを示します。

  これはスレッドプールの最大プールサイズに相当し、スレッド管理システムの一時的なオーバーロードを防ぎます。ただし、管理されたタスクキューを持つスレッドプールとは異なり、このエグゼキュータは、構成された同時実行制限に達したときにタスクが受け入れられるまでサブミッタをブロックします。このようなブロックのないキューベースのタスクハンドオフを希望する場合は、代わりに ThreadPoolTaskExecutor の使用を検討してください。

  関連事項:

  • UNBOUNDED_CONCURRENCY
  • ThreadPoolTaskExecutor.setMaxPoolSize(int)

• getConcurrencyLimit

  public final int getConcurrencyLimit()

  許可される並列タスク実行の最大数を返します。

• isThrottleActive

  public final boolean isThrottleActive()

  同時実行スロットルが現在アクティブかどうかを返します。

  戻り値:

  このインスタンスの同時実行制限がアクティブな場合、true 

  関連事項:

  • getConcurrencyLimit()
  • setConcurrencyLimit(int)

• isActive

  public boolean isActive()

  このエグゼキュータがまだアクティブであるかどうか、つまりまだ閉じられていないため、さらなるタスクの送信を受け入れるかどうかを返します。それ以外の場合は、タスク終了フェーズにあるか、すでに完全にシャットダウンされています。

  導入:

  6.1

  関連事項:

  • setTaskTerminationTimeout(long)
  • close()

• execute

  public void execute(RunnableSE task)

  （スーパークラスの設定を介して）構成されている場合、同時実行スロットル内で、指定されたタスクを実行します。

  次で指定:

  インターフェース ExecutorSE の executeSE 

  次で指定:

  インターフェース TaskExecutor の execute 

  パラメーター:

  task - 実行する Runnable (非 null)

  関連事項:

  • doExecute(Runnable)

• execute

  @DeprecatedSE(since="5.3.16") public void execute(RunnableSE task, long startTimeout)

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

  （スーパークラスの設定を介して）構成されている場合、同時実行スロットル内で、指定されたタスクを実行します。

  同時実行スロットル（アクティブな場合）をバイパスして、緊急タスク（「即時」タイムアウトで）を直接実行します。他のすべてのタスクはスロットルの影響を受けます。

  次で指定:

  インターフェース AsyncTaskExecutor の execute 

  パラメーター:

  task - 実行する Runnable (非 null)

  startTimeout - タスクが開始される予定の期間（ミリ秒）。これはエグゼキューターへのヒントとして意図されており、即時タスクの優先処理を可能にします。一般的な値は AsyncTaskExecutor.TIMEOUT_IMMEDIATE または AsyncTaskExecutor.TIMEOUT_INDEFINITE（TaskExecutor.execute(Runnable) で使用されるデフォルト）です。

  関連事項:

  • AsyncTaskExecutor.TIMEOUT_IMMEDIATE
  • doExecute(Runnable)

• 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

• doExecute

  protected void doExecute(RunnableSE task)

  タスクを実際に実行するためのテンプレートメソッド。

  デフォルトの実装では、新しいスレッドを作成して開始します。

  パラメーター:

  task - 実行する Runnable

  関連事項:

  • newThread(Runnable)
  • Thread.start()

• newThread

  protected ThreadSE newThread(RunnableSE task)

  指定されたタスクの新しいスレッドを作成します。

  パラメーター:

  task - スレッドを作成するための Runnable

  戻り値:

  新しいスレッドインスタンス

  導入:

  6.1

  関連事項:

  • setVirtualThreads(boolean)
  • setThreadFactory(ThreadFactory)
  • CustomizableThreadCreator.createThread(Runnable)

• close

  public void close()

  この close メソッドは、具体的な task termination timeout が設定されている場合、アクティブなスレッドの終了を追跡します。それ以外の場合は、この executor を閉じる必要はありません。

  次で指定:

  インターフェース AutoCloseableSE の close 

  導入:

  6.1