Merge branch 'master' into release

Author: garydgregory

pom.xml

@@ -74,7 +74,7 @@
     <commons.release.next>1.8.1</commons.release.next>
     <commons.release.name>commons-cli-${commons.release.version}</commons.release.name>
     <commons.release.isDistModule>true</commons.release.isDistModule>
-    <commons.rc.version>RC1</commons.rc.version>
+    <commons.rc.version>RC2</commons.rc.version>
     <commons.bc.version>1.7.0</commons.bc.version>
     <commons.osgi.symbolicName>org.apache.commons.cli</commons.osgi.symbolicName>
     <commons.jira.id>CLI</commons.jira.id>

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

@@ -449,7 +449,7 @@ private void handleProperties(final Properties properties) throws ParseException
                 final String value = properties.getProperty(option);
 
                 if (opt.hasArg()) {
-                    if (opt.getValues() == null || opt.getValues().length == 0) {
+                    if (Util.isEmpty(opt.getValues())) {
                         opt.processValue(stripLeadingAndTrailingQuotesDefaultOff(value));
                     }
                 } else if (!("yes".equalsIgnoreCase(value) || "true".equalsIgnoreCase(value) || "1".equalsIgnoreCase(value))) {

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

@@ -30,7 +30,7 @@ Licensed to the Apache Software Foundation (ASF) under one or more
 import java.util.Iterator;
 import java.util.List;
 import java.util.Objects;
-import java.util.function.BiFunction;
+import java.util.function.Function;
 import java.util.function.Supplier;
 
 /**
@@ -78,12 +78,12 @@ public static final class Builder implements Supplier<HelpFormatter> {
         /**
          * A function to convert a description (not null) and a deprecated Option (not null) to help description
          */
-        private static final BiFunction<String, Option, String> DEFAULT_DEPRECATED_FORMAT = (d, o) -> "[Deprecated] " + d;
+        private static final Function<Option, String> DEFAULT_DEPRECATED_FORMAT = o -> "[Deprecated] " + getDescription(o);
 
         /**
          * Formatter for deprecated options.
          */
-        private BiFunction<String, Option, String> deprecatedFormatFunc = DEFAULT_DEPRECATED_FORMAT;
+        private Function<Option, String> deprecatedFormatFunc = DEFAULT_DEPRECATED_FORMAT;
 
         /**
          * The output PrintWriter, defaults to wrapping {@link System#out}.
@@ -109,23 +109,23 @@ public Builder setPrintWriter(final PrintWriter printWriter) {
         /**
          * Sets whether to show deprecated options.
          *
-         * @param showDeprecatedFunc Specify the format for the deprecated options.
+         * @param useDefaultFormat if {@code true} use the default format, otherwise clear the formatter.
          * @return this.
-         * @since 1.8.0
          */
-        public Builder setShowDeprecated(final BiFunction<String, Option, String> showDeprecatedFunc) {
-            this.deprecatedFormatFunc = showDeprecatedFunc;
-            return this;
+        public Builder setShowDeprecated(final boolean useDefaultFormat) {
+            return setShowDeprecated(useDefaultFormat ? DEFAULT_DEPRECATED_FORMAT : null);
         }
 
         /**
          * Sets whether to show deprecated options.
          *
-         * @param useDefaultFormat if {@code true} use the default format, otherwise clear the formatter.
+         * @param showDeprecatedFunc Specify the format for the deprecated options.
          * @return this.
+         * @since 1.8.0
          */
-        public Builder setShowDeprecated(final boolean useDefaultFormat) {
-            return setShowDeprecated(useDefaultFormat ? DEFAULT_DEPRECATED_FORMAT : null);
+        public Builder setShowDeprecated(final Function<Option, String> showDeprecatedFunc) {
+            this.deprecatedFormatFunc = showDeprecatedFunc;
+            return this;
         }
     }
 
@@ -151,7 +151,6 @@ public int compare(final Option opt1, final Option opt2) {
             return opt1.getKey().compareToIgnoreCase(opt2.getKey());
         }
     }
-
     /** Default number of characters per line */
     public static final int DEFAULT_WIDTH = 74;
 
@@ -194,6 +193,17 @@ private static PrintWriter createDefaultPrintWriter() {
         return new PrintWriter(System.out);
     }
 
+    /**
+     * Gets the option description or an empty string if the description is {@code null}.
+     * @param option The option to get the description from.
+     * @return the option description or an empty string if the description is {@code null}.
+     * @since 1.8.0
+     */
+    public static String getDescription(final Option option) {
+        final String desc = option.getDescription();
+        return desc == null ? "" : desc;
+    }
+
     /**
      * Number of characters per line
      *
@@ -266,9 +276,9 @@ private static PrintWriter createDefaultPrintWriter() {
     protected Comparator<Option> optionComparator = new OptionComparator();
 
     /**
-     * BiFunction to format the description for a deprecated option.
+     * Function to format the description for a deprecated option.
      */
-    private final BiFunction<String, Option, String> deprecatedFormatFunc;
+    private final Function<Option, String> deprecatedFormatFunc;
 
     /**
      * Where to print help.
@@ -291,7 +301,7 @@ public HelpFormatter() {
      * Constructs a new instance.
      * @param printStream TODO
      */
-    private HelpFormatter(final BiFunction<String, Option, String> deprecatedFormatFunc, final PrintWriter printStream) {
+    private HelpFormatter(final Function<Option, String> deprecatedFormatFunc, final PrintWriter printStream) {
         // TODO All other instance HelpFormatter instance variables.
         // Make HelpFormatter immutable for 2.0
         this.deprecatedFormatFunc = deprecatedFormatFunc;
@@ -570,7 +580,7 @@ public void printHelp(final PrintWriter pw, final int width, final String cmdLin
      */
     public void printHelp(final PrintWriter pw, final int width, final String cmdLineSyntax, final String header, final Options options, final int leftPad,
         final int descPad, final String footer, final boolean autoUsage) {
-        if (cmdLineSyntax == null || cmdLineSyntax.isEmpty()) {
+        if (Util.isEmpty(cmdLineSyntax)) {
             throw new IllegalArgumentException("cmdLineSyntax not provided");
         }
         if (autoUsage) {
@@ -795,7 +805,7 @@ protected StringBuffer renderOptions(final StringBuffer sb, final int width, fin
             optBuf.append(dpad);
             final int nextLineTabStop = max + descPad;
             if (deprecatedFormatFunc != null && option.isDeprecated()) {
-                optBuf.append(deprecatedFormatFunc.apply(option.getDescription() == null ? "" : option.getDescription(), option).trim());
+                optBuf.append(deprecatedFormatFunc.apply(option).trim());
             } else if (option.getDescription() != null) {
                 optBuf.append(option.getDescription());
             }
@@ -881,7 +891,7 @@ private Appendable renderWrappedTextBlock(final StringBuffer sb, final int width
      * @return The String of without the trailing padding
      */
     protected String rtrim(final String s) {
-        if (s == null || s.isEmpty()) {
+        if (Util.isEmpty(s)) {
             return s;
         }
         int pos = s.length();

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

@@ -684,7 +684,6 @@ public String getValue(final int index) throws IndexOutOfBoundsException {
      */
     public String getValue(final String defaultValue) {
         final String value = getValue();
-
         return value != null ? value : defaultValue;
     }
 

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

@@ -278,7 +278,7 @@ protected void processProperties(final Properties properties) throws ParseExcept
                 // get the value from the properties instance
                 final String value = properties.getProperty(option);
                 if (opt.hasArg()) {
-                    if (opt.getValues() == null || opt.getValues().length == 0) {
+                    if (Util.isEmpty(opt.getValues())) {
                         try {
                             opt.processValue(value);
                         } catch (final RuntimeException exp) { // NOPMD

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

@@ -27,13 +27,23 @@ final class Util {
      */
     static final String[] EMPTY_STRING_ARRAY = {};
 
+    /**
+     * Tests whether the given array is null or empty.
+     *
+     * @param array the array to test.
+     * @return the given array is null or empty.
+     */
+    static boolean isEmpty(final Object[] array) {
+        return array == null || array.length == 0;
+    }
+
     /**
      * Tests whether the given string is null or empty.
      *
      * @param str The string to test.
      * @return Whether the given string is null or empty.
      */
-    private static boolean isEmpty(final String str) {
+    static boolean isEmpty(final String str) {
         return str == null || str.isEmpty();
     }