com.dnanexus

Enum DXSearch.Ordering

java.lang.Object

java.lang.Enum<DXSearch.Ordering>

com.dnanexus.DXSearch.Ordering

All Implemented Interfaces:

Serializable, Comparable<DXSearch.Ordering>

Enclosing class:

DXSearch

public static enum DXSearch.Ordering
extends Enum<DXSearch.Ordering>

Specifies in a query whether to return visible items, hidden items, or both.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCENDING Search for only visible items.
DESCENDING Search for only hidden items.

Method Summary

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

ASCENDING

public static final DXSearch.Ordering ASCENDING

Search for only visible items.

DESCENDING

public static final DXSearch.Ordering DESCENDING

Search for only hidden items.

Method Detail

values

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

Returns:

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

valueOf

public static DXSearch.Ordering 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