org.apache.flink.runtime.operators

Enum DamBehavior

java.lang.Object

java.lang.Enum<DamBehavior>

org.apache.flink.runtime.operators.DamBehavior

All Implemented Interfaces:

Serializable, Comparable<DamBehavior>

public enum DamBehavior
extends Enum<DamBehavior>

Enumeration for the different dam behaviors of an algorithm or a driver strategy. The dam behavior describes whether records pass through the algorithm (no dam), whether all records are collected before the first is returned (full dam) or whether a certain large amount is collected before the algorithm returns records.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FULL_DAM Constant indicating that the algorithm collects all records before returning any.
MATERIALIZING Constant indicating that the algorithm materialized (some) records, but may return records before all records are read.
PIPELINED Constant indicating that the algorithm does not come with any form of dam and records pass through in a pipelined fashion.

Method Summary

Modifier and Type	Method and Description
boolean	isMaterializing() Checks whether this enumeration represents some form of materialization, either with a full dam or without.
static DamBehavior	valueOf(String name) Returns the enum constant of this type with the specified name.
static DamBehavior[]	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

PIPELINED

public static final DamBehavior PIPELINED

Constant indicating that the algorithm does not come with any form of dam and records pass through in a pipelined fashion.

MATERIALIZING

public static final DamBehavior MATERIALIZING

Constant indicating that the algorithm materialized (some) records, but may return records before all records are read.

FULL_DAM

public static final DamBehavior FULL_DAM

Constant indicating that the algorithm collects all records before returning any.

Method Detail

values

public static DamBehavior[] 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 (DamBehavior c : DamBehavior.values())
    System.out.println(c);

Returns:

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

valueOf

public static DamBehavior 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

isMaterializing

public boolean isMaterializing()

Checks whether this enumeration represents some form of materialization, either with a full dam or without.

Returns:

True, if this enumeration constant represents a materializing behavior, false otherwise.