htsjdk.variant.variantcontext.writer

Enum Options

java.lang.Object

java.lang.Enum<Options>

htsjdk.variant.variantcontext.writer.Options

All Implemented Interfaces:

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

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

Available writer options for VariantContextWriters

Since:

5/12

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALLOW_MISSING_FIELDS_IN_HEADER
DO_NOT_WRITE_GENOTYPES
FORCE_BCF
INDEX_ON_THE_FLY
USE_ASYNC_IO
WRITE_FULL_FORMAT_FIELD

Method Summary

Methods

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

INDEX_ON_THE_FLY

public static final Options INDEX_ON_THE_FLY

DO_NOT_WRITE_GENOTYPES

public static final Options DO_NOT_WRITE_GENOTYPES

ALLOW_MISSING_FIELDS_IN_HEADER

public static final Options ALLOW_MISSING_FIELDS_IN_HEADER

FORCE_BCF

public static final Options FORCE_BCF

USE_ASYNC_IO

public static final Options USE_ASYNC_IO

WRITE_FULL_FORMAT_FIELD

public static final Options WRITE_FULL_FORMAT_FIELD

Method Detail

values

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

Returns:

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

valueOf

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