This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-collections.git
The following commit(s) were added to refs/heads/master by this push:
new 38ecfdc19 Javadoc
38ecfdc19 is described below
commit 38ecfdc1973859e08bf6ee4f1f9d780f3699449e
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Oct 19 08:52:27 2024 -0400
Javadoc
---
.../org/apache/commons/collections4/IterableUtils.java | 15 ++++++---------
1 file changed, 6 insertions(+), 9 deletions(-)
diff --git a/src/main/java/org/apache/commons/collections4/IterableUtils.java
b/src/main/java/org/apache/commons/collections4/IterableUtils.java
index 1ae16993d..109f5669e 100644
--- a/src/main/java/org/apache/commons/collections4/IterableUtils.java
+++ b/src/main/java/org/apache/commons/collections4/IterableUtils.java
@@ -35,17 +35,14 @@ import
org.apache.commons.collections4.iterators.UniqueFilterIterator;
/**
* Provides utility methods and decorators for {@link Iterable} instances.
* <p>
- * <b>Note</b>: this util class has been designed for fail-fast argument
checking.
+ * <b>Note</b>: This utility class has been designed with fail-fast argument
checking.
* </p>
* <ul>
- * <li>
- * all decorator methods are <b>NOT</b> null-safe wrt the provided Iterable
argument, i.e.
- * they will throw a {@link NullPointerException} if a null Iterable is passed
as argument.
- * <li>
- * all other utility methods are null-safe wrt the provided Iterable argument,
i.e. they will
- * treat a null Iterable the same way as an empty one. Other arguments which
are null,
- * e.g. a {@link Predicate}, will result in a {@link NullPointerException}.
Exception: passing
- * a null {@link Comparator} is equivalent to a Comparator with natural
ordering.
+ * <li>All decorator methods are <em>not</em> null-safe for the provided
Iterable argument; for example, they will throw a {@link NullPointerException}
if a
+ * null Iterable is passed as argument.
+ * <li>All other utility methods are null-safe for the provided Iterable
argument; for example, they will treat a null Iterable the same way as an empty
one.
+ * For other arguments which are null, a {@link Predicate} will result in a
{@link NullPointerException}. Exception: passing a null {@link Comparator} is
+ * equivalent to a Comparator with natural ordering.
* </ul>
*
* @since 4.1
