Package com.atlassian.confluence.search

Enum ReIndexOption

java.lang.Object

java.lang.Enum<ReIndexOption>

com.atlassian.confluence.search.ReIndexOption

All Implemented Interfaces:

Serializable, Comparable<ReIndexOption>

public enum ReIndexOption
extends Enum<ReIndexOption>

NB when adding options, also add to the metric tags in LuceneFullReindexManager

Since:

5.10

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method	Description
static EnumSet<ReIndexOption>	fullReindex()
abstract Predicate<String>	getClassFilter()
abstract SearchQuery	getDeleteQuery()
abstract List<HibernateHandle>	getHandles(SearchableDao dao)
Integer	getThreadCount()
static boolean	isFullReindex(Set<ReIndexOption> options)
static ReIndexOption	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ReIndexOption[]	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_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

Attachment only

USER_ONLY

public static final ReIndexOption USER_ONLY

User only

Method Detail

values

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

Returns:

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

valueOf

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

getDeleteQuery

public abstract SearchQuery getDeleteQuery()

getThreadCount

public Integer getThreadCount()

getClassFilter

public abstract Predicate<String> getClassFilter()

getHandles

public abstract List<HibernateHandle> getHandles(SearchableDao dao)

isFullReindex

public static boolean isFullReindex(Set<ReIndexOption> options)

fullReindex

public static EnumSet<ReIndexOption> fullReindex()