Package com.gigaspaces.metadata.index

Enum Class SpaceIndexType

java.lang.Object

java.lang.Enum<SpaceIndexType>

com.gigaspaces.metadata.index.SpaceIndexType

All Implemented Interfaces:

Serializable, Comparable<SpaceIndexType>, java.lang.constant.Constable

public enum SpaceIndexType
extends Enum<SpaceIndexType>

Determines a Space index type.

Since:

7.1

Author:

Niv Ingberg

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BASIC	Deprecated. since 12.3 - use EQUAL instead.
DEFAULT	Default value, used for SpaceId.
EQUAL	Index that supports equality.
EQUAL_AND_ORDERED	Index that supports both equality and comparison.
EXTENDED	Deprecated. since 12.3 - use ORDERED or EQUAL_AND_ORDERED instead.
NONE	Not indexed.
ORDERED	Index that supports comparison.

Method Summary

Modifier and Type	Method	Description
boolean	isIndexed()
boolean	isOrdered()
static SpaceIndexType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SpaceIndexType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEFAULT

public static final SpaceIndexType DEFAULT

Default value, used for SpaceId. The default is NONE for auto-generated Id, EQUAL otherwise. If the Space ID is compound (multiple properties), a compound index is created.

Since:

16.2

NONE

public static final SpaceIndexType NONE

Not indexed.

BASIC

@Deprecated
public static final SpaceIndexType BASIC

Deprecated.

since 12.3 - use EQUAL instead.

Basic index - supports equality.

EXTENDED

@Deprecated
public static final SpaceIndexType EXTENDED

Deprecated.

since 12.3 - use ORDERED or EQUAL_AND_ORDERED instead.

Extended(ordered) index - supports comparison.

EQUAL

public static final SpaceIndexType EQUAL

Index that supports equality.

Since:

12.3

ORDERED

public static final SpaceIndexType ORDERED

Index that supports comparison.

Since:

12.3

EQUAL_AND_ORDERED

public static final SpaceIndexType EQUAL_AND_ORDERED

Index that supports both equality and comparison.

Since:

12.3

Method Details

values

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

isIndexed

public boolean isIndexed()

Returns:

true if this index type indicates an indexed state, false otherwise.

isOrdered

public boolean isOrdered()