htsjdk.samtools.cram.structure.block

Enum BlockContentType

java.lang.Object

java.lang.Enum<BlockContentType>

htsjdk.samtools.cram.structure.block.BlockContentType

All Implemented Interfaces:

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

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

The block content types specified by Section 8.1 of the CRAM spec

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPRESSION_HEADER
CORE
EXTERNAL
FILE_HEADER
MAPPED_SLICE
RESERVED

Method Summary

Modifier and Type	Method and Description
static BlockContentType	byId(int id) Return the BlockContentType specified by the ID
int	getContentTypeId()
static BlockContentType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BlockContentType[]	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

FILE_HEADER

public static final BlockContentType FILE_HEADER

COMPRESSION_HEADER

public static final BlockContentType COMPRESSION_HEADER

MAPPED_SLICE

public static final BlockContentType MAPPED_SLICE

RESERVED

public static final BlockContentType RESERVED

EXTERNAL

public static final BlockContentType EXTERNAL

CORE

public static final BlockContentType CORE

Method Detail

values

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

Returns:

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

valueOf

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

getContentTypeId

public int getContentTypeId()

Returns:

the ID assigned to each content type in the CRAM spec

byId

public static BlockContentType byId(int id)

Return the BlockContentType specified by the ID

Parameters:

id - the number assigned to each block content type in the CRAM spec

Returns:

the BlockContentType associated with the ID