org.apache.flink.api.java.io

Class CollectionInputFormat<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.CollectionInputFormat<T>

All Implemented Interfaces:

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

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

An input format that returns objects from a collection.

See Also:

Serialized Form

Field Summary

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

partitionNumber

Constructor Summary

Constructors

Constructor and Description
CollectionInputFormat(Collection<T> dataSet, TypeSerializer<T> serializer)

Method Summary

Modifier and Type	Method and Description
static <X> void	checkCollection(Collection<X> elements, Class<X> viewedAs)
T	nextRecord(T record) Reads the next record from the input.
void	open(GenericInputSplit split) Opens a parallel instance of the input format to work on a split.
boolean	reachedEnd() Method used to check if the end of the input is reached.
String	toString()

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

close, configure, createInputSplits, getInputSplitAssigner, getStatistics

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, wait, wait, wait

Constructor Detail

CollectionInputFormat

public CollectionInputFormat(Collection<T> dataSet,
                             TypeSerializer<T> serializer)

Method Detail

reachedEnd

public boolean reachedEnd()
                   throws IOException

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.

Throws:

IOException - Thrown, if an I/O error occurred.

open

public void open(GenericInputSplit split)
          throws IOException

Description copied from interface: InputFormat

Opens a parallel instance of the input format to work on a split.

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

Specified by:

open in interface InputFormat<T,GenericInputSplit>

Overrides:

open in class GenericInputFormat<T>

Parameters:

split - The split to be opened.

Throws:

IOException - Thrown, if the spit could not be opened due to an I/O problem.

nextRecord

public T nextRecord(T record)
             throws IOException

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.

Throws:

IOException - Thrown, if an I/O error occurred.

toString

public String toString()

Overrides:

toString in class Object

checkCollection

public static <X> void checkCollection(Collection<X> elements,
                                       Class<X> viewedAs)