Package com.atlassian.confluence.search.v2.lucene

Enum Class SearchIndex

java.lang.Object
java.lang.Enum<SearchIndex>
com.atlassian.confluence.search.v2.lucene.SearchIndex
All Implemented Interfaces:
Serializable, Comparable<SearchIndex>, Constable
@Deprecated(since="8.7.0", forRemoval=true) public enum SearchIndex extends Enum<SearchIndex>
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.7.0
Represents the index which is going to be searched. This interface is used by many plugins. IMPORTANT: Although this enum can still be used to determine if Confluence should search from or scan through the built-in indices such as "content" or "change", it is not extensible for custom OpenSearch indices. To search from or scan through a custom index on OpenSearch, you can supply the exact index names to the relevant methods.
Since:
7.9.0

  • 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
    CHANGE
    Deprecated, for removal: This API element is subject to removal in a future version.
    Indexed change objects, e.g.
    CONTENT
    Deprecated, for removal: This API element is subject to removal in a future version.
    Represents content entity objects: pages, blogs, comments, etc.
    CUSTOM
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use this index if accessing a custom index

  • Method Summary

    Modifier and Type
    Method
    Description
    static SearchIndex
    fromIndex(Index index)
    Deprecated, for removal: This API element is subject to removal in a future version.
    A convenient method to convert an Index object to this enum value
    static SearchIndex
    valueOf(String name)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the enum constant of this class with the specified name.
    static SearchIndex[]
    values()
    Deprecated, for removal: This API element is subject to removal in a future version.
    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

      public static final SearchIndex CONTENT
      Deprecated, for removal: This API element is subject to removal in a future version.
      Represents content entity objects: pages, blogs, comments, etc.

    • CHANGE

      public static final SearchIndex CHANGE
      Deprecated, for removal: This API element is subject to removal in a future version.
      Indexed change objects, e.g. modification of some page at some time

    • CUSTOM

      public static final SearchIndex CUSTOM
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use this index if accessing a custom index
      Since:
      7.16

  • Method Details

    • values

      public static SearchIndex[] values()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 SearchIndex valueOf(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

    • fromIndex

      public static SearchIndex fromIndex(Index index)
      Deprecated, for removal: This API element is subject to removal in a future version.
      A convenient method to convert an Index object to this enum value
      Parameters:
      index - the index
      Returns: