Skip to content

Commit

Permalink
Fix for CLI-340 (#334)
Browse files Browse the repository at this point in the history 
* Fix for CLI-340

* removed unused import

* fixed javadocs and catch(Throwable) issues

* rebased and fixed catch issue

* Remove extra whitespace

---------

Co-authored-by: Gary Gregory <[email protected]>
  • Loading branch information
@Claudenw @garydgregory
Claudenw and garydgregory authored Nov 29, 2024
1 parent d9f575d commit 764c148
Show file tree
Hide file tree
Showing 4 changed files with 340 additions and 25 deletions.
221 changes: 209 additions & 12 deletions src/main/java/org/apache/commons/cli/CommandLine.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Licensed to the Apache Software Foundation (ASF) under one or more
package org.apache.commons.cli;

import java.io.Serializable;
import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.LinkedList;
Expand Down Expand Up @@ -503,7 +504,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
Expand All @@ -518,7 +519,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
Expand All @@ -533,7 +534,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
Expand All @@ -547,7 +548,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
Expand All @@ -562,7 +563,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
Expand All @@ -589,7 +590,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
Expand All @@ -603,7 +604,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
Expand All @@ -618,7 +619,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
Expand All @@ -636,7 +637,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
Expand All @@ -650,7 +651,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
Expand All @@ -665,7 +666,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
Expand All @@ -680,7 +681,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
Expand All @@ -689,6 +690,202 @@ public <T> T getParsedOptionValue(final String opt, final T defaultValue) throws
return getParsedOptionValue(resolveOption(opt), defaultValue);
}

/**
* Gets a version of this {@code Option} converted to an array of a particular type.
*
* @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 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
*/
public <T> T[] getParsedOptionValues(final char opt) throws ParseException {
return getParsedOptionValues(String.valueOf(opt));
}

/**
* Gets a version of this {@code Option} converted to an array of a particular type.
*
* @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 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
*/
public <T> T[] getParsedOptionValues(final char opt, final Supplier<T[]> defaultValue) throws ParseException {
return getParsedOptionValues(String.valueOf(opt), defaultValue);
}

/**
* Gets a version of this {@code Option} converted to an array of a particular type.
*
* @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 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
*/
public <T> T[] getParsedOptionValues(final char opt, final T[] defaultValue) throws ParseException {
return getParsedOptionValues(String.valueOf(opt), defaultValue);
}

/**
* Gets a version of this {@code Option} converted to an array of a particular type.
*
* @param option the option.
* @param <T> The array type for the return value.
* @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
*/
public <T> T[] getParsedOptionValues(final Option option) throws ParseException {
return getParsedOptionValues(option, () -> null);
}

/**
* Gets a version of this {@code Option} converted to an array of a particular type.
*
* @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 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
*/
@SuppressWarnings("unchecked")
public <T> T[] getParsedOptionValues(final Option option, final Supplier<T[]> defaultValue) throws ParseException {
if (option == null) {
return get(defaultValue);
}
Class<? extends T> clazz = (Class<? extends T>) option.getType();
String[] values = getOptionValues(option);
if (values == null) {
return get(defaultValue);
}
T[] result = (T[]) Array.newInstance(clazz, values.length);
try {
for (int i = 0; i < values.length; i++) {
result[i] = clazz.cast(option.getConverter().apply(values[i]));
}
return result;
} catch (final Exception t) {
throw ParseException.wrap(t);
}
}

/**
* Gets a version of this {@code Option} converted to an array of a particular type.
*
* @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 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
*/
public <T> T[] getParsedOptionValues(final Option option, final T[] defaultValue) throws ParseException {
return getParsedOptionValues(option, () -> defaultValue);
}

/**
* Gets a version of this {@code OptionGroup} converted to an array of a particular type.
*
* @param optionGroup the option group.
* @param <T> The array type for the return value.
* @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
*/
public <T> T[] getParsedOptionValues(final OptionGroup optionGroup) throws ParseException {
return getParsedOptionValues(optionGroup, () -> null);
}

/**
* Gets a version of this {@code OptionGroup} converted to an array of a particular type.
*
* @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 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
*/
public <T> T[] getParsedOptionValues(final OptionGroup optionGroup, final Supplier<T[]> defaultValue) throws ParseException {
if (optionGroup == null || !optionGroup.isSelected()) {
return get(defaultValue);
}
return getParsedOptionValues(optionGroup.getSelected(), defaultValue);
}

/**
* Gets a version of this {@code OptionGroup} converted to an array of a particular type.
*
* @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 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
*/
public <T> T[] getParsedOptionValues(final OptionGroup optionGroup, final T[] defaultValue) throws ParseException {
return getParsedOptionValues(optionGroup, () -> defaultValue);
}

/**
* Gets a version of this {@code Option} converted to an array of a particular type.
*
* @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 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
*/
public <T> T[] getParsedOptionValues(final String opt) throws ParseException {
return getParsedOptionValues(resolveOption(opt));
}

/**
* Gets a version of this {@code Option} converted to an array of a particular type.
*
* @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 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
*/
public <T> T[] getParsedOptionValues(final String opt, final Supplier<T[]> defaultValue) throws ParseException {
return getParsedOptionValues(resolveOption(opt), defaultValue);
}

/**
* Gets a version of this {@code Option} converted to an array of a particular type.
*
* @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 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
*/
public <T> T[] getParsedOptionValues(final String opt, final T[] defaultValue) throws ParseException {
return getParsedOptionValues(resolveOption(opt), defaultValue);
}

/**
* Handles deprecated options.
*
Expand Down
8 changes: 4 additions & 4 deletions src/main/java/org/apache/commons/cli/Option.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -707,9 +707,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);
Expand All @@ -725,9 +725,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;
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/apache/commons/cli/help/HelpFormatter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ protected HelpFormatter(final Builder builder) {
*/
@Override
public TableDefinition getTableDefinition(final Iterable<Option> options) {
// set up the base TextStyle for the columns configured for the Option opt and arg values..
// set up the base TextStyle for the columns configured for the Option opt and arg values.
final TextStyle.Builder builder = TextStyle.builder().setAlignment(TextStyle.Alignment.LEFT).setIndent(DEFAULT_LEFT_PAD).setScalable(false);
final List<TextStyle> styles = new ArrayList<>();
styles.add(builder.get());
Expand Down
Loading

0 comments on commit 764c148

Please sign in to comment.