Package com.atlassian.confluence.search

Enum Class SearchPlatform

java.lang.Object

java.lang.Enum<SearchPlatform>

com.atlassian.confluence.search.SearchPlatform

All Implemented Interfaces:

Serializable, Comparable<SearchPlatform>, Constable

public enum SearchPlatform
extends Enum<SearchPlatform>

Search platform that can be configured on Confluence via the "search.platform" property in the application config file.

Since:

8.6

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
LUCENE
OPENSEARCH

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_KEY
static final SearchPlatform	DEFAULT

Method Summary

Modifier and Type	Method	Description
String	getFriendlyName()
static SearchPlatform	getSearchPlatform(com.atlassian.config.ApplicationConfiguration applicationConfig)	Get the search platform configured on this node.
boolean	isSupportsDocumentId()
static SearchPlatform	parse(String str)
static SearchPlatform	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SearchPlatform[]	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

Enum Constant Details

OPENSEARCH

public static final SearchPlatform OPENSEARCH

LUCENE

public static final SearchPlatform LUCENE

Field Details

CONFIG_KEY

public static final String CONFIG_KEY

See Also:

• Constant Field Values

DEFAULT

public static final SearchPlatform DEFAULT

Method Details

values

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

getFriendlyName

public String getFriendlyName()

Returns:

the human-friendly name for the search platform

Since:

8.9

isSupportsDocumentId

public boolean isSupportsDocumentId()

getSearchPlatform

public static SearchPlatform getSearchPlatform(com.atlassian.config.ApplicationConfiguration applicationConfig)

Get the search platform configured on this node.

Parameters:

applicationConfig -

Returns:

the search platform configured on this node

parse

public static SearchPlatform parse(String str)