com.fulcrumgenomics.bam.api.SamIterator.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fgbio_2.13 Show documentation

fgbio

The newest version!

/*
 * The MIT License
 *
 * Copyright (c) 2017 Fulcrum Genomics LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.fulcrumgenomics.bam.api

import com.fulcrumgenomics.commons.CommonsDef._
import htsjdk.samtools.{SAMFileHeader, SAMRecordIterator}
import com.fulcrumgenomics.commons.collection.SelfClosingIterator

/** An iterator over [[com.fulcrumgenomics.bam.api.SamRecord]]s that will automatically close the underlying iterator at
  * the end of iteration, and provides access to the [[htsjdk.samtools.SAMFileHeader]] from the associated source.
  */
final class SamIterator(val header: SAMFileHeader, underlying: SAMRecordIterator)
  extends SelfClosingIterator[SamRecord](underlying.map(_.asInstanceOf[SamRecord]), () => underlying.close()) with HeaderHelper