htsjdk.samtools.cram.ref

Enum ReferenceContextType

java.lang.Object

java.lang.Enum<ReferenceContextType>

htsjdk.samtools.cram.ref.ReferenceContextType

All Implemented Interfaces:

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

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

Is this ReferenceContext Single Reference, Multiple Reference, or Unmapped? Section 8.5 of the CRAM spec defines the following values for the Slice Header sequence ID field: -2: Multiple Reference Slice -1: Unmapped-Unplaced Slice Any positive integer (including zero): Single Reference Slice

Enum Constant Summary

Enum Constants

Enum Constant and Description
MULTIPLE_REFERENCE_TYPE
SINGLE_REFERENCE_TYPE
UNMAPPED_UNPLACED_TYPE

Method Summary

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

MULTIPLE_REFERENCE_TYPE

public static final ReferenceContextType MULTIPLE_REFERENCE_TYPE

UNMAPPED_UNPLACED_TYPE

public static final ReferenceContextType UNMAPPED_UNPLACED_TYPE

SINGLE_REFERENCE_TYPE

public static final ReferenceContextType SINGLE_REFERENCE_TYPE

Method Detail

values

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

Returns:

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

valueOf

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