com.splunk

Enum CollectionArgs.SortMode

java.lang.Object

java.lang.Enum<CollectionArgs.SortMode>

com.splunk.CollectionArgs.SortMode

All Implemented Interfaces:

Serializable, Comparable<CollectionArgs.SortMode>

Enclosing class:

CollectionArgs

public static enum CollectionArgs.SortMode
extends Enum<CollectionArgs.SortMode>

Indicates the sorting mode for entries.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALPHA Collate alphabetically.
ALPHA_CASE Collate alphabetically, case-sensitive.
AUTO If all values of the field are numbers, collate numerically.
NUM Collate numerically.

Method Summary

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

AUTO

public static final CollectionArgs.SortMode AUTO

If all values of the field are numbers, collate numerically. Otherwise, collate alphabetically.

ALPHA

public static final CollectionArgs.SortMode ALPHA

Collate alphabetically.

ALPHA_CASE

public static final CollectionArgs.SortMode ALPHA_CASE

Collate alphabetically, case-sensitive.

NUM

public static final CollectionArgs.SortMode NUM

Collate numerically.

Method Detail

values

public static CollectionArgs.SortMode[] 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.SortMode c : CollectionArgs.SortMode.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.SortMode 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

toString

public String toString()

Overrides:

toString in class Enum<CollectionArgs.SortMode>

Returns:

The REST API value for this enumerated constant.