Add missing Javadoc for Iterate.getOnly()

eclipse · Jul 1, 2023 · bc1e763 · bc1e763
1 parent 8d93d2e
commit bc1e763
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/eclipse-collections/src/main/java/org/eclipse/collections/impl/utility/Iterate.java b/eclipse-collections/src/main/java/org/eclipse/collections/impl/utility/Iterate.java
@@ -3110,6 +3110,11 @@ public static <T> T max(Iterable<T> iterable)
         return Iterate.max(iterable, Comparators.naturalOrder());
     }
 
+    /**
+     * Returns the only element of a collection.
+     *
+     * @throws IllegalArgumentException if the Collection is null, empty, or has more than one element.
+     */
     public static <T> T getOnly(Iterable<T> iterable)
     {
         if (iterable != null)