Enum Highlightable

java.lang.Object
java.lang.Enum<Highlightable>
org.hibernate.search.engine.backend.types.Highlightable
All Implemented Interfaces:
Serializable, Comparable<Highlightable>

public enum Highlightable extends Enum<Highlightable>
Whether we want to be able to highlight this field.
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Allow any highlighter type be applied for highlighting the field.
    Use the backend-specific default that is dependent on an overall field configuration.
    Allow the fast vector highlighter type be applied for highlighting the field.
    Do not allow highlighting on the field.
    Allow the plain highlighter type be applied for highlighting the field.
    Allow the unified highlighter type be applied for highlighting the field.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the enum constant of this type with the specified name.
    static Highlightable[]
    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 Details

    • DEFAULT

      public static final Highlightable DEFAULT
      Use the backend-specific default that is dependent on an overall field configuration.
    • NO

      public static final Highlightable NO
      Do not allow highlighting on the field.
    • ANY

      public static final Highlightable ANY
      Allow any highlighter type be applied for highlighting the field.
    • PLAIN

      public static final Highlightable PLAIN
      Allow the plain highlighter type be applied for highlighting the field.
    • UNIFIED

      public static final Highlightable UNIFIED
      Allow the unified highlighter type be applied for highlighting the field.
    • FAST_VECTOR

      public static final Highlightable FAST_VECTOR
      Allow the fast vector highlighter type be applied for highlighting the field.
  • Method Details

    • values

      public static Highlightable[] 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 Highlightable 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