Enum SqlHint.HintOptionFormat

java.lang.Object
java.lang.Enum<SqlHint.HintOptionFormat>
org.apache.calcite.sql.SqlHint.HintOptionFormat
All Implemented Interfaces:
Serializable, Comparable<SqlHint.HintOptionFormat>, java.lang.constant.Constable, Symbolizable
Enclosing class:
SqlHint

public static enum SqlHint.HintOptionFormat extends Enum<SqlHint.HintOptionFormat> implements Symbolizable
Enumeration that represents hint option format.
  • 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