Package htsjdk.samtools

Enum Class SAMFileHeader.SortOrder

java.lang.Object
java.lang.Enum<SAMFileHeader.SortOrder>
htsjdk.samtools.SAMFileHeader.SortOrder
All Implemented Interfaces:
Serializable, Comparable<SAMFileHeader.SortOrder>, Constable
Enclosing class:
SAMFileHeader
public static enum SAMFileHeader.SortOrder extends Enum<SAMFileHeader.SortOrder>
Ways in which a SAM or BAM may be sorted.

  • Enum Constant Details

  • Method Details

    • values

      public static SAMFileHeader.SortOrder[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SAMFileHeader.SortOrder valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getComparator

      @Deprecated public Class<? extends SAMRecordComparator> getComparator()
      Deprecated.
      since 7/2018, use getComparatorInstance() with Object.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.