hu.akarnokd.reactive4java.scheduler

Class SingleLaneExecutor<T>

java.lang.Object

hu.akarnokd.reactive4java.scheduler.SingleLaneExecutor<T>

Type Parameters:

T - the element type to process

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class SingleLaneExecutor<T>
extends java.lang.Object
implements java.io.Closeable

A helper class which ensures that each of its queued elements get processed in sequence even on a multi-threaded pool. The class implements Closeable which may be called to cancel any on-going processing and remove any queued tasks.

Constructor Summary

Constructors

Constructor and Description
SingleLaneExecutor(Scheduler pool, Action1<? super T> action) Constructor.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.Iterable<? extends T> items) Add the iterable series of items.
void	add(T item) Add an item to the queue and start the processor if necessary.
void	close()
static <T> SingleLaneExecutor<T>	create(Scheduler scheduler, Action1<? super T> action) Construct a single lane executor via the given parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleLaneExecutor

public SingleLaneExecutor(Scheduler pool,
                          Action1<? super T> action)

Constructor.

Parameters:

pool - the executor service to use as the pool.

action - the action to invoke when processing a queue item

Method Detail

add

public void add(T item)

Add an item to the queue and start the processor if necessary.

Parameters:

item - the item to add.

add

public void add(java.lang.Iterable<? extends T> items)

Add the iterable series of items. The items are added via add() method, and might start the processor if necessary.

Parameters:

items - the iterable of items

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

create

public static <T> SingleLaneExecutor<T> create(Scheduler scheduler,
                                               Action1<? super T> action)

Construct a single lane executor via the given parameters. Convenience method for type inference.

Type Parameters:

T - the value to submit

Parameters:

scheduler - the scheduler

action - the action to invoke with the given value

Returns:

the instance