org.apache.flink.streaming.api.windowing.triggers

Enum Trigger.TriggerResult

java.lang.Object

java.lang.Enum<Trigger.TriggerResult>

org.apache.flink.streaming.api.windowing.triggers.Trigger.TriggerResult

All Implemented Interfaces:

Serializable, Comparable<Trigger.TriggerResult>

Enclosing interface:

Trigger<T,W extends Window>

public static enum Trigger.TriggerResult
extends Enum<Trigger.TriggerResult>

Result type for trigger methods. This determines what happens which the window.

On FIRE the pane is evaluated and results are emitted. The contents of the window are kept. FIRE_AND_PURGE acts like FIRE but the contents of the pane are purged. On CONTINUE nothing happens, processing continues. On PURGE the contents of the window are discarded and now result is emitted for the window.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTINUE
FIRE
FIRE_AND_PURGE
PURGE

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isFire()
boolean	isPurge()
static Trigger.TriggerResult	merge(Trigger.TriggerResult a, Trigger.TriggerResult b) Merges two TriggerResults.
static Trigger.TriggerResult	valueOf(String name) Returns the enum constant of this type with the specified name.
static Trigger.TriggerResult[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONTINUE

public static final Trigger.TriggerResult CONTINUE

FIRE_AND_PURGE

public static final Trigger.TriggerResult FIRE_AND_PURGE

FIRE

public static final Trigger.TriggerResult FIRE

PURGE

public static final Trigger.TriggerResult PURGE

Method Detail

values

public static Trigger.TriggerResult[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Trigger.TriggerResult c : Trigger.TriggerResult.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Trigger.TriggerResult valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isFire

public boolean isFire()

isPurge

public boolean isPurge()

merge

public static Trigger.TriggerResult merge(Trigger.TriggerResult a,
                          Trigger.TriggerResult b)

Merges two TriggerResults. This specifies what should happen if we have two results from a Trigger, for example as a result from Trigger.onElement(Object, long, Window, TriggerContext) and Trigger.onEventTime(long, Window, TriggerContext).

For example, if one result says CONTINUE while the other says FIRE then FIRE is the combined result;