Package htsjdk.tribble.index
Enum Class IndexFactory.IndexType
- All Implemented Interfaces:
Serializable
,Comparable<IndexFactory.IndexType>
,Constable
- Enclosing class:
IndexFactory
an enum that contains all of the information about the index types, and how to create them
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionboolean
int
static IndexFactory.IndexType
int
static IndexFactory.IndexType
Returns the enum constant of this class with the specified name.static IndexFactory.IndexType[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
LINEAR
-
INTERVAL_TREE
-
TABIX
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-
getDefaultBinSize
public int getDefaultBinSize() -
canCreate
public boolean canCreate() -
getTribbleIndexType
-
createIndex
-
getMagicNumber
public int getMagicNumber() -
getIndexType
- Parameters:
is
- InputStream of index. This will be reset to location it was at when method was invoked.- Returns:
- The
IndexType
based on theheaderValue
- Throws:
TribbleException.UnableToCreateCorrectIndexType
-