org.protempa

Interface DataStreamingEventIterator<E>

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DataSourceBackendMultiplexingDataStreamingEventIterator, MultiplexingDataStreamingEventIterator

public interface DataStreamingEventIterator<E>
extends AutoCloseable

An iterator-like interface for iterating over DataStreamingEvents. It throws checked exceptions and provides a close() method for cleaning up resources managed by the iterator. These iterators should always be closed after use.

Author:

Andrew Post

Method Summary

Modifier and Type	Method and Description
void	close() Closes any IO or other resources opened by the iterator.
boolean	hasNext() Returns true if the iteration has more DataStreamingEvents.
DataStreamingEvent<E>	next() Returns the next DataStreamingEvent in the iteration.

Method Detail

hasNext

boolean hasNext()
         throws DataSourceReadException

Returns true if the iteration has more DataStreamingEvents. (In other words, returns true if next would return a DataStreamingEvent rather than throwing an exception.)

Returns:

true if the iterator has more DataStreamingEvents.

Throws:

DataSourceReadException - if an error occurred reading data from the underlying data source.

next

DataStreamingEvent<E> next()
                    throws DataSourceReadException

Returns the next DataStreamingEvent in the iteration.

Returns:

the next DataStreamingEvent in the iteration.

Throws:

DataSourceReadException - if an error occurred reading data from the underlying data source.

NoSuchElementException - if the iteration has no more DataStreamingEvents.

close

void close()
    throws DataSourceReadException

Closes any IO or other resources opened by the iterator.

Specified by:

close in interface AutoCloseable

Throws:

DataSourceReadException - if an error occurred reading data from the underlying data source(s).