You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2024/10/20 12:55:38 UTC

(commons-collections) branch master updated: [COLLECTIONS-815] Update ClosureUtils Javadoc to match runtime

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 589e18eb2 [COLLECTIONS-815] Update ClosureUtils Javadoc to match runtime
589e18eb2 is described below

commit 589e18eb2f3fe8641f7f1a31417bd763bbd7bdb6
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Oct 20 08:55:32 2024 -0400

    [COLLECTIONS-815] Update ClosureUtils Javadoc to match runtime
---
 src/changes/changes.xml                                         | 1 +
 src/main/java/org/apache/commons/collections4/ClosureUtils.java | 6 +-----
 2 files changed, 2 insertions(+), 5 deletions(-)

diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 29b26b57e..521b33ba5 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -41,6 +41,7 @@
     <action type="fix" dev="ggregory" due-to="Gary Gregory">Fix generics in IteratorChain.IteratorChain(Collection).</action>
     <action type="fix" dev="ggregory" due-to="Gary Gregory">Fix generics in org.apache.commons.collections4.IteratorUtils.chainedIterator(Collection).</action>
     <action type="fix" dev="ggregory" due-to="Benjamin Confino, Gary Gregory" issue="COLLECTIONS-856">Javadoc: Document interaction between peek and filter iterator #515.</action>
+    <action type="fix" dev="ggregory" due-to="Elia Bertolina, Gary Gregory" issue="COLLECTIONS-815">Javadoc: Update ClosureUtils Javadoc to match runtime.</action>
     <!-- ADD -->
     <action type="add" dev="ggregory" due-to="Gary Gregory">LayerManager.Builder implements Supplier.</action>
     <action type="add" dev="ggregory" due-to="Gary Gregory, hemanth0525">Add CollectionUtils.duplicateList(Collection).</action>
diff --git a/src/main/java/org/apache/commons/collections4/ClosureUtils.java b/src/main/java/org/apache/commons/collections4/ClosureUtils.java
index fe190eb86..0d541f13e 100644
--- a/src/main/java/org/apache/commons/collections4/ClosureUtils.java
+++ b/src/main/java/org/apache/commons/collections4/ClosureUtils.java
@@ -103,7 +103,6 @@ public class ClosureUtils {
      * @return the {@code chained} closure
      * @throws NullPointerException if the closures collection is null
      * @throws NullPointerException if any closure in the collection is null
-     * @throws IllegalArgumentException if the closures collection is empty
      */
     public static <E> Closure<E> chainedClosure(final Collection<? extends Closure<? super E>> closures) {
         return ChainedClosure.chainedClosure(closures);
@@ -130,10 +129,9 @@ public class ClosureUtils {
      * Gets a Closure that always throws an exception.
      * This could be useful during testing as a placeholder.
      *
-     * @see org.apache.commons.collections4.functors.ExceptionClosure
-     *
      * @param <E>  the type that the closure acts on
      * @return the closure
+     * @see ExceptionClosure
      */
     public static <E> Closure<E> exceptionClosure() {
         return ExceptionClosure.<E>exceptionClosure();
@@ -262,7 +260,6 @@ public class ClosureUtils {
      * @return the {@code switch} closure
      * @throws NullPointerException if the map is null
      * @throws NullPointerException if any closure in the map is null
-     * @throws IllegalArgumentException if the map is empty
      * @throws ClassCastException  if the map elements are of the wrong type
      */
     public static <E> Closure<E> switchClosure(final Map<Predicate<E>, Closure<E>> predicatesAndClosures) {
@@ -337,7 +334,6 @@ public class ClosureUtils {
      * @return the closure
      * @throws NullPointerException if the map is null
      * @throws NullPointerException if any closure in the map is null
-     * @throws IllegalArgumentException if the map is empty
      */
     @SuppressWarnings("unchecked")
     public static <E> Closure<E> switchMapClosure(final Map<? extends E, Closure<E>> objectsAndClosures) {