org.disq_bio.disq

Enum ReadsFormatWriteOption

java.lang.Object

java.lang.Enum<ReadsFormatWriteOption>

org.disq_bio.disq.ReadsFormatWriteOption

All Implemented Interfaces:

Serializable, Comparable<ReadsFormatWriteOption>, WriteOption

public enum ReadsFormatWriteOption
extends Enum<ReadsFormatWriteOption>
implements WriteOption

An option for configuring which format to write a HtsjdkReadsRdd as.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAM BAM format
CRAM CRAM format
SAM SAM format

Method Summary

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

BAM format

CRAM

public static final ReadsFormatWriteOption CRAM

CRAM format

SAM

public static final ReadsFormatWriteOption SAM

SAM format

Method Detail

values

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

Returns:

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

valueOf

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