com.splunk

Enum CollectionArgs.SortDirection

java.lang.Object

java.lang.Enum<CollectionArgs.SortDirection>

com.splunk.CollectionArgs.SortDirection

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CollectionArgs.SortDirection>

Enclosing class:

CollectionArgs

public static enum CollectionArgs.SortDirection
extends java.lang.Enum<CollectionArgs.SortDirection>

Indicates whether to sort entries in ascending or descending order.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASC Sort entries in ascending order.
DESC Sort entries in descending order.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ASC

public static final CollectionArgs.SortDirection ASC

Sort entries in ascending order.

DESC

public static final CollectionArgs.SortDirection DESC

Sort entries in descending order.

Method Detail

values

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

Returns:

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

valueOf

public static CollectionArgs.SortDirection 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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<CollectionArgs.SortDirection>

Returns:

The REST API value for this enumerated constant.