Class ArrayBlockingStream<T>

java.lang.Object

fr.lirmm.graphik.util.stream.AbstractCloseableIterator<T>

fr.lirmm.graphik.util.stream.ArrayBlockingStream<T>

Type Parameters:

T - type of elements stored in the stream

All Implemented Interfaces:

CloseableIterator<T>, CloseableIteratorWithoutException<T>, InMemoryStream<T>, Stream<T>, Writer<T>, Closeable, AutoCloseable, Iterator<T>

public class ArrayBlockingStream<T>
extends AbstractCloseableIterator<T>
implements InMemoryStream<T>

Concurrent in-memory stream backed by a circular array.

Author:

Clément Sipieter (INRIA) clement@6pi.fr

Constructor Summary

Constructors

Constructor	Description
ArrayBlockingStream(int bufferSize)	Creates a blocking stream with the provided buffer size.

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	hasNext()	Returns whether another element is available.
T	next()	Returns the next element.
void	write(Iterator<T> it)	Writes all objects provided by the iterator.
void	write(T object)	Writes a single object.

Methods inherited from class AbstractCloseableIterator

finalize

Methods inherited from class Object

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

Methods inherited from interface Iterator

forEachRemaining, remove

Constructor Details

ArrayBlockingStream

public ArrayBlockingStream(int bufferSize)

Creates a blocking stream with the provided buffer size.

Parameters:

bufferSize - the ring-buffer capacity

Method Details

write

public void write(T object)

Description copied from interface: Writer

Writes a single object.

Specified by:

write in interface InMemoryStream<T>

Specified by:

write in interface Writer<T>

Parameters:

object - the object to write

hasNext

public boolean hasNext()

Description copied from interface: CloseableIterator

Returns whether another element is available.

Specified by:

hasNext in interface CloseableIterator<T>

Specified by:

hasNext in interface CloseableIteratorWithoutException<T>

Specified by:

hasNext in interface Iterator<T>

Returns:

true if another element can be read

next

public T next()

Description copied from interface: CloseableIterator

Returns the next element.

Specified by:

next in interface CloseableIterator<T>

Specified by:

next in interface CloseableIteratorWithoutException<T>

Specified by:

next in interface Iterator<T>

Returns:

the next element

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface CloseableIterator<T>

write

public void write(Iterator<T> it)

Description copied from interface: Writer

Writes all objects provided by the iterator.

Specified by:

write in interface InMemoryStream<T>

Specified by:

write in interface Writer<T>

Parameters:

it - the objects to write