com.helger.commons.concurrent

Class ManagedExecutorService

java.lang.Object

com.helger.commons.concurrent.ManagedExecutorService

@NotThreadSafe
public final class ManagedExecutorService
extends Object

Wrapper around an ExecutorService with additional helper methods.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
ManagedExecutorService(ExecutorService aES)

Method Summary

Modifier and Type	Method and Description
EInterrupt	shutdownAndWaitUntilAllTasksAreFinished() Call shutdown on the ExecutorService and wait indefinitely until it terminated.
static EInterrupt	shutdownAndWaitUntilAllTasksAreFinished(ExecutorService aES)
static EInterrupt	shutdownAndWaitUntilAllTasksAreFinished(ExecutorService aES, long nTimeout, TimeUnit eUnit)
EInterrupt	shutdownAndWaitUntilAllTasksAreFinished(long nTimeout, TimeUnit eUnit) Call shutdown on the ExecutorService and wait indefinitely until it terminated.
EInterrupt	waitUntilAllTasksAreFinished() Wait indefinitely on the ExecutorService until it terminates.
EInterrupt	waitUntilAllTasksAreFinished(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

Constructor Detail

ManagedExecutorService

public ManagedExecutorService(@Nonnull
                              ExecutorService aES)

Method Detail

waitUntilAllTasksAreFinished

@Nonnull
public EInterrupt waitUntilAllTasksAreFinished()

Wait indefinitely on the ExecutorService until it terminates.

Returns:

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

waitUntilAllTasksAreFinished

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

Wait indefinitely on the ExecutorService until it terminates.

Parameters:

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 EInterrupt shutdownAndWaitUntilAllTasksAreFinished()

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

Returns:

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

shutdownAndWaitUntilAllTasksAreFinished

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

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

Parameters:

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)

shutdownAndWaitUntilAllTasksAreFinished

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