Package org.hibernate.search.engine.search.highlighter.dsl

Enum HighlighterFragmenter

java.lang.Object

java.lang.Enum<HighlighterFragmenter>

org.hibernate.search.engine.search.highlighter.dsl.HighlighterFragmenter

All Implemented Interfaces:

Serializable, Comparable<HighlighterFragmenter>

public enum HighlighterFragmenter
extends Enum<HighlighterFragmenter>

Defines how to break up text into highlight snippets.

Enum Constant Summary

Enum Constants

Enum Constant	Description
SIMPLE	Breaks up text into same-sized fragments.
SPAN	Breaks up text into same-sized fragments, but tries to avoid breaking up a phrase to be highlighted.

Method Summary

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

SIMPLE

public static final HighlighterFragmenter SIMPLE

Breaks up text into same-sized fragments.

SPAN

public static final HighlighterFragmenter SPAN

Breaks up text into same-sized fragments, but tries to avoid breaking up a phrase to be highlighted.

Method Details

values

public static HighlighterFragmenter[] values()

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

Returns:

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

valueOf

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