java.util.concurrent
インタフェース ExecutorService

すべてのスーパーインタフェース:

Executor

既知のサブインタフェースの一覧:

ScheduledExecutorService

既知の実装クラスの一覧:

AbstractExecutorService, ScheduledThreadPoolExecutor, ThreadPoolExecutor

public interface ExecutorService
extends Executor

終了を管理するメソッド、および 1 つ以上の非同期タスクの進行状況を追跡する Future を生成可能なメソッドを提供する Executor。

ExecutorService は、新規タスクの受け入れを停止するシャットダウンが可能です。シャットダウンすると executor は最終的に終了しますが、その時点では、実行中のアクティブなタスクや実行を待機中のタスクは存在せず、新規タスクを送信することもできません。

submit メソッドは、実行の取り消しや完了の待機に使用できる Future を作成して返すことにより、基底メソッド Executor.execute(java.lang.Runnable) を拡張します。invokeAny および invokeAll メソッドは、通常利便性のもっとも高い形式の一括実行を行い、タスクのコレクションを実行して、1 つ以上またはすべてが完了するのを待機します。ExecutorCompletionService クラスを、これらのメソッドのカスタマイズされたバリアントの書き込みに使用できます。

Executors クラスは、このパッケージで提供される executor サービス用のファクトリメソッドを提供します。

使用例

次に示すネットワークサービスの概略では、要求が着信するスレッドプールサービス内のスレッドを示します。これは、構成済みの Executors.newFixedThreadPool(int) ファクトリメソッドを使用します。

 class NetworkService {
    private final ServerSocket serverSocket;
    private final ExecutorService pool;

    public NetworkService(int port, int poolSize) throws IOException {
      serverSocket = new ServerSocket(port);
      pool = Executors.newFixedThreadPool(poolSize);
    }
 
    public void serve() {
      try {
        for (;;) {
          pool.execute(new Handler(serverSocket.accept()));
        }
      } catch (IOException ex) {
        pool.shutdown();
      }
    }
  }

  class Handler implements Runnable {
    private final Socket socket;
    Handler(Socket socket) { this.socket = socket; }
    public void run() {
      // read and service request
    }
 }
 

導入されたバージョン:

1.5

メソッドの概要

boolean	awaitTermination(long timeout, TimeUnit unit) シャットダウン要求後にすべてのタスクが実行を完了する、タイムアウトが発生する、現在のスレッドで割り込みが発生する、のどれかが最初に起きるまでブロックします。
<T> List<Future<T>>	invokeAll(Collection<Callable<T>> tasks) 指定されたタスクを実行し、Future のリストをステータスとともに返し、すべてが完了したら結果を返します。
<T> List<Future<T>>	invokeAll(Collection<Callable<T>> tasks, long timeout, TimeUnit unit) 指定されたタスクを実行し、Future のリストをステータスとともに返し、すべてが完了するかまたは時間切れになるかのいずれか早い時点で結果を返します。
<T> T	invokeAny(Collection<Callable<T>> tasks) 指定されたタスクを実行し、正常に完了したタスクが存在する場合は、その結果を (例外をスローせずに) 返します。
<T> T	invokeAny(Collection<Callable<T>> tasks, long timeout, TimeUnit unit) 指定されたタスクを実行し、タイムアウトになる前に正常に完了したタスクが存在する場合は、その結果を (例外をスローせずに) 返します。
boolean	isShutdown() この executorがシャットダウンした場合、true を返します。
boolean	isTerminated() シャットダウンに続いてすべてのタスクが完了した場合に、true を返します。
void	shutdown() 順序に従って実行されるシャットダウンを開始します。
List<Runnable>	shutdownNow() 実行中のアクティブなタスクすべての停止を試み、待機中のタスクの処理を停止し、実行を待機していたタスクのリストを返します。
<T> Future<T>	submit(Callable<T> task) 値を返す実行タスクを送信し、保留中のタスク結果を表す Future を返します。
Future<?>	submit(Runnable task) 実行用の Runnable タスクを送信し、そのタスクを表す Future を返します。
<T> Future<T>	submit(Runnable task, T result) 実行用の Runnable タスクを送信して、完了時に指定された結果を返すタスクを表す Future を返します。

