Added checks and documentation to ensure preferredName and any aliases begin with a specified prefix

Bug: 30979


git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/cli/trunk@130091 13f79535-47bb-0310-9956-ffa450edef68

Author: Robert James Oxspring

src/java/org/apache/commons/cli2/builder/DefaultOptionBuilder.java

@@ -128,7 +128,9 @@ public void reset() {
     }
 
     /**
-     * Use this short option name
+     * Use this short option name. The first name is used as the preferred
+     * display name for the Command and then later names are used as aliases.
+     * 
      * @param shortName the name to use
      * @return this builder
      */
@@ -150,7 +152,9 @@ public DefaultOptionBuilder withShortName(final String shortName) {
     }
 
     /**
-     * Use this long option name
+     * Use this long option name.  The first name is used as the preferred
+     * display name for the Command and then later names are used as aliases.
+     * 
      * @param longName the name to use
      * @return this builder
      */

src/java/org/apache/commons/cli2/builder/SwitchBuilder.java

@@ -120,7 +120,9 @@ public SwitchBuilder withDescription(final String newDescription) {
     }
 
     /**
-     * Use this option name
+     * Use this option name. The first name is used as the preferred
+     * display name for the Command and then later names are used as aliases.
+     * 
      * @param name the name to use
      * @return this builder
      */

src/java/org/apache/commons/cli2/option/DefaultOption.java

@@ -67,14 +67,16 @@ public class DefaultOption extends ParentImpl {
      * @param shortPrefix the prefix used for short options
      * @param longPrefix the prefix used for long options
      * @param burstEnabled should option bursting be enabled
-     * @param preferredName the preferred name for this Option
+     * @param preferredName the preferred name for this Option, this should begin with either shortPrefix or longPrefix
      * @param description a description of this Option
      * @param aliases the alternative names for this Option
      * @param burstAliases the aliases that can be burst
      * @param required whether the Option is strictly required
      * @param argument the Argument belonging to this Parent, or null
      * @param children the Group children belonging to this Parent, ot null
      * @param id the unique identifier for this Option
+     * @throws IllegalArgumentException if the preferredName or an alias isn't
+     *     prefixed with shortPrefix or longPrefix 
      */
     public DefaultOption(
         final String shortPrefix,
@@ -121,6 +123,8 @@ public DefaultOption(
         newPrefixes.add(shortPrefix);
         newPrefixes.add(longPrefix);
         this.prefixes = Collections.unmodifiableSet(newPrefixes);
+        
+        checkPrefixes(newPrefixes);
     }
 
     public boolean canProcess(final String argument) {

src/java/org/apache/commons/cli2/option/OptionImpl.java

@@ -15,11 +15,14 @@
  */
 package org.apache.commons.cli2.option;
 
+import java.util.Iterator;
 import java.util.ListIterator;
+import java.util.Set;
 
 import org.apache.commons.cli2.DisplaySetting;
 import org.apache.commons.cli2.Option;
 import org.apache.commons.cli2.WriteableCommandLine;
+import org.apache.commons.cli2.resource.ResourceHelper;
 
 /**
  * A base implementation of Option providing limited ground work for further
@@ -104,4 +107,39 @@ public boolean isRequired() {
     public void defaults(final WriteableCommandLine commandLine) {
         // nothing to do normally
     }
+    
+    protected void checkPrefixes(final Set prefixes) {
+        
+        // nothing to do if empty prefix list
+        if(prefixes.isEmpty()) {
+            return;
+        }
+        
+        // check preferred name
+        checkPrefix(prefixes, getPreferredName());
+        
+        // check triggers
+        this.getTriggers();
+        for (final Iterator i = getTriggers().iterator(); i.hasNext();) {
+            checkPrefix(prefixes, (String) i.next());
+        }
+    }
+
+    private void checkPrefix(final Set prefixes, final String trigger) {
+        for (final Iterator i = prefixes.iterator(); i.hasNext();) {
+            String prefix = (String) i.next();
+            if(trigger.startsWith(prefix)) {
+                return;
+            }
+        }
+        
+        final ResourceHelper helper = 
+            ResourceHelper.getResourceHelper(OptionImpl.class);
+        final String message = 
+            helper.getMessage("cli.error.trigger.needs.prefix",
+                    trigger,prefixes.toString());
+        throw new IllegalArgumentException(message);
+    }
+    
+    
 }

src/java/org/apache/commons/cli2/option/Switch.java

@@ -65,6 +65,8 @@ public class Switch extends ParentImpl {
      * @param argument the Argument belonging to this Parent, or null
      * @param children the Group children belonging to this Parent, ot null
      * @param id the unique identifier for this Option
+     * @throws IllegalArgumentException if the preferredName or an alias isn't
+     *     prefixed with enabledPrefix or disabledPrefix 
      */
     public Switch(
         final String enabledPrefix,
@@ -126,6 +128,8 @@ public Switch(
         this.prefixes = Collections.unmodifiableSet(newPrefixes);
 
         this.defaultSwitch = switchDefault;
+        
+        checkPrefixes(newPrefixes);
     }
 
     public void processParent(

src/java/org/apache/commons/cli2/option/messages.properties

@@ -1,3 +1,5 @@
 cli.error.minimum.exceeds.maximum = Minimum number of values must not exceed maximum number
 cli.error.too.few.defaults = Not enough default values.
 cli.error.too.many.defaults = Too many default values.
+cli.error.trigger.needs.prefix = Trigger {0} must be prefixed with a value from {1}
+cli.error.badproperty = Could not understand property: {0}