Fix StreamOverflowException description to include state overflow

motinis · Jun 27, 2018 · f30236f · f30236f
1 parent aa506a7
commit f30236f
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/src/main/java/gr/james/sampling/RandomSampling.java b/src/main/java/gr/james/sampling/RandomSampling.java
@@ -31,7 +31,7 @@ public interface RandomSampling<T> {
      * @param item the item to feed to the algorithm
      * @return this instance
      * @throws NullPointerException    if {@code item} is {@code null}
-     * @throws StreamOverflowException if the amount of items feeded to this algorithm has reached the maximum allowed
+     * @throws StreamOverflowException if the internal state of the algorithm has overflown
      */
     RandomSampling<T> feed(T item);
 

diff --git a/src/main/java/gr/james/sampling/StreamOverflowException.java b/src/main/java/gr/james/sampling/StreamOverflowException.java
@@ -4,8 +4,10 @@
 import java.util.Map;
 
 /**
- * A {@code StreamOverflowException} indicates that the amount of items feeded to a random sampling algorithm exceeds
- * the maximum allowed.
+ * A {@code StreamOverflowException} indicates that the internal state of the algorithm has overflown.
+ * <p>
+ * The exception may occur when the amount of items feeded to a random sampling algorithm exceeds the maximum allowed or
+ * when the internal state has overflown in a way that would otherwise cause the algorithm to behave inconsistently.
  * <p>
  * More specifically, this exception targets the methods
  * <ul>

diff --git a/src/main/java/gr/james/sampling/WeightedRandomSampling.java b/src/main/java/gr/james/sampling/WeightedRandomSampling.java
@@ -36,7 +36,7 @@ public interface WeightedRandomSampling<T> extends RandomSampling<T> {
      * @return this instance
      * @throws NullPointerException    if {@code item} is {@code null}
      * @throws IllegalWeightException  if {@code weight} is incompatible with the algorithm
-     * @throws StreamOverflowException if the amount of items feeded to this algorithm has reached the maximum allowed
+     * @throws StreamOverflowException if the internal state of the algorithm has overflown
      */
     WeightedRandomSampling<T> feed(T item, double weight);