org.apache.flink.api.java.io

Class IteratorInputFormat<T>

java.lang.Object

org.apache.flink.api.common.io.RichInputFormat<OT,GenericInputSplit>

org.apache.flink.api.common.io.GenericInputFormat<T>

org.apache.flink.api.java.io.IteratorInputFormat<T>

All Implemented Interfaces:

Serializable, InputFormat<T,GenericInputSplit>, NonParallelInput, InputSplitSource<GenericInputSplit>

@PublicEvolving
public class IteratorInputFormat<T>
extends GenericInputFormat<T>
implements NonParallelInput

An input format that returns objects from an iterator.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.flink.api.common.io.GenericInputFormat

partitionNumber

Constructor Summary

Constructors

Constructor and Description
IteratorInputFormat(Iterator<T> iterator)

Method Summary

Modifier and Type	Method and Description
T	nextRecord(T record) Reads the next record from the input.
boolean	reachedEnd() Method used to check if the end of the input is reached.

Methods inherited from class org.apache.flink.api.common.io.GenericInputFormat

close, configure, createInputSplits, getInputSplitAssigner, getStatistics, open

Methods inherited from class org.apache.flink.api.common.io.RichInputFormat

closeInputFormat, getRuntimeContext, openInputFormat, setRuntimeContext

Methods inherited from class java.lang.Object

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

Constructor Detail

IteratorInputFormat

public IteratorInputFormat(Iterator<T> iterator)

Method Detail

reachedEnd

public boolean reachedEnd()

Description copied from interface: InputFormat

Method used to check if the end of the input is reached.

When this method is called, the input format it guaranteed to be opened.

Specified by:

reachedEnd in interface InputFormat<T,GenericInputSplit>

Returns:

True if the end is reached, otherwise false.

nextRecord

public T nextRecord(T record)

Description copied from interface: InputFormat

Reads the next record from the input.

When this method is called, the input format it guaranteed to be opened.

Specified by:

nextRecord in interface InputFormat<T,GenericInputSplit>

Parameters:

record - Object that may be reused.

Returns:

Read record.