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
This commit is contained in:
hanna 2011-04-13 15:10:46 +00:00
parent 06b1497902
commit a36adf0c6b
1 changed files with 3 additions and 1 deletions

View File

@ -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();