Package org.apache.flink.test.streaming.runtime.util

Class TestListResultSink<T>

java.lang.Object

org.apache.flink.api.common.functions.AbstractRichFunction

org.apache.flink.streaming.api.functions.sink.legacy.RichSinkFunction<T>

org.apache.flink.test.streaming.runtime.util.TestListResultSink<T>

Type Parameters:

T - element type

All Implemented Interfaces:

Serializable, Function, RichFunction, SinkFunction<T>

public class TestListResultSink<T>
extends RichSinkFunction<T>

Thread-safe sink for collecting elements into an on-heap list.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.streaming.api.functions.sink.legacy.SinkFunction

SinkFunction.Context

Constructor Summary

Constructors

Constructor	Description
TestListResultSink()

Method Summary

Modifier and Type	Method	Description
void	close()	Tear-down method for the user code.
List<T>	getResult()
List<T>	getSortedResult()
void	invoke(T value)
void	open(OpenContext openContext)	Initialization method for the function.

Methods inherited from class org.apache.flink.api.common.functions.AbstractRichFunction

getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

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.streaming.api.functions.sink.legacy.SinkFunction

finish, invoke, writeWatermark

Constructor Detail

TestListResultSink

public TestListResultSink()

Method Detail

open

public void open(OpenContext openContext)
          throws Exception

Description copied from interface: RichFunction

Initialization method for the function. It is called before the actual working methods (like map or join) and thus suitable for one time setup work. For functions that are part of an iteration, this method will be invoked at the beginning of each iteration superstep.

The openContext object passed to the function can be used for configuration and initialization. The openContext contains some necessary information that were configured on the function in the program composition.

 public class MyFilter extends RichFilterFunction<String> {

     private String searchString;

     public void open(OpenContext openContext) {
         // initialize the value of searchString
     }

     public boolean filter(String value) {
         return value.equals(searchString);
     }
 }
 

Specified by:

open in interface RichFunction

Overrides:

open in class AbstractRichFunction

Parameters:

openContext - The context containing information about the context in which the function is opened.

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.

invoke

public void invoke(T value)
            throws Exception

Throws:

Exception

close

public void close()
           throws Exception

Description copied from interface: RichFunction

Tear-down method for the user code. It is called after the last call to the main working methods (e.g. map or join). For functions that are part of an iteration, this method will be invoked after each iteration superstep.

This method can be used for clean up work.

Specified by:

close in interface RichFunction

Overrides:

close in class AbstractRichFunction

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.

getResult

public List<T> getResult()

getSortedResult

public List<T> getSortedResult()