インタフェース java.util.concurrent.Executor から継承されたメソッド

execute

メソッドの詳細

shutdown

void shutdown()

順序に従って実行されるシャットダウンを開始します。以前に送信されたタスクが実行されますが、新規タスクは受け入れられません。シャットダウン後に呼び出しを実行しても、効果はありません。

例外:

SecurityException - セキュリティマネージャが存在する状況でシャットダウンを実行すると、この ExecutorService が呼び出し側には変更を許可されないスレッドを操作できる場合。これは、RuntimePermission("modifyThread") を保持しないか、セキュリティマネージャの checkAccess メソッドがアクセスを拒否するためである

shutdownNow

List<Runnable> shutdownNow()

実行中のアクティブなタスクすべての停止を試み、待機中のタスクの処理を停止し、実行を待機していたタスクのリストを返します。

実行中のアクティブなタスク処理を停止するために最善の努力をすること以上の保証はありません。たとえば、通常の実装では Thread.interrupt() を介して取り消しが行われるため、タスクが割り込みに対する応答をマスクするか失敗すると、タスクが終了しなくなる可能性があります。

戻り値:

実行が開始されなかったタスクのリスト

例外:

SecurityException - セキュリティマネージャが存在する状況でシャットダウンを実行すると、この ExecutorService が呼び出し側には変更を許可されないスレッドを操作できる場合。これは、RuntimePermission("modifyThread") を保持しないか、セキュリティマネージャの checkAccess メソッドがアクセスを拒否するためである

isShutdown

boolean isShutdown()

この executorがシャットダウンした場合、true を返します。

戻り値:

この executorがシャットダウンした場合は true

isTerminated

boolean isTerminated()

シャットダウンに続いてすべてのタスクが完了した場合に、true を返します。shutdown または shutdownNow が最初に呼び出されないかぎり、isTerminated は決して true にはなりません。

戻り値:

シャットダウンに続いてすべてのタスクが完了した場合に true

awaitTermination

boolean awaitTermination(long timeout,
                         TimeUnit unit)
                         throws InterruptedException

シャットダウン要求後にすべてのタスクが実行を完了する、タイムアウトが発生する、現在のスレッドで割り込みが発生する、のどれかが最初に起きるまでブロックします。

パラメータ:

timeout - 待機する最長時間

unit - timeout 引数の時間単位

戻り値:

この executor が終了する場合は true、終了前にタイムアウトが経過した場合は false

例外:

InterruptedException - 待機中に割り込みが発生した場合

submit

<T> Future<T> submit(Callable<T> task)

値を返す実行タスクを送信し、保留中のタスク結果を表す Future を返します。

タスクの待機をただちにブロックする場合は、result = exec.submit(aCallable).get(); の形式で指定できます。

注: Executors クラスには、クロージャに似た他の一般オブジェクトを変換可能なメソッドセット (たとえば、PrivilegedAction を送信可能な Callable 形式に変換できる) が含まれます。

パラメータ:

task - 送信するタスク

戻り値:

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

例外:

RejectedExecutionException - タスクの実行をスケジュールできない場合

NullPointerException - タスクが null の場合

submit

<T> Future<T> submit(Runnable task,
                     T result)

実行用の Runnable タスクを送信して、完了時に指定された結果を返すタスクを表す Future を返します。

パラメータ:

task - 送信するタスク

result - 返す結果

戻り値:

タスクの保留完了を表す Future。その get() メソッドは、完了時に指定された結果を返す

例外:

RejectedExecutionException - タスクの実行をスケジュールできない場合

NullPointerException - タスクが null の場合

submit

Future<?> submit(Runnable task)

実行用の Runnable タスクを送信し、そのタスクを表す Future を返します。

パラメータ:

task - 送信するタスク

戻り値:

保留状態のタスク完了を表す Future。その get() メソッドは、完了時に null を返す

例外:

RejectedExecutionException - タスクの実行をスケジュールできない場合

NullPointerException - タスクが null の場合

