Package org.hibernate.search.backend.lucene.lowlevel.docvalues.impl

Enum MultiValueMode

java.lang.Object

java.lang.Enum<MultiValueMode>

org.hibernate.search.backend.lucene.lowlevel.docvalues.impl.MultiValueMode

All Implemented Interfaces:

Serializable, Comparable<MultiValueMode>

public enum MultiValueMode
extends Enum<MultiValueMode>

Defines what values to pick in the case a document contains multiple values for a particular field.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AVG
MAX
MEDIAN
MIN
SUM

Method Summary

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

SUM

public static final MultiValueMode SUM

AVG

public static final MultiValueMode AVG

MIN

public static final MultiValueMode MIN

MAX

public static final MultiValueMode MAX

MEDIAN

public static final MultiValueMode MEDIAN

Method Detail

values

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

Returns:

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

valueOf

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