com.helger.commons.concurrent

Class ExecutorServiceHelper

java.lang.Object

com.helger.commons.concurrent.ExecutorServiceHelper

@Immutable
public final class ExecutorServiceHelper
extends Object

Wrapper around an ExecutorService with additional helper methods.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
static EInterrupt	shutdownAndWaitUntilAllTasksAreFinished(ExecutorService aES) Call shutdown on the ExecutorService and wait indefinitely until it terminated.
static EInterrupt	shutdownAndWaitUntilAllTasksAreFinished(ExecutorService aES, long nTimeout, TimeUnit eUnit) Call shutdown on the ExecutorService and wait indefinitely until it terminated.
static EInterrupt	waitUntilAllTasksAreFinished(ExecutorService aES) Wait indefinitely on the ExecutorService until it terminates.
static EInterrupt	waitUntilAllTasksAreFinished(ExecutorService aES, long nTimeout, TimeUnit eUnit) Wait indefinitely on the ExecutorService until it terminates.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

waitUntilAllTasksAreFinished

@Nonnull
public static EInterrupt waitUntilAllTasksAreFinished(@Nonnull
                                                                ExecutorService aES)

Wait indefinitely on the ExecutorService until it terminates.

Parameters:

aES - The ExecutorService to operate on. May not be null.

Returns:

EInterrupt.INTERRUPTED if the executor service was interrupted while awaiting termination. Never null.

waitUntilAllTasksAreFinished

@Nonnull
public static EInterrupt waitUntilAllTasksAreFinished(@Nonnull
                                                                ExecutorService aES,
                                                                @Nonnegative
                                                                long nTimeout,
                                                                @Nonnull
                                                                TimeUnit eUnit)

Wait indefinitely on the ExecutorService until it terminates.

Parameters:

aES - The ExecutorService to operate on. May not be null.

nTimeout - the maximum time to wait. Must be > 0.

eUnit - the time unit of the timeout argument. Must not be null .

Returns:

EInterrupt.INTERRUPTED if the executor service was interrupted while awaiting termination. Never null.

shutdownAndWaitUntilAllTasksAreFinished

@Nonnull
public static EInterrupt shutdownAndWaitUntilAllTasksAreFinished(@Nonnull
                                                                           ExecutorService aES)

Call shutdown on the ExecutorService and wait indefinitely until it terminated.

Parameters:

aES - The ExecutorService to operate on. May not be null.

Returns:

EInterrupt.INTERRUPTED if the executor service was interrupted while awaiting termination. Never null.

shutdownAndWaitUntilAllTasksAreFinished

@Nonnull
public static EInterrupt shutdownAndWaitUntilAllTasksAreFinished(@Nonnull
                                                                           ExecutorService aES,
                                                                           @Nonnegative
                                                                           long nTimeout,
                                                                           @Nonnull
                                                                           TimeUnit eUnit)

Call shutdown on the ExecutorService and wait indefinitely until it terminated.

Parameters:

aES - The ExecutorService to operate on. May not be null.

nTimeout - the maximum time to wait. Must be > 0.

eUnit - the time unit of the timeout argument. Must not be null .

Returns:

EInterrupt.INTERRUPTED if the executor service was interrupted while awaiting termination. Never null.