Package com.atlassian.confluence.search

Enum Class ReIndexOption

java.lang.Object
java.lang.Enum<ReIndexOption>
com.atlassian.confluence.search.ReIndexOption
All Implemented Interfaces:
Serializable, Comparable<ReIndexOption>, Constable
public enum ReIndexOption extends Enum<ReIndexOption>
NB when adding options, also add to the metric tags in LuceneFullReindexManager
Since:
5.10

  • 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
      Attachment only

    • USER_ONLY

      public static final ReIndexOption USER_ONLY
      User 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

    • getDeleteQuery

      public abstract SearchQuery getDeleteQuery()

    • getDeleteQuery

      public abstract SearchQuery getDeleteQuery(Optional<String> spaceKey)

    • getThreadCount

      public Integer getThreadCount()

    • getClassFilter

      public abstract Predicate<String> getClassFilter()

    • getHandles

      public List<HibernateHandle> getHandles(SearchableDao dao)

    • getHandles

      public abstract List<HibernateHandle> getHandles(SearchableDao dao, Optional<String> spaceKey)

    • isFullReindex

      public static boolean isFullReindex(Set<ReIndexOption> options)

    • fullReindex

      public static EnumSet<ReIndexOption> fullReindex()
      This is only for site reindexing

    • fullReindex

      public static EnumSet<ReIndexOption> fullReindex(boolean reindexingSite)
      Parameters:
      reindexingSite - true if Confluence is re-indexing the whole site
      Returns:
      the relevant options
      Since:
      8.2.0

    • deserialise

      public static EnumSet<ReIndexOption> deserialise(Collection<String> options, boolean reindexingSite)
      Parameters:
      options - a collection of options is their serialised form
      Returns:
      an EnumSet of ReIndexOption
      Since:
      8.2.0