org.broadinstitute.hellbender.engine

Class ShardBoundaryShard<T>

java.lang.Object

org.broadinstitute.hellbender.engine.ShardBoundaryShard<T>

All Implemented Interfaces:

htsjdk.samtools.util.Locatable, java.io.Serializable, java.lang.Iterable<T>, Shard<T>

public final class ShardBoundaryShard<T>
extends java.lang.Object
implements Shard<T>, java.io.Serializable

A Shard backed by a ShardBoundary and a collection of records.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ShardBoundaryShard(ShardBoundary shardBoundary, java.lang.Iterable<T> locatables) Create a new ShardBoundaryShard from the given ShardBoundary and records.

Method Summary

Modifier and Type	Method and Description
SimpleInterval	getInterval()
SimpleInterval	getPaddedInterval()
ShardBoundary	getShardBoundary()
java.util.Iterator<T>	iterator()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.broadinstitute.hellbender.engine.Shard

divideIntervalIntoShards, divideIntervalIntoShards, getContig, getEnd, getStart

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface htsjdk.samtools.util.Locatable

contains, contigsMatch, getLengthOnReference, overlaps, withinDistanceOf

Constructor Detail

ShardBoundaryShard

public ShardBoundaryShard(ShardBoundary shardBoundary,
                          java.lang.Iterable<T> locatables)

Create a new ShardBoundaryShard from the given ShardBoundary and records.

Parameters:

shardBoundary - the boundary defining the shard

locatables - the records overlapping the shard

Method Detail

getInterval

public SimpleInterval getInterval()

Specified by:

getInterval in interface Shard<T>

Returns:

the interval this shard spans

getPaddedInterval

public SimpleInterval getPaddedInterval()

Specified by:

getPaddedInterval in interface Shard<T>

Returns:

the interval this shard spans, potentially with additional padding on each side it must be the case that for a given Shard getPaddedInterval().contains(getInterval())

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

getShardBoundary

public ShardBoundary getShardBoundary()