org.apache.flink.api.java.io

Class BlockingShuffleOutputFormat<T>

java.lang.Object

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

Type Parameters:

T -

All Implemented Interfaces:

Serializable, OutputFormat<T>

@Internal
public final class BlockingShuffleOutputFormat<T>
extends Object
implements OutputFormat<T>

This is the inner OutputFormat used for specify the BLOCKING_PERSISTENT result partition type of coming edge.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.api.common.io.OutputFormat

OutputFormat.InitializationContext

Method Summary

Modifier and Type	Method and Description
void	close() Method that marks the end of the life-cycle of parallel output instance.
void	configure(Configuration parameters) Configures this output format.
static <T> BlockingShuffleOutputFormat<T>	createOutputFormat(AbstractID intermediateDataSetId)
AbstractID	getIntermediateDataSetId()
void	open(int taskNumber, int numTasks) Opens a parallel instance of the output format to store the result of its parallel instance.
void	writeRecord(T record) Adds a record to the output.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.api.common.io.OutputFormat

open

Method Detail

createOutputFormat

public static <T> BlockingShuffleOutputFormat<T> createOutputFormat(AbstractID intermediateDataSetId)

configure

public void configure(Configuration parameters)

Description copied from interface: OutputFormat

Configures this output format. Since output formats are instantiated generically and hence parameterless, this method is the place where the output formats set their basic fields based on configuration values.

This method is always called first on a newly instantiated output format.

Specified by:

configure in interface OutputFormat<T>

Parameters:

parameters - The configuration with all parameters.

open

public void open(int taskNumber,
                 int numTasks)
          throws IOException

Description copied from interface: OutputFormat

Opens a parallel instance of the output format to store the result of its parallel instance.

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

Specified by:

open in interface OutputFormat<T>

Parameters:

taskNumber - The number of the parallel instance.

numTasks - The number of parallel tasks.

Throws:

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

writeRecord

public void writeRecord(T record)
                 throws IOException

Description copied from interface: OutputFormat

Adds a record to the output.

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

Specified by:

writeRecord in interface OutputFormat<T>

Parameters:

record - The records to add to the output.

Throws:

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

close

public void close()
           throws IOException

Description copied from interface: OutputFormat

Method that marks the end of the life-cycle of parallel output instance. Should be used to close channels and streams and release resources. After this method returns without an error, the output is assumed to be correct.

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

Specified by:

close in interface OutputFormat<T>

Throws:

IOException - Thrown, if the input could not be closed properly.

getIntermediateDataSetId

public AbstractID getIntermediateDataSetId()