Package com.atlassian.confluence.api.service.index

Enum Class ReIndexOption

java.lang.Object

java.lang.Enum<ReIndexOption>

com.atlassian.confluence.api.service.index.ReIndexOption

All Implemented Interfaces:

Serializable, Comparable<ReIndexOption>, Constable

public enum ReIndexOption
extends Enum<ReIndexOption>

Enum representing the options available for reindexing in Confluence. These options determine what content will be reindexed.

Since:

10.1

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ATTACHMENT_ONLY	Attachments only
CONTENT_ONLY	All content except those others specifically listed below - e.g.
USER_ONLY	Users only

Method Summary

Modifier and Type	Method	Description
static ReIndexOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ReIndexOption[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CONTENT_ONLY

public static final ReIndexOption CONTENT_ONLY

All content except those others specifically listed below - e.g. attachments or users

ATTACHMENT_ONLY

public static final ReIndexOption ATTACHMENT_ONLY

Attachments only

USER_ONLY

public static final ReIndexOption USER_ONLY

Users only

Method Details

values

public static ReIndexOption[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ReIndexOption valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null