SMILA (incubation) API documentation

org.eclipse.smila.processing.parameters
Enum SearchParameters.OrderMode

java.lang.Object
  extended by java.lang.Enum<SearchParameters.OrderMode>
      extended by org.eclipse.smila.processing.parameters.SearchParameters.OrderMode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SearchParameters.OrderMode>
Enclosing class:
SearchParameters

public static enum SearchParameters.OrderMode
extends java.lang.Enum<SearchParameters.OrderMode>

Values for the "orderBy"/"mode" parameter: Sort ascending or descending.


Enum Constant Summary
ASC
          sort ascending.
DESC
          sort descending.
 
Method Summary
static SearchParameters.OrderMode valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static SearchParameters.OrderMode[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ASC

public static final SearchParameters.OrderMode ASC
sort ascending.


DESC

public static final SearchParameters.OrderMode DESC
sort descending.

Method Detail

values

public static final SearchParameters.OrderMode[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(SearchParameters.OrderMode c : SearchParameters.OrderMode.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static SearchParameters.OrderMode 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

SMILA (incubation) API documentation