com.azure.cosmos

Enum CompositePathSortOrder

java.lang.Object

java.lang.Enum<CompositePathSortOrder>

com.azure.cosmos.CompositePathSortOrder

All Implemented Interfaces:

Serializable, Comparable<CompositePathSortOrder>

public enum CompositePathSortOrder
extends Enum<CompositePathSortOrder>

Represents the sorting order for a path in a composite index, for a collection in the Azure Cosmos DB database service.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCENDING ASCENDING sort order for composite paths.
DESCENDING DESCENDING sort order for composite paths.

Method Summary

Modifier and Type	Method and Description
static CompositePathSortOrder	valueOf(String name) Returns the enum constant of this type with the specified name.
static CompositePathSortOrder[]	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

ASCENDING

public static final CompositePathSortOrder ASCENDING

ASCENDING sort order for composite paths.

DESCENDING

public static final CompositePathSortOrder DESCENDING

DESCENDING sort order for composite paths.

Method Detail

values

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

Returns:

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

valueOf

public static CompositePathSortOrder 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