Package org.hibernate.engine.jdbc.spi

Enum TypeSearchability

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<TypeSearchability>
    public enum TypeSearchability
extends java.lang.Enum<TypeSearchability>
    Describes the searchability of a data type as reported by the JDBC driver.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BASIC
      Type is supported only in WHERE ... LIKE
      CHAR
      Type is valid only in WHERE ... LIKE
      FULL
      Type is fully searchable
      NONE
      Type is not searchable.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static TypeSearchability interpret​(short code)
      Based on the code retrieved from DatabaseMetaData.getTypeInfo() for the SEARCHABLE column, return the appropriate enum.
      static TypeSearchability valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TypeSearchability[] 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

      • NONE

        public static final TypeSearchability NONE
        Type is not searchable.
        See Also:
        DatabaseMetaData.typePredNone

      • FULL

        public static final TypeSearchability FULL
        Type is fully searchable
        See Also:
        DatabaseMetaData.typeSearchable

      • CHAR

        public static final TypeSearchability CHAR
        Type is valid only in WHERE ... LIKE
        See Also:
        DatabaseMetaData.typePredChar

      • BASIC

        public static final TypeSearchability BASIC
        Type is supported only in WHERE ... LIKE
        See Also:
        DatabaseMetaData.typePredBasic

    • Method Detail

      • values

        public static TypeSearchability[] 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 (TypeSearchability c : TypeSearchability.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static TypeSearchability valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • interpret

        public static TypeSearchability interpret​(short code)
        Based on the code retrieved from DatabaseMetaData.getTypeInfo() for the SEARCHABLE column, return the appropriate enum.
        Parameters:
        code - The retrieved code value.
        Returns:
        The corresponding enum.