Package org.hibernate.search.engine.search.highlighter.spi

Enum SearchHighlighterType

java.lang.Object

java.lang.Enum<SearchHighlighterType>

org.hibernate.search.engine.search.highlighter.spi.SearchHighlighterType

All Implemented Interfaces:

Serializable, Comparable<SearchHighlighterType>

public enum SearchHighlighterType
extends Enum<SearchHighlighterType>

Types of supported highlighters.

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAST_VECTOR
PLAIN
UNIFIED

Method Summary

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

UNIFIED

public static final SearchHighlighterType UNIFIED

PLAIN

public static final SearchHighlighterType PLAIN

FAST_VECTOR

public static final SearchHighlighterType FAST_VECTOR

Method Detail

values

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

Returns:

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

valueOf

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