ExecutorServiceUtil (yangtools-docs 4.0.3 API)

java.lang.Object
- org.opendaylight.yangtools.util.ExecutorServiceUtil

public final class ExecutorServiceUtil
extends Object

Utility methods for dealing with ExecutorServices.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static <E> @NonNull BlockingQueue<E>`	`offerFailingBlockingQueue(BlockingQueue<E> delegate)`	Creates a `BlockingQueue` which does not allow for non-blocking addition to the queue.
`static void`	`tryGracefulShutdown(@NonNull ExecutorService executor, long timeout, @NonNull TimeUnit unit)`	Tries to shutdown the given executor gracefully by awaiting termination for the given timeout period.
`static @NonNull RejectedExecutionHandler`	`waitInQueueExecutionHandler()`	Returns a `RejectedExecutionHandler` which blocks on the `ThreadPoolExecutor`'s backing queue if a new thread cannot be spawned.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - offerFailingBlockingQueue
```
public static <E> @NonNull BlockingQueue<E> offerFailingBlockingQueue(BlockingQueue<E> delegate)
```
    Creates a BlockingQueue which does not allow for non-blocking addition to the queue. This is useful with waitInQueueExecutionHandler() to turn force a ThreadPoolExecutor to create as many threads as it is configured to before starting to fill the queue.
    
    Parameters:
    
    delegate - Backing blocking queue.
    
    Returns:
    
    A new blocking queue backed by the delegate
  - waitInQueueExecutionHandler
```
public static @NonNull RejectedExecutionHandler waitInQueueExecutionHandler()
```
    Returns a RejectedExecutionHandler which blocks on the ThreadPoolExecutor's backing queue if a new thread cannot be spawned.
    
    Returns:
    
    A shared RejectedExecutionHandler instance.
  - tryGracefulShutdown
```
public static void tryGracefulShutdown(@NonNull ExecutorService executor,
                                       long timeout,
                                       @NonNull TimeUnit unit)
```
    Tries to shutdown the given executor gracefully by awaiting termination for the given timeout period. If the timeout elapses before termination, the executor is forcefully shutdown.