Method Detail

• assertSorted

  SAMRecordIterator assertSorted​(SAMFileHeader.SortOrder sortOrder)

  Establishes that records returned by this iterator are expected to be in the specified sort order. If this method has been called, then implementers must throw an IllegalStateException from next() when a record is read that violates the sort order. This method may be called multiple times over the course of an iteration, changing the expected sort, if desired -- from the time it is called, it validates whatever sort is set, or stops validating if it is set to null or SAMFileHeader.SortOrder.unsorted. If this method is not called, then no validation of the iterated records is done.

  Parameters:

  sortOrder - The order in which records are expected to be returned

  Returns:

  This SAMRecordIterator