Package org.springframework.data.gemfire
Enum Class IndexType
- All Implemented Interfaces:
Serializable
,Comparable<IndexType>
,Constable
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
- See Also:
-
IndexType
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionorg.apache.geode.cache.query.IndexType
Gets the matching Apache GeodeIndexType
for thisIndexType
enumerated value.boolean
Determines whether thisIndexType
is a FUNCTIONAL Index.static boolean
isFunctional
(IndexType indexType) Null-safe operation to determine if the givenIndexType
is a FUNCTIONAL Index.boolean
isHash()
Determines whether thisIndexType
is a HASH Index.static boolean
Null-safe operation to determine if the givenIndexType
is a HASH Index.boolean
isKey()
Determines whether this IndexType is a KEY Index.static boolean
Null-safe operation to determine if the givenIndexType
is a KEY Index.static IndexType
Returns the enum constant of this class with the specified name.static IndexType
valueOf
(org.apache.geode.cache.query.IndexType gemfireIndexType) static IndexType
valueOfIgnoreCase
(String value) static IndexType[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
FUNCTIONAL
-
HASH
-
PRIMARY_KEY
-
KEY
-
-
Field Details
-
DEFAULT
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
isFunctional
Null-safe operation to determine if the givenIndexType
is a FUNCTIONAL Index. -
isHash
Null-safe operation to determine if the givenIndexType
is a HASH Index. -
isKey
Null-safe operation to determine if the givenIndexType
is a KEY Index. -
valueOf
Returns anIndexType
given the corresponding Apache GeodeIndexType
or null if no SDGIndexType
corresponds to the given Apache GeodeIndexType
.- Parameters:
gemfireIndexType
- Apache GeodeIndexType
.- Returns:
- an
IndexType
matching the Apache GeodeIndexType
or null if the Apache GeodeIndexType
does not match any IndexType in this enumeration. - See Also:
-
IndexType
-
valueOfIgnoreCase
-
getGemfireIndexType
@NonNull public org.apache.geode.cache.query.IndexType getGemfireIndexType()Gets the matching Apache GeodeIndexType
for thisIndexType
enumerated value.- Returns:
- the matching Apache Geode
IndexType
. - See Also:
-
IndexType
-
isFunctional
public boolean isFunctional()Determines whether thisIndexType
is a FUNCTIONAL Index.- Returns:
- a boolean value indicating whether this
IndexType
is a FUNCTIONAL Index.
-
isHash
public boolean isHash()Determines whether thisIndexType
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.
-