Clarify that returned uniqueSet only supports removal operations.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@1688313 13f79535-47bb-0310-9956-ffa450edef68
2015-06-29 21:31:56 +00:00 · 2015-06-29 21:31:56 +00:00 · 92406348db
parent 0db8c22eb1
commit 92406348db
1 changed files with 3 additions and 1 deletions
--- a/src/main/java/org/apache/commons/collections4/MultiSet.java
+++ b/src/main/java/org/apache/commons/collections4/MultiSet.java
@ -122,7 +122,9 @@ public interface MultiSet<E> extends Collection<E> {
     * Uniqueness constraints are the same as those in {@link java.util.Set}.
     * <p>
     * The returned set is backed by this multiset, so any change to either
-     * is immediately reflected in the other.
+     * is immediately reflected in the other. Only removal operations are
+     * supporting, in which case all occurrences of the removed elements
+     * are removed from the backing multiset.
     *
     * @return the Set of unique MultiSet elements
     */