Deprecate CommandLine.Builder() in favor of CommandLine.builder()

garydgregory · garydgregory · commit af7abb3586c4 · 2024-10-17T11:18:49.000-04:00
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -24,6 +24,7 @@
   <body>
     <release version="1.9.1" date="YYYY-MM-DD" description="This is a feature and maintenance release. Java 8 or later is required.">
       <!-- FIX -->
+      <action type="add" issue="CLI-339" dev="ggregory" due-to="Gary Gregory">Deprecate CommandLine.Builder() in favor of CommandLine.builder().</action>
       <!-- ADD -->
       <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>
diff --git a/src/main/java/org/apache/commons/cli/CommandLine.java b/src/main/java/org/apache/commons/cli/CommandLine.java
@@ -62,6 +62,16 @@ public static final class Builder implements Supplier<CommandLine> {
          */
         private Consumer<Option> deprecatedHandler = DEPRECATED_HANDLER;
 
+        /**
+         * Constructs a new instance.
+         *
+         * @deprecated Use {@link #build()}.
+         */
+        @Deprecated
+        public Builder() {
+            // empty
+        }
+
         /**
          * Adds left-over unrecognized option/argument.
          *
diff --git a/src/test/java/org/apache/commons/cli/CommandLineTest.java b/src/test/java/org/apache/commons/cli/CommandLineTest.java
@@ -219,29 +219,35 @@ public void testBadGetParsedOptionValue() throws Exception {
 
     @Test
     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();
+        // @formatter:off
+        final CommandLine cmd = CommandLine.builder()
+                .addArg("foo")
+                .addArg("bar")
+                .addOption(Option.builder("T").build())
+                .build();
+        // @formatter:on
         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();
+        // @formatter:off
+        final CommandLine cmd = CommandLine.builder()
+                .addArg("foo")
+                .addArg("bar")
+                .addOption(Option.builder("T").build())
+                .get();
+        // @formatter:on
         assertEquals("foo", cmd.getArgs()[0]);
         assertEquals("bar", cmd.getArgList().get(1));
         assertEquals("T", cmd.getOptions()[0].getOpt());
     }
 
     @Test
     public void testBuilderNullArgs() {
-        final CommandLine.Builder builder = new CommandLine.Builder();
+        final CommandLine.Builder builder = CommandLine.builder();
         builder.addArg(null).addArg(null);
         builder.addOption(Option.builder("T").build());
         final CommandLine cmd = builder.build();
@@ -252,7 +258,7 @@ public void testBuilderNullArgs() {
 
     @Test
     public void testBuilderNullOption() {
-        final CommandLine.Builder builder = new CommandLine.Builder();
+        final CommandLine.Builder builder = CommandLine.builder();
         builder.addArg("foo").addArg("bar");
         builder.addOption(null);
         builder.addOption(null);
