com.arakelian.elastic.model.search

Enum Highlighter.Order

java.lang.Object

java.lang.Enum<Highlighter.Order>

com.arakelian.elastic.model.search.Highlighter.Order

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Highlighter.Order>

Enclosing interface:

Highlighter

public static enum Highlighter.Order
extends java.lang.Enum<Highlighter.Order>

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE
SCORE Sorts highlighted fragments by score.

Method Summary

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

NONE

public static final Highlighter.Order NONE

SCORE

public static final Highlighter.Order SCORE

Sorts highlighted fragments by score. Only valid for the unified highlighter.

Method Detail

values

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

Returns:

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

valueOf

public static Highlighter.Order valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null