org.disq_bio.disq

Enum VariantsFormatWriteOption

java.lang.Object

java.lang.Enum<VariantsFormatWriteOption>

org.disq_bio.disq.VariantsFormatWriteOption

All Implemented Interfaces:

Serializable, Comparable<VariantsFormatWriteOption>, WriteOption

public enum VariantsFormatWriteOption
extends Enum<VariantsFormatWriteOption>
implements WriteOption

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
VCF VCF format
VCF_BGZ block compressed VCF format (.vcf.bgz)
VCF_GZ block compressed VCF format (.vcf.gz)

Method Summary

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

VCF

public static final VariantsFormatWriteOption VCF

VCF format

VCF_BGZ

public static final VariantsFormatWriteOption VCF_BGZ

block compressed VCF format (.vcf.bgz)

VCF_GZ

public static final VariantsFormatWriteOption VCF_GZ

block compressed VCF format (.vcf.gz)

Method Detail

values

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

Returns:

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

valueOf

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