Package se.kuseman.payloadbuilder.api.catalog

Enum Class Index.ColumnsType

java.lang.Object
java.lang.Enum<Index.ColumnsType>
se.kuseman.payloadbuilder.api.catalog.Index.ColumnsType
All Implemented Interfaces:
Serializable, Comparable<Index.ColumnsType>, Constable
Enclosing class:
Index
public static enum Index.ColumnsType extends Enum<Index.ColumnsType>
Type of columns this index supports.

  • 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
    ALL
    Type that specifies that ALL columns must be used to be able to utilize this index
    ANY
    Type that specifies that at least one column (ANY) must be used to be able to utilize this index
    ANY_IN_ORDER
    Type that specifies that at least one column (ANY) must be used to be able to utilize this index but columns must be used in order from left to right.
    WILDCARD
    A special type of index used by catalogs that can use all found columns for a table.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Index.ColumnsType
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static Index.ColumnsType[]
    values()
    Returns an array containing the constants of this enum class, 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

  • Enum Constant Details

    • WILDCARD

      public static final Index.ColumnsType WILDCARD
      A special type of index used by catalogs that can use all found columns for a table. Shortcut type to skip listing all the columns that the table has. Used for example in JDBC-catalog.

    • ALL

      public static final Index.ColumnsType ALL
      Type that specifies that ALL columns must be used to be able to utilize this index

    • ANY

      public static final Index.ColumnsType ANY
      Type that specifies that at least one column (ANY) must be used to be able to utilize this index

    • ANY_IN_ORDER

      public static final Index.ColumnsType ANY_IN_ORDER
      Type that specifies that at least one column (ANY) must be used to be able to utilize this index but columns must be used in order from left to right.

  • Method Details

    • values

      public static Index.ColumnsType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Index.ColumnsType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null