org.broadinstitute.hellbender.utils.read

Enum ReadsWriteFormat

java.lang.Object

java.lang.Enum<ReadsWriteFormat>

org.broadinstitute.hellbender.utils.read.ReadsWriteFormat

All Implemented Interfaces:

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

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

Possible output formats when writing reads. (Currently used only in the context of Spark.)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADAM Write reads to a sharded set of ADAM-formatted Parquet files
SHARDED Write reads to a sharded set of BAM files
SINGLE Write reads to a single BAM file

Method Summary

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

SINGLE

public static final ReadsWriteFormat SINGLE

Write reads to a single BAM file

SHARDED

public static final ReadsWriteFormat SHARDED

Write reads to a sharded set of BAM files

ADAM

public static final ReadsWriteFormat ADAM

Write reads to a sharded set of ADAM-formatted Parquet files

Method Detail

values

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

Returns:

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

valueOf

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