Index (Atlassian Confluence 8.8.0 API)

java.lang.Object
- com.atlassian.confluence.search.v2.Index

All Implemented Interfaces:

Serializable
```
public final class Index
extends Object
implements Serializable
```
This class represents an index, which replaces the deprecated SearchIndex A developer can only define a new custom index via custom(String) method. A system index can be accessed via the public constant.

Since:

8.7.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Index.Type

Field Summary

Fields
Modifier and Type Field Description

static Index CHANGE

static Index CONTENT

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Index`	`custom(String name)`
`boolean`	`equals(Object o)`
`static List<Index>`	`from(EnumSet<SearchIndex> indexes)`
`String`	`getName()`
`Index.Type`	`getType()`
`int`	`hashCode()`
`static Index`	`system(String name)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CONTENT
```
public static final Index CONTENT
```

CHANGE
```
public static final Index CHANGE
```

Method Detail

getName
```
public String getName()
```

getType
```
public Index.Type getType()
```

system
```
public static Index system(String name)
```
Parameters:

name - the name of the system index

Returns:

a system Index object

custom
```
public static Index custom(String name)
```
Parameters:

name - the name of the custom index

Returns:

a custom Index object

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

from

public static List<Index> from(EnumSet<SearchIndex> indexes)