htsjdk.tribble.index

Enum IndexFactory.IndexBalanceApproach

java.lang.Object

java.lang.Enum<IndexFactory.IndexBalanceApproach>

htsjdk.tribble.index.IndexFactory.IndexBalanceApproach

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IndexFactory.IndexBalanceApproach>

Enclosing class:

IndexFactory

public static enum IndexFactory.IndexBalanceApproach
extends java.lang.Enum<IndexFactory.IndexBalanceApproach>

We can optimize index-file-creation for different factors. As of this writing, those are index-file size or seeking time.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FOR_SEEK_TIME
FOR_SIZE

Method Summary

Methods

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

FOR_SIZE

public static final IndexFactory.IndexBalanceApproach FOR_SIZE

FOR_SEEK_TIME

public static final IndexFactory.IndexBalanceApproach FOR_SEEK_TIME

Method Detail

values

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

Returns:

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

valueOf

public static IndexFactory.IndexBalanceApproach 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