Specify iterator exhaustion on RandomSampling.feed(Iterator)

motinis · Jul 1, 2018 · 3335a0f · 3335a0f
1 parent 8bd0245
commit 3335a0f
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/main/java/gr/james/sampling/RandomSampling.java b/src/main/java/gr/james/sampling/RandomSampling.java
@@ -56,6 +56,8 @@ public interface RandomSampling<T> {
      *     feed(items.next());
      * }
      * </code></pre>
+     * <p>
+     * After this method returns, the {@code items} iterator is left exhausted.
      *
      * @param items the items to feed to the algorithm
      * @return {@code true} if the sample was modified as a result of this operation