org.mongodb.morphia.utils

Enum IndexType

java.lang.Object

java.lang.Enum<IndexType>

org.mongodb.morphia.utils.IndexType

All Implemented Interfaces:

Serializable, Comparable<IndexType>

public enum IndexType
extends Enum<IndexType>

Defines the type of the index to create for a field.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASC
DESC
GEO2D
GEO2DSPHERE
HASHED
TEXT

Method Summary

Modifier and Type	Method and Description
Object	toIndexValue() Returns the value as needed by the index definition document
static IndexType	valueOf(String name) Returns the enum constant of this type with the specified name.
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

ASC

public static final IndexType ASC

DESC

public static final IndexType DESC

GEO2D

public static final IndexType GEO2D

GEO2DSPHERE

public static final IndexType GEO2DSPHERE

HASHED

public static final IndexType HASHED

TEXT

public static final IndexType TEXT

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

toIndexValue

public Object toIndexValue()

Returns the value as needed by the index definition document

Returns:

the value