htsjdk.samtools.util.htsget

Enum HtsgetRequestField

java.lang.Object

java.lang.Enum<HtsgetRequestField>

htsjdk.samtools.util.htsget.HtsgetRequestField

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HtsgetRequestField>

public enum HtsgetRequestField
extends java.lang.Enum<HtsgetRequestField>

Fields which can be used to filter a htsget request as defined by the spec

Enum Constant Summary

Enum Constants

Enum Constant and Description
CIGAR
FLAG
MAPQ
PNEXT
POS
QNAME
QUAL
RNAME
RNEXT
SEQ
TLEN

Method Summary

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

QNAME

public static final HtsgetRequestField QNAME

FLAG

public static final HtsgetRequestField FLAG

RNAME

public static final HtsgetRequestField RNAME

POS

public static final HtsgetRequestField POS

MAPQ

public static final HtsgetRequestField MAPQ

CIGAR

public static final HtsgetRequestField CIGAR

RNEXT

public static final HtsgetRequestField RNEXT

PNEXT

public static final HtsgetRequestField PNEXT

TLEN

public static final HtsgetRequestField TLEN

SEQ

public static final HtsgetRequestField SEQ

QUAL

public static final HtsgetRequestField QUAL

Method Detail

values

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

Returns:

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

valueOf

public static HtsgetRequestField 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