Package com.couchbase.client.java.search

Enum HighlightStyle

java.lang.Object

java.lang.Enum<HighlightStyle>

com.couchbase.client.java.search.HighlightStyle

All Implemented Interfaces:

Serializable, Comparable<HighlightStyle>, java.lang.constant.Constable

@Volatile
public enum HighlightStyle
extends Enum<HighlightStyle>

Enumeration of the highlighting styles recognized by the FTS engine.

Since:

2.3.0

Author:

Simon Baslé, Michael Nitschinger

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANSI
HTML
SERVER_DEFAULT

Method Summary

Modifier and Type	Method	Description
static HighlightStyle	valueOf(String name)	Returns the enum constant of this type with the specified name.
static HighlightStyle[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HTML

public static final HighlightStyle HTML

ANSI

public static final HighlightStyle ANSI

SERVER_DEFAULT

public static final HighlightStyle SERVER_DEFAULT

Method Details

values

public static HighlightStyle[] 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 HighlightStyle 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