Package org.infinispan.configuration.cache

Enum Index

java.lang.Object
java.lang.Enum<Index>
org.infinispan.configuration.cache.Index
All Implemented Interfaces:
Serializable, Comparable<Index>
@Deprecated(forRemoval=true) public enum Index extends Enum<Index>
Deprecated, for removal: This API element is subject to removal in a future version.
since 11.0. The indexing mode is automatically detected and not configurable anymore (ignored) and will be completely removed in next major version.
Used to configure indexing mode of entries in the cache for index-assisted searching.

As of version 11 only modes NONE and ALL are actually internally supported and the indexing mode no longer needs to be specified by the user because the system will determine it automatically.

Author:
Paul Ferraro

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ALL
    Deprecated, for removal: This API element is subject to removal in a future version.
    All cluster nodes will add the entry to the index.
    NONE
    Deprecated, for removal: This API element is subject to removal in a future version.
    No indexing is performed.
    PRIMARY_OWNER
    Deprecated, for removal: This API element is subject to removal in a future version.
    This mode is no longer supported since version 11.0.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isEnabled()
    Deprecated.
    Use IndexingConfiguration.enabled()} instead
    boolean
    isPrimaryOwner()
    Deprecated.
    in 10.1.
    static Index
    valueOf(String name)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the enum constant of this type with the specified name.
    static Index[]
    values()
    Deprecated, for removal: This API element is subject to removal in a future version.
    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 Details

    • NONE

      public static final Index NONE
      Deprecated, for removal: This API element is subject to removal in a future version.
      No indexing is performed.

    • ALL

      public static final Index ALL
      Deprecated, for removal: This API element is subject to removal in a future version.
      All cluster nodes will add the entry to the index.

    • PRIMARY_OWNER

      @Deprecated(forRemoval=true) public static final Index PRIMARY_OWNER
      Deprecated, for removal: This API element is subject to removal in a future version.
      This mode is no longer supported since version 11.0. A configuration error will be raised if encountered.
      Only the primary owner of an entry will add it to the index.

  • Method Details

    • values

      public static Index[] values()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

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

    • isEnabled

      public boolean isEnabled()
      Deprecated.
      Use IndexingConfiguration.enabled()} instead
      Is indexing enabled?

    • isPrimaryOwner

      public boolean isPrimaryOwner()
      Deprecated.
      in 10.1. Equivalent to a simple equality comparison to PRIMARY_OWNER.