org.mongodb.morphia.utils

Enum IndexDirection

java.lang.Object

java.lang.Enum<IndexDirection>

org.mongodb.morphia.utils.IndexDirection

All Implemented Interfaces:

Serializable, Comparable<IndexDirection>

public enum IndexDirection
extends Enum<IndexDirection>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASC
DESC
GEO2D

Method Summary

Methods

Modifier and Type	Method and Description
Object	toIndexValue()
static IndexDirection	valueOf(String name) Returns the enum constant of this type with the specified name.
static IndexDirection[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, 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 IndexDirection ASC

DESC

public static final IndexDirection DESC

GEO2D

public static final IndexDirection GEO2D

Method Detail

values

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

Returns:

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

valueOf

public static IndexDirection 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()