net.openhft.chronicle.testframework

Enum ExecutorServiceUtil

java.lang.Object

java.lang.Enum<ExecutorServiceUtil>

net.openhft.chronicle.testframework.ExecutorServiceUtil

All Implemented Interfaces:

Serializable, Comparable<ExecutorServiceUtil>

public enum ExecutorServiceUtil
extends Enum<ExecutorServiceUtil>

Utility class providing methods to shut down an ExecutorService and wait for its termination, with or without forcibly interrupting running tasks.

This is an enum with no instances, serving solely for namespace control.

Method Summary

Modifier and Type	Method and Description
static void	shutdownAndWaitForTermination(ExecutorService executorService) Shut down an executor service and wait 5 seconds for it to terminate.
static void	shutdownAndWaitForTermination(ExecutorService executorService, long timeout, TimeUnit unit) Shut down an executor service and wait for it to terminate within the given timeout.
static void	shutdownForciblyAndWaitForTermination(ExecutorService executorService) Shut down an executor service, interrupting all threads, and wait 5 seconds for it to terminate.
static void	shutdownForciblyAndWaitForTermination(ExecutorService executorService, long timeout, TimeUnit unit) Shut down an executor service, interrupting all threads, and wait for it to terminate within the given timeout.
static ExecutorServiceUtil	valueOf(String name) Returns the enum constant of this type with the specified name.
static ExecutorServiceUtil[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static ExecutorServiceUtil[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ExecutorServiceUtil c : ExecutorServiceUtil.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ExecutorServiceUtil valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

shutdownAndWaitForTermination

public static void shutdownAndWaitForTermination(ExecutorService executorService,
                                                 long timeout,
                                                 TimeUnit unit)

Shut down an executor service and wait for it to terminate within the given timeout.

Parameters:

executorService - The executor service

timeout - The maximum time to wait

unit - The unit of the timeout argument

Throws:

IllegalStateException - If the executor service didn't terminate within the timeout

shutdownAndWaitForTermination

public static void shutdownAndWaitForTermination(ExecutorService executorService)

Shut down an executor service and wait 5 seconds for it to terminate.

Parameters:

executorService - The executor service

Throws:

IllegalStateException - If it didn't terminate within the default time of 5 seconds

shutdownForciblyAndWaitForTermination

public static void shutdownForciblyAndWaitForTermination(ExecutorService executorService)

Shut down an executor service, interrupting all threads, and wait 5 seconds for it to terminate.

Parameters:

executorService - The executor service

Throws:

IllegalStateException - If it didn't terminate within the default time of 5 seconds

shutdownForciblyAndWaitForTermination

public static void shutdownForciblyAndWaitForTermination(ExecutorService executorService,
                                                         long timeout,
                                                         TimeUnit unit)

Shut down an executor service, interrupting all threads, and wait for it to terminate within the given timeout.

Parameters:

executorService - The executor service

timeout - The maximum time to wait

unit - The unit of the timeout argument

Throws:

IllegalStateException - If it didn't terminate within the specified timeout