org.apache.flink.streaming.api.operators.async.queue

Class StreamElementQueueEntry<T>

java.lang.Object

org.apache.flink.streaming.api.operators.async.queue.StreamElementQueueEntry<T>

Type Parameters:

T - Type of the result

All Implemented Interfaces:

AsyncResult

Direct Known Subclasses:

StreamRecordQueueEntry, WatermarkQueueEntry

@Internal
public abstract class StreamElementQueueEntry<T>
extends Object
implements AsyncResult

Entry class for the StreamElementQueue. The stream element queue entry stores the StreamElement for which the stream element queue entry has been instantiated. Furthermore, it allows to register callbacks for when the queue entry is completed.

Constructor Summary

Constructors

Constructor and Description
StreamElementQueueEntry(StreamElement streamElement)

Method Summary

Modifier and Type	Method and Description
<T> AsyncCollectionResult<T>	asResultCollection() Return this async result as a async result collection.
AsyncWatermarkResult	asWatermark() Return this async result as a async watermark result.
protected abstract CompletableFuture<T>	getFuture()
StreamElement	getStreamElement()
boolean	isDone() True if the stream element queue entry has been completed; otherwise false.
boolean	isResultCollection() True fi the async result is a collection of output elements; otherwise false.
boolean	isWatermark() True if the async result is a Watermark; otherwise false.
void	onComplete(java.util.function.Consumer<StreamElementQueueEntry<T>> completeFunction, Executor executor) Register the given complete function to be called once this queue entry has been completed.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamElementQueueEntry

public StreamElementQueueEntry(StreamElement streamElement)

Method Detail

getStreamElement

public StreamElement getStreamElement()

isDone

public boolean isDone()

True if the stream element queue entry has been completed; otherwise false.

Returns:

True if the stream element queue entry has been completed; otherwise false.

onComplete

public void onComplete(java.util.function.Consumer<StreamElementQueueEntry<T>> completeFunction,
                       Executor executor)

Register the given complete function to be called once this queue entry has been completed.

Parameters:

completeFunction - to call when the queue entry has been completed

executor - to run the complete function

getFuture

protected abstract CompletableFuture<T> getFuture()

isWatermark

public final boolean isWatermark()

Description copied from interface: AsyncResult

True if the async result is a Watermark; otherwise false.

Specified by:

isWatermark in interface AsyncResult

Returns:

True if the async result is a Watermark; otherwise false.

isResultCollection

public final boolean isResultCollection()

Description copied from interface: AsyncResult

True fi the async result is a collection of output elements; otherwise false.

Specified by:

isResultCollection in interface AsyncResult

Returns:

True if the async result is a collection of output elements; otherwise false

asWatermark

public final AsyncWatermarkResult asWatermark()

Description copied from interface: AsyncResult

Return this async result as a async watermark result.

Specified by:

asWatermark in interface AsyncResult

Returns:

this result as a AsyncWatermarkResult.

asResultCollection

public final <T> AsyncCollectionResult<T> asResultCollection()

Description copied from interface: AsyncResult

Return this async result as a async result collection.

Specified by:

asResultCollection in interface AsyncResult

Type Parameters:

T - Type of the result collection's elements

Returns:

this result as a AsyncCollectionResult.