de.unkrig.commons.util.concurrent

Class ObjectSequentializer<T,EX extends java.lang.Exception>

java.lang.Object

de.unkrig.commons.util.concurrent.ObjectSequentializer<T,EX>

Type Parameters:

T - The type of the objects that pose the "output" of the tasks

EX - The exception type that the tasks may throw

public class ObjectSequentializer<T,EX extends java.lang.Exception>
extends java.lang.Object

Executes multiple tasks asynchronously, but forwards their output to a delegate Consumer (or ConsumerWhichThrows) in the order the tasks were submitted, i.e. the last subject written by one task appears before the output of all subsequently submitted tasks.

Constructor Summary

Constructors

Constructor and Description
ObjectSequentializer(ConsumerWhichThrows<? super T,? extends EX> delegate, java.util.concurrent.ExecutorService squadExecutor)

Method Summary

Modifier and Type	Method and Description
void	awaitCompletion() Returns when all tasks that were previously submitted with submit(ConsumerWhichThrows) have completed.
void	submit(ConsumerWhichThrows<? super ConsumerWhichThrows<? super T,? extends EX>,? extends java.lang.Exception> task) Subjects written to the task's subject will be written to the delegate after all subjects written by the previously submitted tasks, and before the subjects of all tasks submitted afterwards.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectSequentializer

public ObjectSequentializer(ConsumerWhichThrows<? super T,? extends EX> delegate,
                            java.util.concurrent.ExecutorService squadExecutor)

See Also:

ObjectSequentializer

Method Detail

submit

public void submit(ConsumerWhichThrows<? super ConsumerWhichThrows<? super T,? extends EX>,? extends java.lang.Exception> task)

Subjects written to the task's subject will be written to the delegate after all subjects written by the previously submitted tasks, and before the subjects of all tasks submitted afterwards.

Notice that when a task submits another task (the "subtask"), then the output of the subtask will appear after the output of the task (and the output of all other tasks submitted in the meantime). If you want to have the output of subtasks to be in the middle of the task's output, then you should create a second ObjectSequentializer and await its completion.

awaitCompletion

public void awaitCompletion()
                     throws java.lang.InterruptedException,
                            java.util.concurrent.ExecutionException,
                            java.util.concurrent.CancellationException

Returns when all tasks that were previously submitted with submit(ConsumerWhichThrows) have completed.

Throws:

java.util.concurrent.CancellationException - One of the tasks was cancelled

java.util.concurrent.ExecutionException - One of the tasks threw an exception

java.lang.InterruptedException - The current thread was interrupted while waiting