org.apache.flink.streaming.connectors.fs

Class StringWriter<T>

java.lang.Object

org.apache.flink.streaming.connectors.fs.StringWriter<T>

Type Parameters:

T - The type of the elements that are being written by the sink.

All Implemented Interfaces:

Serializable, Writer<T>

public class StringWriter<T>
extends Object
implements Writer<T>

A Writer that uses toString() on the input elements and writes them to the output bucket file separated by newline.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StringWriter() Creates a new StringWriter that uses "UTF-8" charset to convert strings to bytes.
StringWriter(String charsetName) Creates a new StringWriter that uses the given charset to convert strings to bytes.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the Writer.
Writer<T>	duplicate() Duplicates the Writer.
void	flush() Flushes out any internally held data.
void	open(org.apache.hadoop.fs.FSDataOutputStream outStream) Initializes the Writer for a newly opened bucket file.
void	write(T element) Writes one element to the bucket file.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringWriter

public StringWriter()

Creates a new StringWriter that uses "UTF-8" charset to convert strings to bytes.

StringWriter

public StringWriter(String charsetName)

Creates a new StringWriter that uses the given charset to convert strings to bytes.

Parameters:

charsetName - Name of the charset to be used, must be valid input for Charset.forName(charsetName)

Method Detail

open

public void open(org.apache.hadoop.fs.FSDataOutputStream outStream)
          throws IOException

Description copied from interface: Writer

Initializes the Writer for a newly opened bucket file. Any internal per-bucket initialization should be performed here.

Specified by:

open in interface Writer<T>

Parameters:

outStream - The FSDataOutputStream for the newly opened file.

Throws:

IOException

flush

public void flush()
           throws IOException

Description copied from interface: Writer

Flushes out any internally held data.

Specified by:

flush in interface Writer<T>

Throws:

IOException

close

public void close()
           throws IOException

Description copied from interface: Writer

Closes the Writer. This must not close the FSDataOutputStream that was handed in in the Writer.open(org.apache.hadoop.fs.FSDataOutputStream) method. Only internally held state should be closed.

Specified by:

close in interface Writer<T>

Throws:

IOException

write

public void write(T element)
           throws IOException

Description copied from interface: Writer

Writes one element to the bucket file.

Specified by:

write in interface Writer<T>

Throws:

IOException

duplicate

public Writer<T> duplicate()

Description copied from interface: Writer

Duplicates the Writer. This is used to get one Writer for each parallel instance of the sink.

Specified by:

duplicate in interface Writer<T>