com.cloudant.client.api.model

Enum IndexField.SortOrder

java.lang.Object

java.lang.Enum<IndexField.SortOrder>

com.cloudant.client.api.model.IndexField.SortOrder

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IndexField.SortOrder>

Enclosing class:

IndexField

public static enum IndexField.SortOrder
extends java.lang.Enum<IndexField.SortOrder>

Ascending or descending sort order

Enum Constant Summary

Enum Constants

Enum Constant and Description
asc ascending
desc descending

Method Summary

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

ascending

desc

public static final IndexField.SortOrder desc

descending

Method Detail

values

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

Returns:

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

valueOf

public static IndexField.SortOrder 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