Package com.atlassian.confluence.search.v2

Enum SearchManager.EntityVersionPolicy

java.lang.Object

java.lang.Enum<SearchManager.EntityVersionPolicy>

com.atlassian.confluence.search.v2.SearchManager.EntityVersionPolicy

All Implemented Interfaces:

Serializable, Comparable<SearchManager.EntityVersionPolicy>

Enclosing interface:

SearchManager

public static enum SearchManager.EntityVersionPolicy
extends Enum<SearchManager.EntityVersionPolicy>

Determines how search results will be converted into entities by SearchManager.convertToEntities(SearchResults, EntityVersionPolicy) and SearchManager.searchEntities(ISearch, EntityVersionPolicy). The recommended default is INDEXED_VERSION.

Since:

4.0

See Also:

SearchManager.convertToEntities(SearchResults, EntityVersionPolicy), SearchManager.searchEntities(ISearch, EntityVersionPolicy)

Enum Constant Summary

Enum Constants

Enum Constant	Description
INDEXED_VERSION	retrieves the specific version of search results found in the index (recommended)
LATEST_VERSION	retrieves the latest version of search results found in the index (legacy behaviour)

Method Summary

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

INDEXED_VERSION

public static final SearchManager.EntityVersionPolicy INDEXED_VERSION

retrieves the specific version of search results found in the index (recommended)

LATEST_VERSION

public static final SearchManager.EntityVersionPolicy LATEST_VERSION

retrieves the latest version of search results found in the index (legacy behaviour)

Method Detail

values

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

Returns:

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

valueOf

public static SearchManager.EntityVersionPolicy 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