Package co.elastic.clients.elasticsearch.core.search

Enum Class BoundaryScanner

java.lang.Object

java.lang.Enum<BoundaryScanner>

co.elastic.clients.elasticsearch.core.search.BoundaryScanner

All Implemented Interfaces:

JsonEnum, JsonpSerializable, Serializable, Comparable<BoundaryScanner>, Constable

@JsonpDeserializable
public enum BoundaryScanner
extends Enum<BoundaryScanner>
implements JsonEnum

See Also:

• API specification

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface co.elastic.clients.json.JsonEnum

JsonEnum.Deserializer<T extends JsonEnum>

Enum Constant Summary

Enum Constants

Enum Constant	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.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonEnum.Deserializer<BoundaryScanner>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
String	jsonValue()
static BoundaryScanner	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BoundaryScanner[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.JsonEnum

aliases, serialize

Enum Constant Details

Chars

public static final 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.

Sentence

public static final 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. When used with the unified highlighter, the sentence scanner splits sentences bigger than fragment_size at the first word boundary next to fragment_size. You can set fragment_size to 0 to never split any sentence.

Word

public static final 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.

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<BoundaryScanner> _DESERIALIZER

Method Details

values

public static BoundaryScanner[] values()

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

Returns:

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

valueOf

public static BoundaryScanner valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

jsonValue

public String jsonValue()

Specified by:

jsonValue in interface JsonEnum