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

Enum Class Projectable

java.lang.Object

java.lang.Enum<Projectable>

org.hibernate.search.engine.backend.types.Projectable

All Implemented Interfaces:

Serializable, Comparable<Projectable>, Constable

public enum Projectable
extends Enum<Projectable>

Whether or not we want to be able to obtain the value of the field as a projection.

This usually means that the field will be stored in the index but it is more subtle than that, for instance in the case of projection by distance.

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	Do not allow projection on the field.
YES	Allow projection on the field.

Method Summary

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

Use the backend-specific default.

• Lucene's default value is YES
• Elasticsearch's default value is NO

NO

public static final Projectable NO

Do not allow projection on the field.

YES

public static final Projectable YES

Allow projection on the field.

Method Details

values

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