Package com.atlassian.confluence.search

Enum SearchPlatform

java.lang.Object

java.lang.Enum<SearchPlatform>

com.atlassian.confluence.search.SearchPlatform

All Implemented Interfaces:

Serializable, Comparable<SearchPlatform>

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

Enum Constant Summary

Enum Constants

Enum Constant	Description
LUCENE
OPENSEARCH

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONFIG_KEY
static SearchPlatform	DEFAULT

Method Summary

Modifier and Type	Method	Description
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 type with the specified name.
static SearchPlatform[]	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

OPENSEARCH

public static final SearchPlatform OPENSEARCH

LUCENE

public static final SearchPlatform LUCENE

Field Detail

CONFIG_KEY

public static final String CONFIG_KEY

See Also:

Constant Field Values

DEFAULT

public static final SearchPlatform DEFAULT

Method Detail

values

public static SearchPlatform[] 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 (SearchPlatform c : SearchPlatform.values())
    System.out.println(c);

Returns:

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

valueOf

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

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)