Implemented definition time defaults:

Option - added defaults(WriteableCommandLine)
WriteableCommandLine - added setDefaultValues(Option,List)
WriteableCommandLine - added setDefaultSwitch(Option,Boolean)
Argument - add defaults(WriteableCommandLine,Option)
CommandLineDefaultsTest - test the defaults in combination
Parser - now applys the defaults before processing
Implemented new methods


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

Author: Robert James Oxspring

src/java/org/apache/commons/cli2/Argument.java

@@ -49,6 +49,16 @@ void processValues(
         final ListIterator args,
         final Option option)
             throws OptionException;
+    
+    /**
+     * Adds defaults to a CommandLine.
+     * 
+     * @param commandLine
+     *            The CommandLine object to store defaults in.
+     * @param option
+     *            The Option to store the defaults against.
+     */
+    void defaultValues(final WriteableCommandLine commandLine, final Option option);
 
     /**
      * Performs any necessary validation on the values added to the

src/java/org/apache/commons/cli2/Option.java

@@ -47,6 +47,17 @@ void process(
         final WriteableCommandLine commandLine,
         final ListIterator args)
         throws OptionException;
+    
+    /**
+     * Adds defaults to a CommandLine.
+     * 
+     * Any defaults for this option are applied as well as the defaults for 
+     * any contained options
+     * 
+     * @param commandLine
+     *            The CommandLine object to store defaults in
+     */
+    void defaults(final WriteableCommandLine commandLine);
 
     /**
      * Indicates whether this Option will be able to process the particular

src/java/org/apache/commons/cli2/WriteableCommandLine.java

@@ -15,6 +15,8 @@
  */
 package org.apache.commons.cli2;
 
+import java.util.List;
+
 /**
  * A CommandLine that detected values and options can be written to.
  */
@@ -32,6 +34,13 @@ public interface WriteableCommandLine extends CommandLine {
      * @param value the value to add
      */
     void addValue(final Option option, final Object value);
+
+    /**
+     * Sets the default values for an Option in the CommandLine
+     * @param option the Option to add to
+     * @param defaultValues the defaults for the option
+     */
+    void setDefaultValues(final Option option, final List defaultValues);
 
     /**
      * Adds a switch value to an Option in the CommandLine.
@@ -41,6 +50,13 @@ public interface WriteableCommandLine extends CommandLine {
      */
     void addSwitch(final Option option, final boolean value) throws IllegalStateException;
 
+    /**
+     * Sets the default state for a Switch in the CommandLine.
+     * @param option the Option to add to
+     * @param defaultSwitch the defaults state for ths switch
+     */
+    void setDefaultSwitch(final Option option, final Boolean defaultSwitch);
+    
     /**
      * Adds a property value to a name in the CommandLine.
      * Replaces any existing value for the property.

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

@@ -37,6 +37,7 @@ public class SwitchBuilder {
     private Argument argument;
     private Group children;
     private int id;
+    private Boolean switchDefault;
 
     /**
      * Creates a new SwitchBuilder using defaults.
@@ -86,7 +87,8 @@ public Switch create() {
                 required,
                 argument,
                 children,
-                id);
+                id,
+                switchDefault);
 
         reset();
 
@@ -104,6 +106,7 @@ public void reset() {
         argument = null;
         children = null;
         id = 0;
+        switchDefault = null;
     }
 
     /**
@@ -173,4 +176,15 @@ public final SwitchBuilder withId(final int newId) {
         this.id = newId;
         return this;
     }
+    
+    /**
+     * Sets the default state for this switch
+     * 
+     * @param switchDefault the default state
+     * @return this SwitchBuilder
+     */
+    public final SwitchBuilder withSwitchDefault(final Boolean switchDefault) {
+        this.switchDefault = switchDefault;
+        return this;
+    }
 }

src/java/org/apache/commons/cli2/commandline/Parser.java

