org.springframework.data.gemfire

Enum IndexType

java.lang.Object

java.lang.Enum<IndexType>

org.springframework.data.gemfire.IndexType

All Implemented Interfaces:

Serializable, Comparable<IndexType>

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:

IndexType

Enum Constant Summary

Enum Constants

Enum Constant and Description
FUNCTIONAL
HASH
KEY
PRIMARY_KEY

Field Summary

Fields

Modifier and Type	Field and Description
static IndexType	DEFAULT

Method Summary

Modifier and Type	Method and Description
org.apache.geode.cache.query.IndexType	getGemfireIndexType() Gets the matching Apache Geode IndexType for this IndexType enumerated value.
boolean	isFunctional() Determines whether this IndexType is a FUNCTIONAL Index.
static boolean	isFunctional(IndexType indexType) Null-safe operation to determine if the given IndexType is a FUNCTIONAL Index.
boolean	isHash() Determines whether this IndexType is a HASH Index.
static boolean	isHash(IndexType indexType) Null-safe operation to determine if the given IndexType is a HASH Index.
boolean	isKey() Determines whether this IndexType is a KEY Index.
static boolean	isKey(IndexType indexType) Null-safe operation to determine if the given IndexType is a KEY Index.
static IndexType	valueOf(org.apache.geode.cache.query.IndexType gemfireIndexType) Returns an IndexType given the corresponding Apache Geode IndexType or null if no SDG IndexType corresponds to the given Apache Geode IndexType.
static IndexType	valueOf(String name) Returns the enum constant of this type with the specified name.
static IndexType	valueOfIgnoreCase(String value) Return an IndexType matching the given String.
static IndexType[]	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

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 Detail

DEFAULT

public static final IndexType DEFAULT

Method Detail

values

public static IndexType[] 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 (IndexType c : IndexType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IndexType valueOf(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:

IllegalArgumentException - if this enum type 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:

isFunctional()

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:

isHash()

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:

isKey()

valueOf

public static IndexType valueOf(org.apache.geode.cache.query.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:

IndexType

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:

String.equalsIgnoreCase(String)

getGemfireIndexType

@NonNull
public org.apache.geode.cache.query.IndexType getGemfireIndexType()

Gets the matching Apache Geode IndexType for this IndexType enumerated value.

Returns:

the matching Apache Geode IndexType.

See Also:

IndexType

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.