org.apache.flink.table.annotation

Enum InputGroup

java.lang.Object

java.lang.Enum<InputGroup>

org.apache.flink.table.annotation.InputGroup

All Implemented Interfaces:

Serializable, Comparable<InputGroup>

@PublicEvolving
public enum InputGroup
extends Enum<InputGroup>

A list of commonly used pre-defined groups of similar types for accepting more than just one data type as an input argument in DataTypeHints.

This list exposes a combination of LogicalTypeFamily and InputTypeStrategies via annotations for convenient inline usage.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY Enables input wildcards.
UNKNOWN Default if no group is specified.

Method Summary

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

UNKNOWN

public static final InputGroup UNKNOWN

Default if no group is specified.

ANY

public static final InputGroup ANY

Enables input wildcards. Any data type can be passed. The behavior is equal to InputTypeStrategies.ANY.

Note: The class of the annotated element must be Object as this is the super class of all possibly passed data types.

Method Detail

values

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

Returns:

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

valueOf

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