[CLI-230] Options.getRequiredOptions returns now an unmodifiable list.

netomi · netomi · commit 9ed70efb45a9 · 2013-02-11T19:52:22.000Z
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/cli/trunk@1444940 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.3" date="in SVN">
+      <action type="fix" dev="tn" issue="CLI-230">
+        Options.getRequiredOptions() now returns an unmodifiable list.
+      </action>
       <action type="add" dev="tn" issue="CLI-224" due-to="Duncan Jones, Brian Blount">
         Added new fluent API to create Option instances via builder class Option.Builder.
         This replaces the now deprecated OptionBuilder.
diff --git a/src/main/java/org/apache/commons/cli/Option.java b/src/main/java/org/apache/commons/cli/Option.java
@@ -27,8 +27,11 @@
  * if any exists, a flag indicating if an argument is required for
  * this option, and a self-documenting description of the option.
  * <p>
- * An Option is not created independently, but is create through
+ * An Option is not created independently, but is created through
  * an instance of {@link Options}.
+ * <p>
+ * <b>Note:</b> once an {@link Option} has been added to an instance
+ * of {@link Options}, it's required flag may not be changed anymore.
  *
  * @see org.apache.commons.cli.Options
  * @see org.apache.commons.cli.CommandLine
diff --git a/src/main/java/org/apache/commons/cli/Options.java b/src/main/java/org/apache/commons/cli/Options.java
@@ -197,11 +197,11 @@ List<Option> helpOptions()
     /**
      * Returns the required options.
      *
-     * @return List of required options
+     * @return read-only List of required options
      */
     public List getRequiredOptions()
     {
-        return requiredOpts;
+        return Collections.unmodifiableList(requiredOpts);
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -197,11 +197,11 @@ List<Option> helpOptions()`
`197`	`197`	`/**`
`198`	`198`	`* Returns the required options.`
`199`	`199`	`*`
`200`		`- * @return List of required options`
	`200`	`+ * @return read-only List of required options`
`201`	`201`	`*/`
`202`	`202`	`public List getRequiredOptions()`
`203`	`203`	`{`
`204`		`- return requiredOpts;`
	`204`	`+ return Collections.unmodifiableList(requiredOpts);`
`205`	`205`	`}`
`206`	`206`
`207`	`207`	`/**`