com.mongodb.operation

Enum OrderBy

java.lang.Object

java.lang.Enum<OrderBy>

com.mongodb.operation.OrderBy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OrderBy>

public enum OrderBy
extends java.lang.Enum<OrderBy>

Enumeration of possible index orders

Since:

3.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASC Ascending order
DESC Descending order

Method Summary

Modifier and Type	Method and Description
static OrderBy	fromInt(int intRepresentation) Gets the order from the given integer representation.
int	getIntRepresentation() The integer representation of the order.
static OrderBy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OrderBy[]	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 OrderBy ASC

Ascending order

DESC

public static final OrderBy DESC

Descending order

Method Detail

values

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

Returns:

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

valueOf

public static OrderBy valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getIntRepresentation

public int getIntRepresentation()

The integer representation of the order.

Returns:

the integer representation

fromInt

public static OrderBy fromInt(int intRepresentation)

Gets the order from the given integer representation.

Parameters:

intRepresentation - the integer representation

Returns:

the order