8317265: ListFormat::format specification could be made clearer regar…

…ding handling IllegalArgumentException. Reviewed-by: joehw
openjdk · Oct 3, 2023 · 1809b8c · 1809b8c · openjdk-notifier · Oct 3, 2023
1 parent cfabcbf
commit 1809b8c
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/java.base/share/classes/java/text/ListFormat.java b/src/java.base/share/classes/java/text/ListFormat.java
@@ -353,8 +353,8 @@ public String format(List<String> input) {
      * @return       the string buffer passed in as {@code toAppendTo},
      *               with formatted text appended
      * @throws    NullPointerException if {@code obj} or {@code toAppendTo} is null
-     * @throws    IllegalArgumentException if the given object cannot
-     *               be formatted
+     * @throws    IllegalArgumentException if {@code obj} is neither a {@code List}
+     *               nor an array of {@code Object}s, or its length is zero.
      */
     @Override
     public StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition pos) {