io.datafx.io

Interface DataReader<T>

Type Parameters:

T - the type of Java Objects that should be returned by this DataReader

All Superinterfaces:

java.lang.Iterable<T>

All Known Subinterfaces:

ServerSentEventReader<T>, WritableDataReader<T>

All Known Implementing Classes:

AbstractDataReader, InputStreamDataReader, RestSource

public interface DataReader<T>
extends java.lang.Iterable<T>

This is the root interface for all data readers. A DataReader is responsible for retrieving external data, and convert the raw external data into a Java Objects.
Implementations should provide data, and should be able to inform dataproviders when the last piece of data has arrived.

Method Summary

Modifier and Type	Method and Description
T	get() Obtain the next entity of data.
boolean	next() Check if more data is available on this DataReader.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

get

T get()
throws java.io.IOException

Obtain the next entity of data. In case the data is a single entity, this method returns all data. In case the data is a list, this method returns the next entity and moves a pointer to the subsequent entity, if any

Returns:

the next available data entity or null if no new data can be retrieved

Throws:

java.io.IOException - in case an exception occurs while reading data

next

boolean next()

Check if more data is available on this DataReader. This method will only return false if no data is available. It should not return false in case data will be available at a later time. Calling this method on a DataReader that does not support lists always returns false

Returns:

true in case more data is available and obtainable via a get() call, false otherwise.