Package org.hibernate.search.engine.backend.types

Enum Class Searchable

java.lang.Object

java.lang.Enum<Searchable>

org.hibernate.search.engine.backend.types.Searchable

All Implemented Interfaces:

Serializable, Comparable<Searchable>, Constable

public enum Searchable
extends Enum<Searchable>

Whether or not we want to be able to search the document using this field.

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
DEFAULT	Use the backend-specific default.
NO	The field is not searchable, i.e. search predicates cannot be applied to the field.
YES	The field is searchable, i.e. search predicates can be applied to the field.

Method Summary

Modifier and Type	Method	Description
static Searchable	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Searchable[]	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

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 Details

values

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