com.arakelian.elastic.model.search

Enum Highlighter.BoundaryScanner

java.lang.Object

java.lang.Enum<Highlighter.BoundaryScanner>

com.arakelian.elastic.model.search.Highlighter.BoundaryScanner

All Implemented Interfaces:

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

Enclosing interface:

Highlighter

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHARS Use the characters specified by boundary_chars as highlighting boundaries.
SENTENCE Break highlighted fragments at the next sentence boundary, as determined by Java’s BreakIterator.
WORD Break highlighted fragments at the next word boundary, as determined by Java’s BreakIterator.

Method Summary

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

CHARS

public static final Highlighter.BoundaryScanner CHARS

Use the characters specified by boundary_chars as highlighting boundaries. The boundary_max_scan setting controls how far to scan for boundary characters. Only valid for the fvh highlighter.

WORD

public static final Highlighter.BoundaryScanner WORD

Break highlighted fragments at the next word boundary, as determined by Java’s BreakIterator. You can specify the locale to use with boundary_scanner_locale.

SENTENCE

public static final Highlighter.BoundaryScanner SENTENCE

Break highlighted fragments at the next sentence boundary, as determined by Java’s BreakIterator. You can specify the locale to use with boundary_scanner_locale.

Method Detail

values

public static Highlighter.BoundaryScanner[] 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.BoundaryScanner c : Highlighter.BoundaryScanner.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.BoundaryScanner 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