htsjdk.samtools.util.htsget

Enum HtsgetFormat

java.lang.Object

java.lang.Enum<HtsgetFormat>

htsjdk.samtools.util.htsget.HtsgetFormat

All Implemented Interfaces:

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

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

Formats currently supported by htsget as defined by spec

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAM
BCF
CRAM
VCF

Method Summary

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

BAM

public static final HtsgetFormat BAM

CRAM

public static final HtsgetFormat CRAM

VCF

public static final HtsgetFormat VCF

BCF

public static final HtsgetFormat BCF

Method Detail

values

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

Returns:

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

valueOf

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