Enum BlockCompressionMethod
- java.lang.Object
-
- java.lang.Enum<BlockCompressionMethod>
-
- htsjdk.samtools.cram.structure.block.BlockCompressionMethod
-
- All Implemented Interfaces:
Serializable
,Comparable<BlockCompressionMethod>
public enum BlockCompressionMethod extends Enum<BlockCompressionMethod>
The block compression methods specified by Section 8 of the CRAM spec.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static BlockCompressionMethod
byId(int id)
Return the BlockCompressionMethod specified by the IDint
getMethodId()
static BlockCompressionMethod
valueOf(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.
-
-
-
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(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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- 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
-
-