org.apache.flink.api.java.io

Class TextOutputFormat<T>

java.lang.Object

org.apache.flink.api.common.io.RichOutputFormat<IT>

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

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

Type Parameters:

T - type of elements

All Implemented Interfaces:

Serializable, CleanupWhenUnsuccessful, InitializeOnMaster, OutputFormat<T>

@PublicEvolving
public class TextOutputFormat<T>
extends FileOutputFormat<T>

A FileOutputFormat that writes objects to a text file.

Objects are converted to Strings using either Object.toString() or a TextOutputFormat.TextFormatter.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TextOutputFormat.TextFormatter<IN> Formatter that transforms values into their String representations.

Nested classes/interfaces inherited from class org.apache.flink.api.common.io.FileOutputFormat

FileOutputFormat.OutputDirectoryMode

Field Summary

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

FILE_PARAMETER_KEY, outputFilePath, stream

Constructor Summary

Constructors

Constructor and Description
TextOutputFormat(Path outputPath)
TextOutputFormat(Path outputPath, String charset)

Method Summary

Modifier and Type	Method and Description
String	getCharsetName()
void	open(int taskNumber, int numTasks) Opens a parallel instance of the output format to store the result of its parallel instance.
void	setCharsetName(String charsetName)
String	toString()
void	writeRecord(T record) Adds a record to the output.

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

close, configure, getDirectoryFileName, getOutputDirectoryMode, getOutputFilePath, getWriteMode, initDefaultsFromConfiguration, initializeGlobal, setOutputDirectoryMode, setOutputFilePath, setWriteMode, tryCleanupOnError

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

getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

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

Constructor Detail

TextOutputFormat

public TextOutputFormat(Path outputPath)

TextOutputFormat

public TextOutputFormat(Path outputPath,
                        String charset)

Method Detail

getCharsetName

public String getCharsetName()

setCharsetName

public void setCharsetName(String charsetName)
                    throws IllegalCharsetNameException,
                           UnsupportedCharsetException

Throws:

IllegalCharsetNameException

UnsupportedCharsetException

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>

Overrides:

open in class FileOutputFormat<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.

Parameters:

record - The records to add to the output.

Throws:

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

toString

public String toString()

Overrides:

toString in class Object