Package org.disq_bio.disq

Enum BaiWriteOption

java.lang.Object

java.lang.Enum<BaiWriteOption>

org.disq_bio.disq.BaiWriteOption

All Implemented Interfaces:

Serializable, Comparable<BaiWriteOption>, WriteOption

public enum BaiWriteOption
extends Enum<BaiWriteOption>
implements WriteOption

An option for for enabling or disabling writing BAI files. Disabled by default.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISABLE
ENABLE

Method Summary

Modifier and Type	Method	Description
static BaiWriteOption	fromBoolean(boolean writeBai)	Turn a boolean into a BaiWriteOption.
static String	getIndexExtension()
static BaiWriteOption	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BaiWriteOption[]	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

ENABLE

public static final BaiWriteOption ENABLE

DISABLE

public static final BaiWriteOption DISABLE

Method Detail

values

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

Returns:

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

valueOf

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

fromBoolean

public static BaiWriteOption fromBoolean(boolean writeBai)

Turn a boolean into a BaiWriteOption.

Parameters:

writeBai - if writing BAI files is enabled

Returns:

a BaiWriteOption

getIndexExtension

public static String getIndexExtension()

Returns:

the extension for BAI files.