CommandLine.Builder implements Supplier<CommandLine>

Author: garydgregory

src/changes/changes.xml

@@ -25,7 +25,8 @@
     <release version="1.9.1" date="YYYY-MM-DD" description="This is a feature and maintenance release. Java 8 or later is required.">
       <!-- FIX -->
       <!-- ADD -->
-      <action type="add" issue="CLI-339" dev="ggregory" due-to="Claude Warren, Gary Gregory">Help formatter extension #314.</action>
+      <action type="add" issue="CLI-339" dev="ggregory" due-to="Claude Warren, Gary Gregory">Help formatter extension in the new package #314.</action>
+      <action type="add" dev="ggregory" due-to="Gary Gregory">CommandLine.Builder implements Supplier&lt;CommandLine&gt;.</action>
       <!-- UPDATE -->
       <action type="update" dev="ggregory" due-to="Gary Gregory, Dependabot">Bump org.apache.commons:commons-parent from 72 to 77 #302, #304, #310, #315, #320.</action>
       <action type="update" dev="ggregory" due-to="Gary Gregory, Dependabot">Bump commons-io:commons-io from 2.16.1 to 2.17.0 #309.</action>

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

@@ -44,7 +44,7 @@ public class CommandLine implements Serializable {
      *
      * @since 1.4
      */
-    public static final class Builder {
+    public static final class Builder implements Supplier<CommandLine> {
 
         /**
          * Prints an Option to {@link System#out}.
@@ -91,11 +91,24 @@ public Builder addOption(final Option opt) {
         }
 
         /**
-         * Creates the new instance.
+         * Creates a new instance.
          *
-         * @return the new instance.
+         * @return a new instance.
+         * @deprecated Use {@link #get()}.
          */
+        @Deprecated
         public CommandLine build() {
+            return get();
+        }
+
+        /**
+         * Creates a new instance.
+         *
+         * @return a new instance.
+         * @since 1.10.0
+         */
+        @Override
+        public CommandLine get() {
             return new CommandLine(args, options, deprecatedHandler);
         }
 

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

@@ -710,7 +710,7 @@ public CommandLine parse(final Options options, final String[] arguments, final
         for (final OptionGroup group : options.getOptionGroups()) {
             group.setSelected(null);
         }
-        cmd = CommandLine.builder().setDeprecatedHandler(deprecatedHandler).build();
+        cmd = CommandLine.builder().setDeprecatedHandler(deprecatedHandler).get();
         if (arguments != null) {
             for (final String argument : arguments) {
                 handleToken(argument);

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

@@ -149,7 +149,7 @@ public CommandLine parse(final Options options, final String[] arguments, final
         }
         // initialize members
         setOptions(options);
-        cmd = CommandLine.builder().build();
+        cmd = CommandLine.builder().get();
         boolean eatTheRest = false;
         final List<String> tokenList = Arrays.asList(flatten(getOptions(), arguments == null ? new String[0] : arguments, stopAtNonOption));
         final ListIterator<String> iterator = tokenList.listIterator();

src/test/java/org/apache/commons/cli/CommandLineTest.java

@@ -218,12 +218,22 @@ public void testBadGetParsedOptionValue() throws Exception {
     }
 
     @Test
-    public void testBuilder() {
+    public void testBuilderBuild() {
         final CommandLine.Builder builder = new CommandLine.Builder();
         builder.addArg("foo").addArg("bar");
         builder.addOption(Option.builder("T").build());
         final CommandLine cmd = builder.build();
+        assertEquals("foo", cmd.getArgs()[0]);
+        assertEquals("bar", cmd.getArgList().get(1));
+        assertEquals("T", cmd.getOptions()[0].getOpt());
+    }
 
+    @Test
+    public void testBuilderGet() {
+        final CommandLine.Builder builder = new CommandLine.Builder();
+        builder.addArg("foo").addArg("bar");
+        builder.addOption(Option.builder("T").build());
+        final CommandLine cmd = builder.get();
         assertEquals("foo", cmd.getArgs()[0]);
         assertEquals("bar", cmd.getArgList().get(1));
         assertEquals("T", cmd.getOptions()[0].getOpt());