From a36adf0c6b2f85caca6bee83b800df0ac0eb0478 Mon Sep 17 00:00:00 2001 From: hanna Date: Wed, 13 Apr 2011 15:10:46 +0000 Subject: [PATCH] Request from the cancer team -- guarantee via javadoc that the returned read metrics are actually a clone, which they can do with as they wish. git-svn-id: file:///humgen/gsa-scr1/gsa-engineering/svn_contents/trunk@5626 348d0f76-0448-11de-a6fe-93d51630548a --- .../org/broadinstitute/sting/gatk/GenomeAnalysisEngine.java | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/java/src/org/broadinstitute/sting/gatk/GenomeAnalysisEngine.java b/java/src/org/broadinstitute/sting/gatk/GenomeAnalysisEngine.java index 7cfbc0762..9e6694b65 100755 --- a/java/src/org/broadinstitute/sting/gatk/GenomeAnalysisEngine.java +++ b/java/src/org/broadinstitute/sting/gatk/GenomeAnalysisEngine.java @@ -1063,7 +1063,9 @@ public class GenomeAnalysisEngine { /** * Gets cumulative metrics about the entire run to this point. - * @return cumulative metrics about the entire run. + * Returns a clone of this snapshot in time. + * @return cumulative metrics about the entire run at this point. ReadMetrics object is a unique instance and is + * owned by the caller; the caller can do with the object what they wish. */ public ReadMetrics getCumulativeMetrics() { return readsDataSource == null ? null : readsDataSource.getCumulativeReadMetrics();