Enum Searchable
- java.lang.Object
-
- java.lang.Enum<Searchable>
-
- org.hibernate.search.engine.backend.types.Searchable
-
- All Implemented Interfaces:
Serializable
,Comparable<Searchable>
public enum Searchable extends Enum<Searchable>
Whether or not we want to be able to search the document using this field.
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Searchable
valueOf(String name)
Returns the enum constant of this type with the specified name.static Searchable[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
DEFAULT
public static final Searchable DEFAULT
Use the backend-specific default.
-
NO
public static final Searchable NO
The field is not searchable, i.e. search predicates cannot be applied to the field.This can save some disk space if you know the field is only used for projections or sorts.
-
YES
public static final Searchable YES
The field is searchable, i.e. search predicates can be applied to the field.
-
-
Method Detail
-
values
public static Searchable[] 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 (Searchable c : Searchable.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Searchable 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 nameNullPointerException
- if the argument is null
-
-