htsjdk.samtools.cram.structure.block

Enum BlockCompressionMethod

java.lang.Object

java.lang.Enum<BlockCompressionMethod>

htsjdk.samtools.cram.structure.block.BlockCompressionMethod

All Implemented Interfaces:

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

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

The block compression methods specified by Section 8 of the CRAM spec.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BZIP2
GZIP
LZMA
RANS
RAW

Method Summary

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

RAW

public static final BlockCompressionMethod RAW

GZIP

public static final BlockCompressionMethod GZIP

BZIP2

public static final BlockCompressionMethod BZIP2

LZMA

public static final BlockCompressionMethod LZMA

RANS

public static final BlockCompressionMethod RANS

Method Detail

values

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

Returns:

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

valueOf

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

getMethodId

public int getMethodId()

Returns:

the number assigned to each block compression method in the CRAM spec

byId

public static BlockCompressionMethod byId(int id)

Return the BlockCompressionMethod specified by the ID

Parameters:

id - the number assigned to each block compression method in the CRAM spec

Returns:

the BlockCompressionMethod associated with the ID