Package com.intercom.api.core

Class Stream<T>

java.lang.Object

com.intercom.api.core.Stream<T>

Type Parameters:

T - The type of objects in the stream.

All Implemented Interfaces:

Iterable<T>

public final class Stream<T>
extends Object
implements Iterable<T>

The Stream class implements Iterable to provide a simple mechanism for reading and parsing objects of a given type from data streamed via a Reader using a specified delimiter.

Stream assumes that data is being pushed to the provided Reader asynchronously and utilizes a Scanner to block during iteration if the next object is not available.

Constructor Summary

Constructors

Constructor	Description
Stream(Class<T> valueType, Reader reader, String delimiter)	Constructs a new Stream with the specified value type, reader, and delimiter.

Method Summary

Modifier and Type	Method	Description
Iterator<T>	iterator()	Returns an iterator over the elements in this stream that blocks during iteration when the next object is not yet available.

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 Details

Stream

public Stream(Class<T> valueType,
 Reader reader,
 String delimiter)

Constructs a new Stream with the specified value type, reader, and delimiter.

Parameters:

valueType - The class of the objects in the stream.

reader - The reader that provides the streamed data.

delimiter - The delimiter used to separate elements in the stream.

Method Details

iterator

public Iterator<T> iterator()

Returns an iterator over the elements in this stream that blocks during iteration when the next object is not yet available.

Specified by:

iterator in interface Iterable<T>

Returns:

An iterator that can be used to traverse the elements in the stream.