Package htsjdk.samtools
Enum SAMFileHeader.SortOrder
- java.lang.Object
-
- java.lang.Enum<SAMFileHeader.SortOrder>
-
- htsjdk.samtools.SAMFileHeader.SortOrder
-
- All Implemented Interfaces:
Serializable
,Comparable<SAMFileHeader.SortOrder>
- Enclosing class:
- SAMFileHeader
public static enum SAMFileHeader.SortOrder extends Enum<SAMFileHeader.SortOrder>
Ways in which a SAM or BAM may be sorted.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description coordinate
duplicate
queryname
unknown
unsorted
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Class<? extends SAMRecordComparator>
getComparator()
Deprecated.since 7/2018, usegetComparatorInstance()
withObject.getClass()
insteadSAMRecordComparator
getComparatorInstance()
static SAMFileHeader.SortOrder
valueOf(String name)
Returns the enum constant of this type with the specified name.static SAMFileHeader.SortOrder[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
unsorted
public static final SAMFileHeader.SortOrder unsorted
-
queryname
public static final SAMFileHeader.SortOrder queryname
-
coordinate
public static final SAMFileHeader.SortOrder coordinate
-
duplicate
public static final SAMFileHeader.SortOrder duplicate
-
unknown
public static final SAMFileHeader.SortOrder unknown
-
-
Method Detail
-
values
public static SAMFileHeader.SortOrder[] 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 (SAMFileHeader.SortOrder c : SAMFileHeader.SortOrder.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SAMFileHeader.SortOrder 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
-
getComparator
@Deprecated public Class<? extends SAMRecordComparator> getComparator()
Deprecated.since 7/2018, usegetComparatorInstance()
withObject.getClass()
instead- Returns:
- Comparator class to sort in the specified order, or null if unsorted.
-
getComparatorInstance
public SAMRecordComparator getComparatorInstance()
- Returns:
- Comparator to sort in the specified order, or null if unsorted.
-
-