SearchIndex (Atlassian Confluence 8.0.0 API)

java.lang.Object
- java.lang.Enum<SearchIndex>
- - com.atlassian.confluence.search.v2.lucene.SearchIndex

All Implemented Interfaces:

Serializable, Comparable<SearchIndex>
```
public enum SearchIndex
extends Enum<SearchIndex>
```
Represents the index which is going to be searched. This interface is used by many plugins.

Since:

7.9.0

Enum Constant Summary

Enum Constants
Enum Constant	Description
`CHANGE`	Indexed change objects, e.g.
`CONTENT`	Represents content entity objects: pages, blogs, comments, etc.
`CUSTOM`	Use this index if accessing a custom index

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static SearchIndex`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static SearchIndex[]`	`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 SearchIndex CONTENT
```
    Represents content entity objects: pages, blogs, comments, etc.
  - CHANGE
```
public static final SearchIndex CHANGE
```
    Indexed change objects, e.g. modification of some page at some time
  - CUSTOM
```
public static final SearchIndex CUSTOM
```
    Use this index if accessing a custom index
    
    Since:
    
    7.16
- Method Detail
  - values
```
public static SearchIndex[] 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 (SearchIndex c : SearchIndex.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SearchIndex 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