com.dnanexus

Enum DXSearch.VisibilityQuery

java.lang.Object

java.lang.Enum<DXSearch.VisibilityQuery>

com.dnanexus.DXSearch.VisibilityQuery

All Implemented Interfaces:

Serializable, Comparable<DXSearch.VisibilityQuery>

Enclosing class:

DXSearch

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
EITHER Search for both hidden and visible items.
HIDDEN Search for only hidden items.
VISIBLE Search for only visible items.

Method Summary

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

VISIBLE

public static final DXSearch.VisibilityQuery VISIBLE

Search for only visible items.

HIDDEN

public static final DXSearch.VisibilityQuery HIDDEN

Search for only hidden items.

EITHER

public static final DXSearch.VisibilityQuery EITHER

Search for both hidden and visible items.

Method Detail

values

public static DXSearch.VisibilityQuery[] 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.VisibilityQuery c : DXSearch.VisibilityQuery.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.VisibilityQuery 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