CLI-267: Add an addRequiredOption method to Options. Thanks to Ricardo Ribeiro. This also closes apache#7 from GitHub.

britter · britter · commit 5d1d96715b36 · 2016-07-27T18:40:21.000Z
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/cli/trunk@1754329 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -23,6 +23,9 @@
   <body>
 
     <release version="1.4" date="tba" description="tba">
+      <action type="add" dev="britter" issue="CLI-267" due-to="Ricardo Ribeiro">
+        Add an addRequiredOption method to Options
+      </action>
       <action type="fix" dev="britter" issue="CLI-266" due-to="Ravi Teja">
         HelpFormatter.setOptionComparator(null) doesn't display the values in inserted order
       </action>
diff --git a/src/main/java/org/apache/commons/cli/Options.java b/src/main/java/org/apache/commons/cli/Options.java
@@ -142,6 +142,25 @@ public Options addOption(String opt, String longOpt, boolean hasArg, String desc
         return this;
     }
 
+    /**
+     * Add an option that contains a short-name and a long-name.
+     * This option is set as required.
+     * It may be specified as requiring an argument.
+     *
+     * @param opt Short single-character name of the option.
+     * @param longOpt Long multi-character name of the option.
+     * @param hasArg flag signally if an argument is required after this option
+     * @param description Self-documenting description
+     * @return the resulting Options instance
+     */
+    public Options addRequiredOption(String opt, String longOpt, boolean hasArg, String description)
+    {
+        Option option = new Option(opt, longOpt, hasArg, description);
+        option.setRequired(true);
+        addOption(option);
+        return this;
+    }
+
     /**
      * Adds an option instance
      *
