org.apache.flink.table.api

Enum JsonQueryWrapper

java.lang.Object

java.lang.Enum<JsonQueryWrapper>

org.apache.flink.table.api.JsonQueryWrapper

All Implemented Interfaces:

Serializable, Comparable<JsonQueryWrapper>, TableSymbol

@PublicEvolving
public enum JsonQueryWrapper
extends Enum<JsonQueryWrapper>
implements TableSymbol

Defines whether and when to wrap the result of BuiltInFunctionDefinitions.JSON_QUERY into an array.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONDITIONAL_ARRAY
UNCONDITIONAL_ARRAY
WITHOUT_ARRAY

Method Summary

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

WITHOUT_ARRAY

public static final JsonQueryWrapper WITHOUT_ARRAY

CONDITIONAL_ARRAY

public static final JsonQueryWrapper CONDITIONAL_ARRAY

UNCONDITIONAL_ARRAY

public static final JsonQueryWrapper UNCONDITIONAL_ARRAY

Method Detail

values

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

Returns:

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

valueOf

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