htsjdk.samtools.cram.structure

Enum EncodingKey

java.lang.Object

java.lang.Enum<EncodingKey>

htsjdk.samtools.cram.structure.EncodingKey

All Implemented Interfaces:

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
AP_AlignmentPositionOffset
BA_Base
BF_BitFlags
BS_BaseSubstitutionCode
CF_CompressionBitFlags
DL_DeletionLength
FC_FeatureCode
FN_NumberOfReadFeatures
FP_FeaturePosition
HC_HardClip
IN_Insertion
MF_MateBitFlags
MQ_MappingQualityScore
NF_RecordsToNextFragment
NP_NextFragmentAlignmentStart
NS_NextFragmentReferenceSequenceID
PD_padding
QS_QualityScore
RG_ReadGroup
RI_RefId
RL_ReadLength
RN_ReadName
RS_RefSkip
SC_SoftClip
TC_TagCount
TL_TagIdList
TM_TestMark
TN_TagNameAndType
TS_InsetSize
TV_TestMark

Method Summary

Methods

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

BF_BitFlags

public static final EncodingKey BF_BitFlags

AP_AlignmentPositionOffset

public static final EncodingKey AP_AlignmentPositionOffset

FP_FeaturePosition

public static final EncodingKey FP_FeaturePosition

FC_FeatureCode

public static final EncodingKey FC_FeatureCode

QS_QualityScore

public static final EncodingKey QS_QualityScore

DL_DeletionLength

public static final EncodingKey DL_DeletionLength

BA_Base

public static final EncodingKey BA_Base

TN_TagNameAndType

public static final EncodingKey TN_TagNameAndType

NF_RecordsToNextFragment

public static final EncodingKey NF_RecordsToNextFragment

RL_ReadLength

public static final EncodingKey RL_ReadLength

RG_ReadGroup

public static final EncodingKey RG_ReadGroup

MQ_MappingQualityScore

public static final EncodingKey MQ_MappingQualityScore

RN_ReadName

public static final EncodingKey RN_ReadName

NP_NextFragmentAlignmentStart

public static final EncodingKey NP_NextFragmentAlignmentStart

TS_InsetSize

public static final EncodingKey TS_InsetSize

FN_NumberOfReadFeatures

public static final EncodingKey FN_NumberOfReadFeatures

BS_BaseSubstitutionCode

public static final EncodingKey BS_BaseSubstitutionCode

IN_Insertion

public static final EncodingKey IN_Insertion

TC_TagCount

public static final EncodingKey TC_TagCount

MF_MateBitFlags

public static final EncodingKey MF_MateBitFlags

NS_NextFragmentReferenceSequenceID

public static final EncodingKey NS_NextFragmentReferenceSequenceID

CF_CompressionBitFlags

public static final EncodingKey CF_CompressionBitFlags

TV_TestMark

public static final EncodingKey TV_TestMark

TM_TestMark

public static final EncodingKey TM_TestMark

TL_TagIdList

public static final EncodingKey TL_TagIdList

RI_RefId

public static final EncodingKey RI_RefId

RS_RefSkip

public static final EncodingKey RS_RefSkip

SC_SoftClip

public static final EncodingKey SC_SoftClip

HC_HardClip

public static final EncodingKey HC_HardClip

PD_padding

public static final EncodingKey PD_padding

Method Detail

values

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

Returns:

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

valueOf

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

byFirstTwoChars

public static final EncodingKey byFirstTwoChars(java.lang.String chars)

toTwoBytes

public static final byte[] toTwoBytes(EncodingKey key)