From 928a55612363e250dd329ac478ab08f69daacc13 Mon Sep 17 00:00:00 2001
From: Phil Steitz <psteitz@apache.org>
Date: Wed, 4 Sep 2013 17:24:02 +0000
Subject: [PATCH] Clarified javadoc for setXxxImpl methods. JIRA: MATH-1023.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1520076 13f79535-47bb-0310-9956-ffa450edef68
---
 .../stat/descriptive/SummaryStatistics.java   | 56 +++++++++++--------
 1 file changed, 32 insertions(+), 24 deletions(-)

diff --git a/src/main/java/org/apache/commons/math3/stat/descriptive/SummaryStatistics.java b/src/main/java/org/apache/commons/math3/stat/descriptive/SummaryStatistics.java
index 3e7fff7d6..e1bc875a3 100644
--- a/src/main/java/org/apache/commons/math3/stat/descriptive/SummaryStatistics.java
+++ b/src/main/java/org/apache/commons/math3/stat/descriptive/SummaryStatistics.java
@@ -418,9 +418,10 @@ public class SummaryStatistics implements StatisticalSummary, Serializable {
      * Sets the implementation for the Sum.
      * </p>
      * <p>
-     * This method must be activated before any data has been added - i.e.,
-     * before {@link #addValue(double) addValue} has been used to add data;
-     * otherwise an IllegalStateException will be thrown.
+     * This method cannot be activated after data has been added - i.e.,
+     * after {@link #addValue(double) addValue} has been used to add data.
+     * If it is activated after data has been added, an IllegalStateException
+     * will be thrown.
      * </p>
      * @param sumImpl the StorelessUnivariateStatistic instance to use for
      *        computing the Sum
@@ -447,9 +448,10 @@ public class SummaryStatistics implements StatisticalSummary, Serializable {
      * Sets the implementation for the sum of squares.
      * </p>
      * <p>
-     * This method must be activated before any data has been added - i.e.,
-     * before {@link #addValue(double) addValue} has been used to add data;
-     * otherwise an IllegalStateException will be thrown.
+     * This method cannot be activated after data has been added - i.e.,
+     * after {@link #addValue(double) addValue} has been used to add data.
+     * If it is activated after data has been added, an IllegalStateException
+     * will be thrown.
      * </p>
      * @param sumsqImpl the StorelessUnivariateStatistic instance to use for
      *        computing the sum of squares
@@ -476,9 +478,10 @@ public class SummaryStatistics implements StatisticalSummary, Serializable {
      * Sets the implementation for the minimum.
      * </p>
      * <p>
-     * This method must be activated before any data has been added - i.e.,
-     * before {@link #addValue(double) addValue} has been used to add data;
-     * otherwise an IllegalStateException will be thrown.
+     * This method cannot be activated after data has been added - i.e.,
+     * after {@link #addValue(double) addValue} has been used to add data.
+     * If it is activated after data has been added, an IllegalStateException
+     * will be thrown.
      * </p>
      * @param minImpl the StorelessUnivariateStatistic instance to use for
      *        computing the minimum
@@ -505,9 +508,10 @@ public class SummaryStatistics implements StatisticalSummary, Serializable {
      * Sets the implementation for the maximum.
      * </p>
      * <p>
-     * This method must be activated before any data has been added - i.e.,
-     * before {@link #addValue(double) addValue} has been used to add data;
-     * otherwise an IllegalStateException will be thrown.
+     * This method cannot be activated after data has been added - i.e.,
+     * after {@link #addValue(double) addValue} has been used to add data.
+     * If it is activated after data has been added, an IllegalStateException
+     * will be thrown.
      * </p>
      * @param maxImpl the StorelessUnivariateStatistic instance to use for
      *        computing the maximum
@@ -534,9 +538,10 @@ public class SummaryStatistics implements StatisticalSummary, Serializable {
      * Sets the implementation for the sum of logs.
      * </p>
      * <p>
-     * This method must be activated before any data has been added - i.e.,
-     * before {@link #addValue(double) addValue} has been used to add data;
-     * otherwise an IllegalStateException will be thrown.
+     * This method cannot be activated after data has been added - i.e.,
+     * after {@link #addValue(double) addValue} has been used to add data.
+     * If it is activated after data has been added, an IllegalStateException
+     * will be thrown.
      * </p>
      * @param sumLogImpl the StorelessUnivariateStatistic instance to use for
      *        computing the log sum
@@ -564,9 +569,10 @@ public class SummaryStatistics implements StatisticalSummary, Serializable {
      * Sets the implementation for the geometric mean.
      * </p>
      * <p>
-     * This method must be activated before any data has been added - i.e.,
-     * before {@link #addValue(double) addValue} has been used to add data;
-     * otherwise an IllegalStateException will be thrown.
+     * This method cannot be activated after data has been added - i.e.,
+     * after {@link #addValue(double) addValue} has been used to add data.
+     * If it is activated after data has been added, an IllegalStateException
+     * will be thrown.
      * </p>
      * @param geoMeanImpl the StorelessUnivariateStatistic instance to use for
      *        computing the geometric mean
@@ -593,9 +599,10 @@ public class SummaryStatistics implements StatisticalSummary, Serializable {
      * Sets the implementation for the mean.
      * </p>
      * <p>
-     * This method must be activated before any data has been added - i.e.,
-     * before {@link #addValue(double) addValue} has been used to add data;
-     * otherwise an IllegalStateException will be thrown.
+     * This method cannot be activated after data has been added - i.e.,
+     * after {@link #addValue(double) addValue} has been used to add data.
+     * If it is activated after data has been added, an IllegalStateException
+     * will be thrown.
      * </p>
      * @param meanImpl the StorelessUnivariateStatistic instance to use for
      *        computing the mean
@@ -622,9 +629,10 @@ public class SummaryStatistics implements StatisticalSummary, Serializable {
      * Sets the implementation for the variance.
      * </p>
      * <p>
-     * This method must be activated before any data has been added - i.e.,
-     * before {@link #addValue(double) addValue} has been used to add data;
-     * otherwise an IllegalStateException will be thrown.
+     * This method cannot be activated after data has been added - i.e.,
+     * after {@link #addValue(double) addValue} has been used to add data.
+     * If it is activated after data has been added, an IllegalStateException
+     * will be thrown.
      * </p>
      * @param varianceImpl the StorelessUnivariateStatistic instance to use for
      *        computing the variance