org.openimaj.util.stream

Class BlockingDroppingBufferedStream<T>

java.lang.Object

org.openimaj.util.stream.AbstractStream<T>

org.openimaj.util.stream.BlockingDroppingBufferedStream<T>

Type Parameters:

T - The type of data item in the stream

All Implemented Interfaces:

Iterable<T>, Iterator<T>, Stream<T>

Direct Known Subclasses:

AbstractIRCStreamDataset, AbstractTwitterSearchDataset, AbstractTwitterStatusesFilterDataset, AbstractTwitterStreamDataset

public class BlockingDroppingBufferedStream<T>
extends AbstractStream<T>

Base for a Stream with an internal buffer based on a BlockingDroppingQueue. The use of the BlockingDroppingQueue allows the stream to potentially drop items that are not consumed at a fast enough rate (although this depends on the actual BlockingDroppingQueue).

This class is intended to be used to build Stream implementations that are connected to external, live data-sources that can potentially produce data at a rate which exceeds the rate at which the stream can be processed or consumed.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
BlockingDroppingBufferedStream(BlockingDroppingQueue<T> buffer) Construct with the given backing queue

Method Summary

Modifier and Type	Method and Description
void	close() Close the stream (make hasNext return false)
BlockingDroppingQueue<T>	getBuffer() Get the underlying BlockingDroppingQueue that is used as the internal buffer.
boolean	hasNext()
T	next()
protected void	register(T obj)

Methods inherited from class org.openimaj.util.stream.AbstractStream

filter, forEach, forEach, forEach, iterator, map, map, parallelForEach, parallelForEach, remove, transform

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

BlockingDroppingBufferedStream

public BlockingDroppingBufferedStream(BlockingDroppingQueue<T> buffer)

Construct with the given backing queue

Parameters:

buffer - the backing buffer

Method Detail

register

protected void register(T obj)
                 throws InterruptedException

Throws:

InterruptedException

hasNext

public boolean hasNext()

close

public void close()

Close the stream (make hasNext return false)

next

public T next()

getBuffer

public BlockingDroppingQueue<T> getBuffer()

Get the underlying BlockingDroppingQueue that is used as the internal buffer.

Returns:

the buffer