Enum Index

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Index>

    public enum Index
    extends java.lang.Enum<Index>
    Used to configure indexing of entries in the cache for index-assisted searching.
    Author:
    Paul Ferraro
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALL
      All cluster nodes will add the entry to the index.
      LOCAL
      Deprecated.
      since 9.1
      NONE
      No indexing is performed.
      PRIMARY_OWNER
      Only the primary owner of an entry will add it to the index.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean isEnabled()
      Is indexing enabled?
      boolean isLocalOnly()
      Deprecated.
      boolean isPrimaryOwner()  
      static Index valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Index[] 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

      • NONE

        public static final Index NONE
        No indexing is performed.
      • LOCAL

        @Deprecated
        public static final Index LOCAL
        Deprecated.
        since 9.1
        The local (originator) node is responsible for adding the entry to the index. This indexing mode is deprecated; use PRIMARY_OWNER instead.
      • ALL

        public static final Index ALL
        All cluster nodes will add the entry to the index.
      • PRIMARY_OWNER

        public static final Index PRIMARY_OWNER
        Only the primary owner of an entry will add it to the index.
    • Method Detail

      • values

        public static Index[] 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 (Index c : Index.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Index valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • isEnabled

        public boolean isEnabled()
        Is indexing enabled?
      • isLocalOnly

        @Deprecated
        public boolean isLocalOnly()
        Deprecated.
      • isPrimaryOwner

        public boolean isPrimaryOwner()