Package nl.talsmasoftware.context.delegation

Class DelegatingExecutorService

java.lang.Object

nl.talsmasoftware.context.delegation.Wrapper<ExecutorService>

nl.talsmasoftware.context.delegation.DelegatingExecutorService

All Implemented Interfaces:

Executor, ExecutorService

Direct Known Subclasses:

CallMappingExecutorService

public abstract class DelegatingExecutorService
extends Wrapper<ExecutorService>
implements ExecutorService

Abstract baseclass that makes it a little easier to wrap existing ExecutorService implementations by forwarding all methods to a delegate executor service.
The class also provides overridable wrapper methods for all complex input (e.g. Callable, Runnable) and result types (e.g. Future).

Although this class does implements all required methods of ExecutorService it is still declared as an abstract class.
This is because it does not provide any value in itself.

Author:

Sjoerd Talsma

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DelegatingExecutorService(ExecutorService delegate)	Creates a new executor service that delegates all methods to the specified delegate.

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long timeout, TimeUnit unit)
boolean	equals(Object other)
void	execute(Runnable command)
int	hashCode()
<T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks)
<T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
<T> T	invokeAny(Collection<? extends Callable<T>> tasks)
<T> T	invokeAny(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
List<Runnable>	shutdownNow()
Future<?>	submit(Runnable task)
<T> Future<T>	submit(Runnable task, T result)
<T> Future<T>	submit(Callable<T> task)
String	toString()
protected Runnable	wrap(Runnable source)
protected <T> Callable<T>	wrap(Callable<T> source)
protected <T> Future<T>	wrap(Future<T> source)
protected <T> List<Future<T>>	wrapFutures(Collection<? extends Future<T>> futures)	Default way of mapping a Collection of Future objects: Create a new list and add each individually wrapped object into it.
protected <T> Collection<? extends Callable<T>>	wrapTasks(Collection<? extends Callable<T>> tasks)	Default way of mapping a Collection of Callable objects: Create a new collection and add each individually wrapped object into it.

Methods inherited from class nl.talsmasoftware.context.delegation.Wrapper

delegate, nonNullDelegate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DelegatingExecutorService

protected DelegatingExecutorService(ExecutorService delegate)

Creates a new executor service that delegates all methods to the specified delegate.

Parameters:

delegate - The delegate ExecutorService being wrapped. This may only be null if the delegate() method is overridden to provide an alternative non-null result.

See Also:

Wrapper.delegate()

Method Detail

wrap

protected <T> Callable<T> wrap(Callable<T> source)

wrap

protected Runnable wrap(Runnable source)

wrap

protected <T> Future<T> wrap(Future<T> source)

wrapTasks

protected <T> Collection<? extends Callable<T>> wrapTasks(Collection<? extends Callable<T>> tasks)

Default way of mapping a Collection of Callable objects: Create a new collection and add each individually wrapped object into it.

Type Parameters:

T - The common result type for the collection of tasks.

Parameters:

tasks - The tasks to be mapped.

Returns:

A collection with each individual task wrapped.

See Also:

wrap(Callable)

wrapFutures

protected <T> List<Future<T>> wrapFutures(Collection<? extends Future<T>> futures)

Default way of mapping a Collection of Future objects: Create a new list and add each individually wrapped object into it.

Type Parameters:

T - The common result type for the collection of futures.

Parameters:

futures - The futures to be mapped.

Returns:

A list with each individual future wrapped.

See Also:

wrap(Future)

shutdown

public void shutdown()

Specified by:

shutdown in interface ExecutorService

shutdownNow

public List<Runnable> shutdownNow()

Specified by:

shutdownNow in interface ExecutorService

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface ExecutorService

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface ExecutorService

awaitTermination

public boolean awaitTermination(long timeout,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface ExecutorService

Throws:

InterruptedException

submit

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

Specified by:

submit in interface ExecutorService

submit

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

Specified by:

submit in interface ExecutorService

submit

public Future<?> submit(Runnable task)

Specified by:

submit in interface ExecutorService

invokeAll

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

Specified by:

invokeAll in interface ExecutorService

Throws:

InterruptedException

invokeAll

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

Specified by:

invokeAll in interface ExecutorService

Throws:

InterruptedException

invokeAny

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

Specified by:

invokeAny in interface ExecutorService

Throws:

InterruptedException

ExecutionException

invokeAny

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

Specified by:

invokeAny in interface ExecutorService

Throws:

InterruptedException

ExecutionException

TimeoutException

execute

public void execute(Runnable command)

Specified by:

execute in interface Executor

hashCode

public int hashCode()

Overrides:

hashCode in class Wrapper<ExecutorService>

equals

public boolean equals(Object other)

Overrides:

equals in class Wrapper<ExecutorService>

toString

public String toString()

Overrides:

toString in class Wrapper<ExecutorService>

Returns:

The class name and the delegate string representation.