com.aol.simple.react.async

Class Queue<T>

java.lang.Object

com.aol.simple.react.async.Queue<T>

Type Parameters:

T - Type of data stored in Queue

All Implemented Interfaces:

Adapter<T>

public class Queue<T>
extends java.lang.Object
implements Adapter<T>

Inspired by scalaz-streams async.Queue (functionally similar, but Blocking) A Queue that takes data from one or more input Streams and provides them to one or more output Streams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Queue.ClosedQueueException Exception thrown if Queue closed
static class	Queue.QueueTimeoutException Exception thrown if Queue polling timesout

Constructor Summary

Constructors

Constructor and Description
Queue() Construct a Queue backed by a LinkedBlockingQueue
Queue(java.util.concurrent.BlockingQueue<T> queue)

Method Summary

Modifier and Type	Method and Description
boolean	add(T data) Add a single data point to the queue If the queue is a bounded queue and is full, will return false
boolean	close() Close this Queue
boolean	fromStream(java.util.stream.Stream<T> stream)
boolean	offer(T data) Offer a single datapoint to this Queue If the queue is a bounded queue and is full it will block until space comes available or until offer time out is reached (default is Integer.MAX_VALUE DAYS).
org.jooq.lambda.Seq<T>	stream()
org.jooq.lambda.Seq<java.util.concurrent.CompletableFuture<T>>	streamCompletableFutures()

Methods inherited from class java.lang.Object

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

Constructor Detail

Queue

public Queue()

Construct a Queue backed by a LinkedBlockingQueue

Queue

public Queue(java.util.concurrent.BlockingQueue<T> queue)

Parameters:

queue - BlockingQueue to back this Queue

Method Detail

stream

public org.jooq.lambda.Seq<T> stream()

Specified by:

stream in interface Adapter<T>

Returns:

Sequential Infinite (until Queue is closed) Stream of data from this Queue use queue.stream().parallel() to convert to a parallel Stream

streamCompletableFutures

public org.jooq.lambda.Seq<java.util.concurrent.CompletableFuture<T>> streamCompletableFutures()

Specified by:

streamCompletableFutures in interface Adapter<T>

Returns:

Infinite (until Queue is closed) Stream of CompletableFutures that can be used as input into a SimpleReact concurrent dataflow This Stream itself is Sequential, SimpleReact will apply concurrency / parralellism via the constituent CompletableFutures

fromStream

public boolean fromStream(java.util.stream.Stream<T> stream)

Specified by:

fromStream in interface Adapter<T>

Parameters:

stream - Input data from provided Stream

add

public boolean add(T data)

Add a single data point to the queue If the queue is a bounded queue and is full, will return false

Parameters:

data - Data to add

Returns:

true if successfully added.

offer

public boolean offer(T data)

Offer a single datapoint to this Queue If the queue is a bounded queue and is full it will block until space comes available or until offer time out is reached (default is Integer.MAX_VALUE DAYS).

Specified by:

offer in interface Adapter<T>

Parameters:

data - data to add

Returns:

self

close

public boolean close()

Close this Queue

Specified by:

close in interface Adapter<T>

Returns:

true if closed