Package org.apache.flink.table.types.inference

Enum StaticArgumentTrait

java.lang.Object

java.lang.Enum<StaticArgumentTrait>

org.apache.flink.table.types.inference.StaticArgumentTrait

All Implemented Interfaces:

Serializable, Comparable<StaticArgumentTrait>

@PublicEvolving
public enum StaticArgumentTrait
extends Enum<StaticArgumentTrait>

Declares traits for StaticArgument. They enable basic validation by the framework.

Some traits have dependencies to other traits, which is why this enum reflects a hierarchy in which SCALAR, TABLE, and MODEL are the top-level roots.

Enum Constant Summary

Enum Constants

Enum Constant	Description
MODEL
OPTIONAL_PARTITION_BY
PASS_COLUMNS_THROUGH
SCALAR
TABLE
TABLE_AS_ROW
TABLE_AS_SET

Method Summary

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

SCALAR

public static final StaticArgumentTrait SCALAR

TABLE

public static final StaticArgumentTrait TABLE

MODEL

public static final StaticArgumentTrait MODEL

TABLE_AS_ROW

public static final StaticArgumentTrait TABLE_AS_ROW

TABLE_AS_SET

public static final StaticArgumentTrait TABLE_AS_SET

OPTIONAL_PARTITION_BY

public static final StaticArgumentTrait OPTIONAL_PARTITION_BY

PASS_COLUMNS_THROUGH

public static final StaticArgumentTrait PASS_COLUMNS_THROUGH

Method Detail

values

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

Returns:

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

valueOf

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

getRequirements

public Set<StaticArgumentTrait> getRequirements()