Apache
/
commons-collections
mirror of https://github.com/apache/commons-collections.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix javadoc for IterableUtils: remove() is normally supported. 

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@1716538 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Thomas Neidhart 2015-11-25 20:27:49 +00:00
parent 3e7cefa2b1
commit a7cbb44991
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/main/java/org/apache/commons/collections4/IterableUtils.java
View File

@ -217,8 +217,8 @@ public class IterableUtils {
* provided comparator. If the comparator is null, natural ordering will be
* used.
* <p>
* The returned iterable's iterator supports {@code remove()} when the corresponding
* input iterator supports it.
* The returned iterable's iterator supports {@code remove()} when the
* corresponding input iterator supports it.
*
* @param <E> the element type
* @param comparator the comparator defining an ordering over the elements,
@ -247,7 +247,8 @@ public class IterableUtils {
* Returns a view of the given iterable that only contains elements matching
* the provided predicate.
* <p>
* The returned iterable's iterator does not support {@code remove()}.
* The returned iterable's iterator supports {@code remove()} when the
* corresponding input iterator supports it.
*
* @param <E> the element type
* @param iterable the iterable to filter, may not be null
@ -436,7 +437,9 @@ public class IterableUtils {
/**
* Returns a unique view of the given iterable.
* <p>
* The returned iterable's iterator does not support {@code remove()}.
* The returned iterable's iterator supports {@code remove()} when the
* corresponding input iterator supports it. Calling {@code remove()}
* will only remove a single element from the underlying iterator.
*
* @param <E> the element type
* @param iterable the iterable to use, may not be null