org.apache.flink.table.functions

Enum FunctionRequirement

java.lang.Object

java.lang.Enum<FunctionRequirement>

org.apache.flink.table.functions.FunctionRequirement

All Implemented Interfaces:

Serializable, Comparable<FunctionRequirement>

@PublicEvolving
public enum FunctionRequirement
extends Enum<FunctionRequirement>

Characteristics that a FunctionDefinition requires.

Enum Constant Summary

Enum Constants

Enum Constant and Description
OVER_WINDOW_ONLY Requirement that an aggregate function can only be applied in an OVER window.

Method Summary

Modifier and Type	Method and Description
static FunctionRequirement	valueOf(String name) Returns the enum constant of this type with the specified name.
static FunctionRequirement[]	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

OVER_WINDOW_ONLY

public static final FunctionRequirement OVER_WINDOW_ONLY

Requirement that an aggregate function can only be applied in an OVER window.

Method Detail

values

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

Returns:

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

valueOf

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