io.datafx.io

Class InputStreamDataReader<T>

java.lang.Object

io.datafx.io.AbstractDataReader<T>

io.datafx.io.InputStreamDataReader<T>

Type Parameters:

T - the type of data this reader expects

All Implemented Interfaces:

DataReader<T>, java.lang.Iterable<T>

Direct Known Subclasses:

FileSource, RestSource

public abstract class InputStreamDataReader<T>
extends AbstractDataReader<T>

Abstract class for functionality common across DataReader implementations that rely on InputStreams. Common functionality includes the handling of a Converter, translating the InputStream data into Object(s)

Constructor Summary

Constructors

Constructor and Description
InputStreamDataReader() Create an InputStreamDataReader without any configuration options
InputStreamDataReader(InputStreamConverter<T> converter) Create an InputStreamDataReader and assign a Converter to this.
InputStreamDataReader(java.io.InputStream is, InputStreamConverter<T> converter) Create an InputStreamDataReader, set the InputStream and assign a Converter to this.

Method Summary

Modifier and Type	Method and Description
T	get() Obtain the next entity of data.
InputStreamConverter<T>	getConverter() Get the converter that is used by this InputStreamDataReader.
java.io.InputStream	getInputStream() Return the InputStream used by this InputStreamDataReader.
boolean	next() Check if more data is available on this DataReader.
void	setConverter(InputStreamConverter<T> converter) Set the converter that will convert the raw data into object(s) of type T.
void	setInputStream(java.io.InputStream is) Explicitly set the InputStream for this InputStreamDataReader.

Methods inherited from class io.datafx.io.AbstractDataReader

iterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

InputStreamDataReader

public InputStreamDataReader()

Create an InputStreamDataReader without any configuration options

InputStreamDataReader

public InputStreamDataReader(InputStreamConverter<T> converter)

Create an InputStreamDataReader and assign a Converter to this.

Parameters:

converter - the Converter that will be used to convert raw data into object(s) of type T

InputStreamDataReader

public InputStreamDataReader(java.io.InputStream is,
                             InputStreamConverter<T> converter)
                      throws java.io.IOException

Create an InputStreamDataReader, set the InputStream and assign a Converter to this. Once the InputStream is supplied, the setInputStream(java.io.InputStream) method will be called, which will also initialize the InputStream.

Parameters:

is - the InputStream containing the data for this InputStreamReader

converter - the Converter that will be used to convert raw data into object(s) of type T

Throws:

java.io.IOException - in case the initialization of the InputStream fails.

Method Detail

setConverter

public void setConverter(InputStreamConverter<T> converter)

Set the converter that will convert the raw data into object(s) of type T.

Parameters:

converter - the Converter that will be used to convert raw data into object(s) of type T

getConverter

public InputStreamConverter<T> getConverter()

Get the converter that is used by this InputStreamDataReader.

Returns:

the converter that is used by this InputStreamDataReader, either supplied with the constructor or using the setConverter(io.datafx.io.converter.InputStreamConverter) method.

setInputStream

public void setInputStream(java.io.InputStream is)
                    throws java.io.IOException

Explicitly set the InputStream for this InputStreamDataReader. In case the InputStream is supplied with the constructor, this method will be called by the constructor. This method will initialize the InputStream, and assign it to the converter. It is up the the implementation of Converter to decide what to do upon initialization (e.g. checking headers).

Parameters:

is - the InputStream that will be initialized.

Throws:

java.io.IOException - in case initialization of the InputStream fails.

getInputStream

public java.io.InputStream getInputStream()

Return the InputStream used by this InputStreamDataReader.

Returns:

the InputStream, either passed via the constructor or via the setInputStream(java.io.InputStream) method.

get

public T get()

Description copied from interface: DataReader

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

next

public boolean next()

Description copied from interface: DataReader

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.