org.hibernate.search.engine.backend.types

Enum Aggregable

java.lang.Object

java.lang.Enum<Aggregable>

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

All Implemented Interfaces:

Serializable, Comparable<Aggregable>

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.

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static Aggregable	valueOf(String name) Returns the enum constant of this type with the specified name.
static Aggregable[]	values() 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 Detail

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 Detail

values

public static Aggregable[] 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 (Aggregable c : Aggregable.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

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