@@ -56,10 +56,13 @@ public class Parser {
     public CommandLine parse(final String[] arguments) throws OptionException {
 
         final List argumentList = new LinkedList(Arrays.asList(arguments));
-        final ListIterator iterator = argumentList.listIterator();
         final WriteableCommandLine commandLine =
             new WriteableCommandLineImpl(group, new ArrayList());
+        
+        // pick up any defaults from the model
+        group.defaults(commandLine);
 
+        final ListIterator iterator = argumentList.listIterator();
         while (group.canProcess(iterator)) {
             group.process(commandLine, iterator);
         }

src/java/org/apache/commons/cli2/commandline/WriteableCommandLineImpl.java

@@ -18,15 +18,13 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashMap;
-import java.util.HashSet;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 import java.util.Properties;
 import java.util.Set;
 
 import org.apache.commons.cli2.Argument;
-import org.apache.commons.cli2.CommandLine;
 import org.apache.commons.cli2.Option;
 import org.apache.commons.cli2.WriteableCommandLine;
 
@@ -41,12 +39,11 @@ public class WriteableCommandLineImpl extends CommandLineImpl implements Writeab
     private final Map nameToOption = new HashMap();
     private final Map values = new HashMap();
     private final Map switches = new HashMap();
-    private final Map defaults = new HashMap();
+    private final Map defaultValues = new HashMap();
+    private final Map defaultSwitches = new HashMap();
     private final List normalised;
     private final Set prefixes;
 
-    private CommandLine defaultCommandLine = null;
-
     /**
      * Creates a new WriteableCommandLineImpl rooted on the specified Option, to
      * hold the parsed arguments.
@@ -91,38 +88,26 @@ public void addSwitch(final Option option, final boolean value) {
 
     public boolean hasOption(final Option option) {
         final boolean present = options.contains(option);
-        if (!present && defaultCommandLine != null) {
-            return defaultCommandLine.hasOption(option);
-        }
-        else {
-            return present;
-        }
+        return present;
     }
 
     public Option getOption(final String trigger) {
         return (Option)nameToOption.get(trigger);
     }
 
-    //TODO Document the order of values and defaults
     public List getValues(final Option option, final List defaultValues) {
 
         // First grab the command line values
         List valueList = (List)values.get(option);
 
-        // Secondly try alternate CommandLines
-        if ((valueList == null || valueList.isEmpty())
-        && defaultCommandLine != null) {
-            valueList = defaultCommandLine.getValues(option, null);
-        }
-
-        // Thirdly try the defaults supplied to the method
+        // Secondly try the defaults supplied to the method
         if (valueList == null || valueList.isEmpty()) {
             valueList = defaultValues;
         }
 
-        // Fourthly try the option's default values
+        // Thirdly try the option's default values
         if (valueList == null || valueList.isEmpty()) {
-            valueList = (List)this.defaults.get(option);
+            valueList = (List)this.defaultValues.get(option);
         }
 
         // Finally use an empty list
@@ -137,18 +122,15 @@ public Boolean getSwitch(final Option option, final Boolean defaultValue) {
         // First grab the command line values
         Boolean bool = (Boolean)switches.get(option);
 
-        // Secondly try alternate CommandLines
-        if (bool == null && defaultCommandLine != null) {
-            bool = defaultCommandLine.getSwitch(option);
-        }
-
-        // Thirdly try the defaults supplied to the method
+        // Secondly try the defaults supplied to the method
         if (bool == null) {
             bool = defaultValue;
         }
 
-        // Fourthly try the option's default values
-        //????
+        // Thirdly try the option's default values
+        if (bool == null) {
+            bool = (Boolean)this.defaultSwitches.get(option);
+        }
 
         return bool;
     }
@@ -162,15 +144,7 @@ public String getProperty(final String property, final String defaultValue) {
     }
 
     public Set getProperties() {
-        if (defaultCommandLine == null) {
-            return Collections.unmodifiableSet(properties.keySet());
-        }
-        else {
-            final Set props = new HashSet();
-            props.addAll(properties.keySet());
-            props.addAll(defaultCommandLine.getProperties());
-            return Collections.unmodifiableSet(props);
-        }
+        return Collections.unmodifiableSet(properties.keySet());
     }
 
     public boolean looksLikeOption(final String trigger) {
@@ -212,4 +186,22 @@ public List getOptions() {
     public Set getOptionTriggers() {
         return Collections.unmodifiableSet(nameToOption.keySet());
     }
+
+    public void setDefaultValues(final Option option, final List defaults) {
+        if (defaults==null) {
+            defaultValues.remove(option);
+        }
+        else {
+            defaultValues.put(option, defaults);
+        }
+    }
+
+    public void setDefaultSwitch(final Option option, final Boolean defaultSwitch) {
+        if (defaultSwitch==null) {
+            defaultSwitches.remove(defaultSwitch);
+        }
+        else {
+            defaultSwitches.put(option, defaultSwitch);
+        }
+    }
 }

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

@@ -103,7 +103,7 @@ public ArgumentImpl(
         final char subsequentSeparator,
         final Validator validator,
         final String consumeRemaining,
-        final List defaultValues,
+        final List valueDefaults,
         final int id) {
 
         super(id,false);
@@ -117,20 +117,20 @@ public ArgumentImpl(
         this.subsequentSplit = subsequentSeparator != NUL;
         this.validator = validator;
         this.consumeRemaining = consumeRemaining;
-        this.defaultValues = defaultValues;
+        this.defaultValues = valueDefaults;
 
         if (minimum > maximum) {
             throw new IllegalArgumentException(
                 resources.getMessage("cli.error.minimum.exceeds.maximum"));
         }
 
-        if (defaultValues != null) {
-            if (defaultValues.size() < minimum) {
+        if (valueDefaults != null) {
+            if (valueDefaults.size() < minimum) {
                 throw new IllegalArgumentException(
                     resources.getMessage("cli.error.too.few.defaults"));
             }
 
-            if (defaultValues.size() > maximum) {
+            if (valueDefaults.size() > maximum) {
                 throw new IllegalArgumentException(
                     resources.getMessage("cli.error.too.many.defaults"));
             }
@@ -367,4 +367,13 @@ public String stripBoundaryQuotes(String token) {
     public boolean isRequired() {
         return getMinimum()>0;
     }
+    
+    public void defaults(final WriteableCommandLine commandLine) {
+        super.defaults(commandLine);
+        defaultValues(commandLine,this);
+    }
+    
+    public void defaultValues(final WriteableCommandLine commandLine, final Option option) {
+        commandLine.setDefaultValues(option, defaultValues);
+    }
 }

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

@@ -444,6 +444,20 @@ public int getMaximum() {
     public boolean isRequired() {
         return getMinimum()>0;
     }
+    
+    public void defaults(final WriteableCommandLine commandLine) {
+        super.defaults(commandLine);
+        
+        for (final Iterator i = options.iterator(); i.hasNext();) {
+            final Option option = (Option) i.next();
+            option.defaults(commandLine);
+        }
+        
+        for (final Iterator i = anonymous.iterator(); i.hasNext();) {
+            final Option option = (Option) i.next();
+            option.defaults(commandLine);
+        }
+    }
 }
 
 class ReverseStringComparator implements Comparator {

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

@@ -19,6 +19,7 @@
 
 import org.apache.commons.cli2.DisplaySetting;
 import org.apache.commons.cli2.Option;
+import org.apache.commons.cli2.WriteableCommandLine;
 
 /**
  * A base implementation of Option providing limited ground work for further
@@ -99,4 +100,8 @@ public Option findOption(String trigger) {
     public boolean isRequired() {
         return required;
     }
+    
+    public void defaults(final WriteableCommandLine commandLine) {
+        // nothing to do normally
+    }
 }

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

@@ -252,4 +252,16 @@ public Option findOption(final String trigger) {
 			return found;
 		}
 	}
+    
+    public void defaults(final WriteableCommandLine commandLine) {
+        super.defaults(commandLine);
+        
+        if(argument!=null) {
+            argument.defaultValues(commandLine,this);
+        }
+        
+        if(children!=null) {
+            children.defaults(commandLine);
+        }
+    }
 }