org.broadinstitute.hellbender.engine

Class TraversalParameters

java.lang.Object

org.broadinstitute.hellbender.engine.TraversalParameters

All Implemented Interfaces:

java.io.Serializable

public class TraversalParameters
extends java.lang.Object
implements java.io.Serializable

A simple container class for parameters controlling which records get returned during traversals. Holds a List of intervals (may be empty) and a flag controlling whether unmapped records should be returned.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TraversalParameters(java.util.List<SimpleInterval> intervalsForTraversal, boolean traverseUnmapped)

Method Summary

Modifier and Type	Method and Description
java.util.List<SimpleInterval>	getIntervalsForTraversal()
boolean	traverseUnmappedReads()

Methods inherited from class java.lang.Object

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

Constructor Detail

TraversalParameters

public TraversalParameters(java.util.List<SimpleInterval> intervalsForTraversal,
                           boolean traverseUnmapped)

Parameters:

intervalsForTraversal - List of intervals for traversal. Only records overlapping these intervals will be returned.

traverseUnmapped - True if unmapped records should be traversed

Method Detail

getIntervalsForTraversal

public java.util.List<SimpleInterval> getIntervalsForTraversal()

Returns:

List of intervals for traversal. Only records overlapping these intervals will be returned.

traverseUnmappedReads

public boolean traverseUnmappedReads()

Returns:

True if unmapped records should be traversed