com.splunk
Enum CollectionArgs.SortMode

java.lang.Object
  extended by java.lang.Enum<CollectionArgs.SortMode>
      extended by com.splunk.CollectionArgs.SortMode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<CollectionArgs.SortMode>
Enclosing class:
CollectionArgs

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

Indicates the sorting mode for entries.


Enum Constant Summary
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
 java.lang.String toString()
           
static CollectionArgs.SortMode valueOf(java.lang.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
compareTo, equals, 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(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.SortMode>
Returns:
The REST API value for this enumerated constant.