fixed javadocs and catch(Throwable) issues

Author: Claudenw

src/main/java/org/apache/commons/cli/CommandLine.java

@@ -506,7 +506,7 @@ public String[] getOptionValues(final String opt) {
      *
      * @param opt the name of the option.
      * @param <T> The return type for the method.
-     * @return the value parsed into a particular object.
+     * @return the value parsed into a particular object or null if the option is not set.
      * @throws ParseException if there are problems turning the option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.5.0
@@ -521,7 +521,7 @@ public <T> T getParsedOptionValue(final char opt) throws ParseException {
      * @param opt the name of the option.
      * @param defaultValue the default value to return if opt is not set.
      * @param <T> The return type for the method.
-     * @return the value parsed into a particular object.
+     * @return the value parsed into a particular object or the defaultValue if the option is not set.
      * @throws ParseException if there are problems turning the option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.7.0
@@ -536,7 +536,7 @@ public <T> T getParsedOptionValue(final char opt, final Supplier<T> defaultValue
      * @param opt the name of the option.
      * @param defaultValue the default value to return if opt is not set.
      * @param <T> The return type for the method.
-     * @return the value parsed into a particular object.
+     * @return the value parsed into a particular object or the defaultValue if the option is not set.
      * @throws ParseException if there are problems turning the option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.7.0
@@ -550,7 +550,7 @@ public <T> T getParsedOptionValue(final char opt, final T defaultValue) throws P
      *
      * @param option the option.
      * @param <T> The return type for the method.
-     * @return the value parsed into a particular object.
+     * @return the value parsed into a particular object or null if the option is not set.
      * @throws ParseException if there are problems turning the option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.5.0
@@ -565,7 +565,7 @@ public <T> T getParsedOptionValue(final Option option) throws ParseException {
      * @param option the option.
      * @param defaultValue the default value to return if opt is not set.
      * @param <T> The return type for the method.
-     * @return the value parsed into a particular object.
+     * @return the value parsed into a particular object or the defaultValue if the option is not set.
      * @throws ParseException if there are problems turning the option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.7.0
@@ -581,8 +581,13 @@ public <T> T getParsedOptionValue(final Option option, final Supplier<T> default
                 return get(defaultValue);
             }
             return (T) option.getConverter().apply(res);
-        } catch (final Throwable e) {
-            throw ParseException.wrap(e);
+        } catch (final Error t) {
+            throw t;
+        } catch (final Exception t) {
+            throw ParseException.wrap(t);
+        } catch (final Throwable t) {
+            // this should not be reached.
+            throw new RuntimeException(t);
         }
     }
 
@@ -592,7 +597,7 @@ public <T> T getParsedOptionValue(final Option option, final Supplier<T> default
      * @param option the option.
      * @param defaultValue the default value to return if opt is not set.
      * @param <T> The return type for the method.
-     * @return the value parsed into a particular object.
+     * @return the value parsed into a particular object or the defaultValue if the option is not set.
      * @throws ParseException if there are problems turning the option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.7.0
@@ -606,7 +611,7 @@ public <T> T getParsedOptionValue(final Option option, final T defaultValue) thr
      *
      * @param optionGroup the option group.
      * @param <T> The return type for the method.
-     * @return the value parsed into a particular object.
+     * @return the value parsed into a particular object or null if no option in the OptionGroup is set.
      * @throws ParseException if there are problems turning the selected option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.9.0
@@ -621,7 +626,7 @@ public <T> T getParsedOptionValue(final OptionGroup optionGroup) throws ParseExc
      * @param optionGroup the option group.
      * @param defaultValue the default value to return if opt is not set.
      * @param <T> The return type for the method.
-     * @return the value parsed into a particular object.
+     * @return the value parsed into a particular object or the defaultValue if no option in the OptionGroup is set.
      * @throws ParseException if there are problems turning the selected option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.9.0
@@ -639,7 +644,7 @@ public <T> T getParsedOptionValue(final OptionGroup optionGroup, final Supplier<
      * @param optionGroup the option group.
      * @param defaultValue the default value to return if an option is not selected.
      * @param <T> The return type for the method.
-     * @return the value parsed into a particular object.
+     * @return the value parsed into a particular object or the defaultValue if no option in the OptionGroup is set.
      * @throws ParseException if there are problems turning the option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.9.0
@@ -653,7 +658,7 @@ public <T> T getParsedOptionValue(final OptionGroup optionGroup, final T default
      *
      * @param opt the name of the option.
      * @param <T> The return type for the method.
-     * @return the value parsed into a particular object.
+     * @return the value parsed into a particular object or null if the option is not set.
      * @throws ParseException if there are problems turning the option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.2
@@ -668,7 +673,7 @@ public <T> T getParsedOptionValue(final String opt) throws ParseException {
      * @param opt the name of the option.
      * @param defaultValue the default value to return if opt is not set.
      * @param <T> The return type for the method.
-     * @return the value parsed into a particular object.
+     * @return the value parsed into a particular object or the defaultValue if the option is not set.
      * @throws ParseException if there are problems turning the option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.7.0
@@ -683,7 +688,7 @@ public <T> T getParsedOptionValue(final String opt, final Supplier<T> defaultVal
      * @param opt the name of the option.
      * @param defaultValue the default value to return if opt is not set.
      * @param <T> The return type for the method.
-     * @return the value parsed into a particular object.
+     * @return the value parsed into a particular object or the defaultValue if the option is not set.
      * @throws ParseException if there are problems turning the option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.7.0
@@ -697,7 +702,7 @@ public <T> T getParsedOptionValue(final String opt, final T defaultValue) throws
      *
      * @param opt the name of the option.
      * @param <T> The array type for the return value.
-     * @return the values parsed into an array of objects.
+     * @return the values parsed into an array of objects or null if the option is not set.
      * @throws ParseException if there are problems turning the option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.10.0
@@ -712,7 +717,7 @@ public <T> T[] getParsedOptionValues(final char opt) throws ParseException {
      * @param opt the name of the option.
      * @param defaultValue the default value to return if opt is not set.
      * @param <T> The array type for the return value.
-     * @return the values parsed into an array of objects.
+     * @return the values parsed into an array of objects or the defaultValue if the option is not set.
      * @throws ParseException if there are problems turning the option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.10.0
@@ -727,7 +732,7 @@ public <T> T[] getParsedOptionValues(final char opt, final Supplier<T[]> default
      * @param opt the name of the option.
      * @param defaultValue the default value to return if opt is not set.
      * @param <T> The array type for the return value.
-     * @return the values parsed into an array of objects.
+     * @return the values parsed into an array of objects or the defaultValue if the option is not set.
      * @throws ParseException if there are problems turning the option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.10.0
@@ -741,7 +746,7 @@ public <T> T[] getParsedOptionValues(final char opt, final T[] defaultValue) thr
      *
      * @param option the option.
      * @param <T> The array type for the return value.
-     * @return the values parsed into an array of objects.
+     * @return the values parsed into an array of objects or null if the option is not set.
      * @throws ParseException if there are problems turning the option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.10.0
@@ -756,7 +761,7 @@ public <T> T[] getParsedOptionValues(final Option option) throws ParseException
      * @param option the option.
      * @param defaultValue the default value to return if opt is not set.
      * @param <T> The array type for the return value.
-     * @return the values parsed into an array of objects.
+     * @return the values parsed into an array of objects or the defaultValue if the option is not set.
      * @throws ParseException if there are problems turning the option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.10.0
@@ -777,10 +782,14 @@ public <T> T[] getParsedOptionValues(final Option option, final Supplier<T[]> de
                 result[i] = clazz.cast(option.getConverter().apply(values[i]));
             }
             return result;
-        } catch (Throwable t) {
+        } catch (final Error t) {
+            throw t;
+        } catch (final Exception t) {
             throw ParseException.wrap(t);
+        }  catch (final Throwable t) {
+            // this should not be reached.
+            throw new RuntimeException(t);
         }
-
     }
 
     /**
@@ -789,7 +798,7 @@ public <T> T[] getParsedOptionValues(final Option option, final Supplier<T[]> de
      * @param option the option.
      * @param defaultValue the default value to return if opt is not set.
      * @param <T> The array type for the return value.
-     * @return the values parsed into an array of objects.
+     * @return the values parsed into an array of objects or the defaultValue if the option is not set.
      * @throws ParseException if there are problems turning the option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.10.0
@@ -803,7 +812,7 @@ public <T> T[] getParsedOptionValues(final Option option, final T[] defaultValue
      *
      * @param optionGroup the option group.
      * @param <T> The array type for the return value.
-     * @return the values parsed into an array of objects.
+     * @return the values parsed into an array of objects or null if no option in the OptionGroup is set.
      * @throws ParseException if there are problems turning the selected option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.10.0
@@ -818,7 +827,7 @@ public <T> T[] getParsedOptionValues(final OptionGroup optionGroup) throws Parse
      * @param optionGroup the option group.
      * @param defaultValue the default value to return if opt is not set.
      * @param <T> The array type for the return value.
-     * @return the values parsed into an array of objects.
+     * @return the values parsed into an array of objects or null if no option in the OptionGroup is set.
      * @throws ParseException if there are problems turning the selected option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.10.0
@@ -836,7 +845,7 @@ public <T> T[] getParsedOptionValues(final OptionGroup optionGroup, final Suppli
      * @param optionGroup the option group.
      * @param defaultValue the default value to return if an option is not selected.
      * @param <T> The array type for the return value.
-     * @return the values parsed into an array of objects.
+     * @return the values parsed into an array of objects or null if no option in the OptionGroup is set.
      * @throws ParseException if there are problems turning the option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.10.0
@@ -850,7 +859,7 @@ public <T> T[] getParsedOptionValues(final OptionGroup optionGroup, final T[] de
      *
      * @param opt the name of the option.
      * @param <T> The array type for the return value.
-     * @return the values parsed into an array of objects.
+     * @return the values parsed into an array of objects or null if the option is not set.
      * @throws ParseException if there are problems turning the option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.10.0
@@ -865,7 +874,7 @@ public <T> T[] getParsedOptionValues(final String opt) throws ParseException {
      * @param opt the name of the option.
      * @param defaultValue the default value to return if opt is not set.
      * @param <T> The array type for the return value.
-     * @return the values parsed into an array of objects.
+     * @return the values parsed into an array of objects or defaultValues if the option is not set.
      * @throws ParseException if there are problems turning the option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.10.0
@@ -880,7 +889,7 @@ public <T> T[] getParsedOptionValues(final String opt, final Supplier<T[]> defau
      * @param opt the name of the option.
      * @param defaultValue the default value to return if opt is not set.
      * @param <T> The array type for the return value.
-     * @return the values parsed into an array of objects.
+     * @return the values parsed into an array of objects or defaultValues if the option is not set.
      * @throws ParseException if there are problems turning the option value into the desired type
      * @see PatternOptionBuilder
      * @since 1.10.0

src/main/java/org/apache/commons/cli/Option.java

@@ -713,9 +713,9 @@ public String getValue(final String defaultValue) {
     }
 
     /**
-     * Gets the values of this Option as a String array or null if there are no values.
+     * Gets the values of this Option as a String array or an empty array if there are no values.
      *
-     * @return the values of this Option as a String array or null if there are no values.
+     * @return the values of this Option as a String array or an empty array if there are no values.
      */
     public String[] getValues() {
         return hasNoValues() ? null : values.toArray(EMPTY_STRING_ARRAY);
@@ -731,9 +731,9 @@ public char getValueSeparator() {
     }
 
     /**
-     * Gets the values of this Option as a List or null if there are no values.
+     * Gets the values of this Option as a List.  Will return an empty list if there are no values.
      *
-     * @return the values of this Option as a List or null if there are no values.
+     * @return the values of this Option as a List or an empty List if there are no values.
      */
     public List<String> getValuesList() {
         return values;