Package org.apache.calcite.sql

Enum SqlHint.HintOptionFormat

java.lang.Object

java.lang.Enum<SqlHint.HintOptionFormat>

org.apache.calcite.sql.SqlHint.HintOptionFormat

All Implemented Interfaces:

Serializable, Comparable<SqlHint.HintOptionFormat>, Constable, Symbolizable

Enclosing class:

SqlHint

public static enum SqlHint.HintOptionFormat
extends Enum<SqlHint.HintOptionFormat>
implements Symbolizable

Enumeration that represents hint option format.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EMPTY	The hint has no options.
ID_LIST	The hint options are as simple identifier list.
KV_LIST	The hint options are list of key-value pairs.
LITERAL_LIST	The hint options are as literal list.

Method Summary

Modifier and Type	Method	Description
static SqlHint.HintOptionFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SqlHint.HintOptionFormat[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.calcite.sql.Symbolizable

symbol

Enum Constant Details

EMPTY

public static final SqlHint.HintOptionFormat EMPTY

The hint has no options.

LITERAL_LIST

public static final SqlHint.HintOptionFormat LITERAL_LIST

The hint options are as literal list.

ID_LIST

public static final SqlHint.HintOptionFormat ID_LIST

The hint options are as simple identifier list.

KV_LIST

public static final SqlHint.HintOptionFormat KV_LIST

The hint options are list of key-value pairs. For each pair, the key is a simple identifier or string literal, the value is a string literal.

Method Details

values

public static SqlHint.HintOptionFormat[] values()

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

Returns:

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

valueOf

public static SqlHint.HintOptionFormat 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