Package org.springframework.data.gemfire

Enum Class IndexType

java.lang.Object
java.lang.Enum<IndexType>
org.springframework.data.gemfire.IndexType
All Implemented Interfaces:
Serializable, Comparable<IndexType>, Constable
public enum IndexType extends Enum<IndexType>
IndexType is an enumerated type of Apache Geode Index Types. NOTE: The Apache Geode IndexType enum has been deprecated, therefore the SDG IndexType exists to replace it.
Since:
1.5.2
Author:
John Blum
See Also:

  • Enum Constant Details

    • FUNCTIONAL

      public static final IndexType FUNCTIONAL

    • HASH

      public static final IndexType HASH

    • PRIMARY_KEY

      public static final IndexType PRIMARY_KEY

    • KEY

      public static final IndexType KEY

  • Field Details

    • DEFAULT

      public static final IndexType DEFAULT

  • Method Details

    • values

      public static IndexType[] 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 IndexType 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

    • isFunctional

      public static boolean isFunctional(@Nullable IndexType indexType)
      Null-safe operation to determine if the given IndexType is a FUNCTIONAL Index.
      Parameters:
      indexType - IndexType to evaluate.
      Returns:
      a boolean value indicating whether the given IndexType is a FUNCTIONAL Index.
      See Also:

    • isHash

      public static boolean isHash(IndexType indexType)
      Null-safe operation to determine if the given IndexType is a HASH Index.
      Parameters:
      indexType - IndexType to evaluate.
      Returns:
      a boolean value indicating whether the given IndexType is a HASH Index.
      See Also:

    • isKey

      public static boolean isKey(IndexType indexType)
      Null-safe operation to determine if the given IndexType is a KEY Index.
      Parameters:
      indexType - IndexType to evaluate.
      Returns:
      a boolean value indicating whether the given IndexType is a KEY Index.
      See Also:

    • valueOf

      public static IndexType valueOf(IndexType gemfireIndexType)
      Returns an IndexType given the corresponding Apache Geode IndexType or null if no SDG IndexType corresponds to the given Apache Geode IndexType.
      Parameters:
      gemfireIndexType - Apache Geode IndexType.
      Returns:
      an IndexType matching the Apache Geode IndexType or null if the Apache Geode IndexType does not match any IndexType in this enumeration.
      See Also:

    • valueOfIgnoreCase

      public static IndexType valueOfIgnoreCase(String value)
      Return an IndexType matching the given String.
      Parameters:
      value - String value describing IndexType to match.
      Returns:
      an IndexType matching the given String.
      See Also:

    • getGemfireIndexType

      @NonNull public IndexType getGemfireIndexType()
      Gets the matching Apache Geode IndexType for this IndexType enumerated value.
      Returns:
      the matching Apache Geode IndexType.
      See Also:

    • isFunctional

      public boolean isFunctional()
      Determines whether this IndexType is a FUNCTIONAL Index.
      Returns:
      a boolean value indicating whether this IndexType is a FUNCTIONAL Index.

    • isHash

      public boolean isHash()
      Determines whether this IndexType is a HASH Index.
      Returns:
      a boolean value indicating whether this IndexType is a HASH Index.

    • isKey

      public boolean isKey()
      Determines whether this IndexType is a KEY Index.
      Returns:
      a boolean value indicating whether this IndexType is a KEY Index.