invokeAll

<T> List<Future<T>> invokeAll(Collection<Callable<T>> tasks)
                          throws InterruptedException

指定されたタスクを実行し、Future のリストをステータスとともに返し、すべてが完了したら結果を返します。返されたリストの各要素に対して Done は true になります。「完了した」タスクは、通常の方法または例外をスローすることで終了しています。この操作の進行中に指定されたコレクションが変更された場合、このメソッドの結果は定義されません。

パラメータ:

tasks - タスクのコレクション

戻り値:

タスクを表す Futures のリスト。リストの順番は、指定されたタスクリストの反復子により生成される順番と同じであり、各タスクは完了済みである

例外:

InterruptedException - 待機中に割り込みが発生した場合。この場合、未完了のタスクは取り消される

NullPointerException - タスクまたはそのいずれかの要素が null の場合

RejectedExecutionException - いずれかのタスクの実行をスケジュールできない場合

invokeAll

<T> List<Future<T>> invokeAll(Collection<Callable<T>> tasks,
                              long timeout,
                              TimeUnit unit)
                          throws InterruptedException

指定されたタスクを実行し、Future のリストをステータスとともに返し、すべてが完了するかまたは時間切れになるかのいずれか早い時点で結果を返します。返されたリストの各要素に対して Done は true になります。返された時点では、完了していないタスクは取り消されます。「完了した」タスクは、通常の方法または例外をスローすることで終了しています。この操作の進行中に指定されたコレクションが変更された場合、このメソッドの結果は定義されません。

パラメータ:

tasks - タスクのコレクション

timeout - 待機する最長時間

unit - timeout 引数の時間単位

戻り値:

タスクを表す Futures のリスト。リストの順番は、指定されたタスクリストの反復子により生成される順番と同じになる。操作がタイムアウトしなかった場合、各タスクは完了する。タイムアウトした場合は、タスクの一部は完了しない

例外:

InterruptedException - 待機中に割り込みが発生した場合。この場合、未完了のタスクは取り消される

NullPointerException - タスク、その要素のいずれか、または単位が null の場合

RejectedExecutionException - いずれかのタスクの実行をスケジュールできない場合

invokeAny

<T> T invokeAny(Collection<Callable<T>> tasks)
            throws InterruptedException,
                   ExecutionException

指定されたタスクを実行し、正常に完了したタスクが存在する場合は、その結果を (例外をスローせずに) 返します。通常または例外を伴う復帰時に、未完了のタスクは取り消されます。この操作が進行中に指定されたコレクションが変更された場合の、このメソッドの結果は定義されていません。

パラメータ:

tasks - タスクのコレクション

戻り値:

いずれかのタスクにより返される結果

例外:

InterruptedException - 待機中に割り込みが発生した場合

NullPointerException - タスクまたはそのいずれかの要素が null の場合

IllegalArgumentException - タスクが空の場合

ExecutionException - 正常に完了したタスクが存在しない場合

RejectedExecutionException - タスクの実行をスケジュールできない場合

invokeAny

<T> T invokeAny(Collection<Callable<T>> tasks,
                long timeout,
                TimeUnit unit)
            throws InterruptedException,
                   ExecutionException,
                   TimeoutException

指定されたタスクを実行し、タイムアウトになる前に正常に完了したタスクが存在する場合は、その結果を (例外をスローせずに) 返します。通常または例外を伴う復帰時に、未完了のタスクは取り消されます。この操作が進行中に指定されたコレクションが変更された場合の、このメソッドの結果は定義されていません。

パラメータ:

tasks - タスクのコレクション

timeout - 待機する最長時間

unit - timeout 引数の時間単位

戻り値:

いずれかのタスクにより返される結果

例外:

InterruptedException - 待機中に割り込みが発生した場合

NullPointerException - タスク、その要素のいずれか、または単位が null の場合

TimeoutException - いずれかのタスクが正常に完了する前に、指定されたタイムアウト時間が経過した場合

ExecutionException - 正常に完了したタスクが存在しない場合

RejectedExecutionException - タスクの実行をスケジュールできない場合