com.atlassian.confluence.search.v2

Enum SearchResultType

java.lang.Object

java.lang.Enum<SearchResultType>

com.atlassian.confluence.search.v2.SearchResultType

All Implemented Interfaces:

Serializable, Comparable<SearchResultType>

public enum SearchResultType
extends Enum<SearchResultType>

Represents a confluence search result type.

Introducing types allows us to distinguish between different results in the index and allow us to target certain results for specific operations. For example, when a user has updated a page, we can remove the associated CONTENT result from the index and add a new one (without affecting results of a different type).

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHANGE A result that represents an edit/change
CONTENT A result that contains the content/body of a confluence entity (allowing searching against the full text of its body for example)

Method Summary

Methods

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

CONTENT

public static final SearchResultType CONTENT

A result that contains the content/body of a confluence entity (allowing searching against the full text of its body for example)

CHANGE

public static final SearchResultType CHANGE

A result that represents an edit/change

Method Detail

values

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

Returns:

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

valueOf

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