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

Enum Class Aggregable

java.lang.Object

java.lang.Enum<Aggregable>

org.hibernate.search.engine.backend.types.Aggregable

All Implemented Interfaces:

Serializable, Comparable<Aggregable>, Constable

public enum Aggregable
extends Enum<Aggregable>

Whether the field can be used in projections.

This usually means that the field will have doc-values stored in the index.

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 aggregation on the field.
YES	Allow aggregation on the field.

Method Summary

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

Use the backend-specific default.

NO

public static final Aggregable NO

Do not allow aggregation on the field.

YES

public static final Aggregable YES

Allow aggregation on the field.

Method Details

values

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