Moving to Java 5

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

Author: ebourg

pom.xml

@@ -151,10 +151,10 @@
   </dependencies>
 
   <properties>
-    <maven.compile.source>1.4</maven.compile.source>
-    <maven.compile.target>1.4</maven.compile.target>
+    <maven.compile.source>1.5</maven.compile.source>
+    <maven.compile.target>1.5</maven.compile.target>
     <commons.componentid>cli</commons.componentid>
-    <commons.release.version>1.2</commons.release.version>
+    <commons.release.version>1.3</commons.release.version>
     <commons.release.name>commons-cli-${commons.release.version}</commons.release.name>
     <commons.osgi.symbolicName>org.apache.commons.cli</commons.osgi.symbolicName>
     <commons.jira.id>CLI</commons.jira.id>

src/main/java/org/apache/commons/cli/AmbiguousOptionException.java

@@ -30,15 +30,15 @@
 public class AmbiguousOptionException extends UnrecognizedOptionException
 {
     /** The list of options matching the partial name specified */
-    private Collection matchingOptions;
+    private Collection<String> matchingOptions;
 
     /**
      * Constructs a new AmbiguousOptionException.
      *
      * @param option          the partial option name
      * @param matchingOptions the options matching the name
      */
-    public AmbiguousOptionException(String option, Collection matchingOptions)
+    public AmbiguousOptionException(String option, Collection<String> matchingOptions)
     {
         super(createMessage(option, matchingOptions), option);
         this.matchingOptions = matchingOptions;
@@ -47,7 +47,7 @@ public AmbiguousOptionException(String option, Collection matchingOptions)
     /**
      * Returns the options matching the partial name.
      */
-    public Collection getMatchingOptions()
+    public Collection<String> getMatchingOptions()
     {
         return matchingOptions;
     }
@@ -59,7 +59,7 @@ public Collection getMatchingOptions()
      * @param matchingOptions
      * @return
      */
-    private static String createMessage(String option, Collection matchingOptions)
+    private static String createMessage(String option, Collection<String> matchingOptions)
     {
         StringBuffer buff = new StringBuffer("Ambiguous option: '");
         buff.append(option);

src/main/java/org/apache/commons/cli/CommandLine.java

@@ -46,10 +46,10 @@ public class CommandLine implements Serializable
     private static final long serialVersionUID = 1L;
 
     /** the unrecognised options/arguments */
-    private List args = new LinkedList();
+    private List<String> args = new LinkedList<String>();
 
     /** the processed options */
-    private List options = new ArrayList();
+    private List<Option> options = new ArrayList<Option>();
 
     /**
      * Creates a command line.
@@ -169,18 +169,17 @@ public String getOptionValue(char opt)
      */
     public String[] getOptionValues(String opt)
     {
-        List values = new ArrayList();
+        List<String> values = new ArrayList<String>();
 
-        for (Iterator it = options.iterator(); it.hasNext();)
+        for (Option option : options)
         {
-            Option option = (Option) it.next();
             if (opt.equals(option.getOpt()) || opt.equals(option.getLongOpt()))
             {
                 values.addAll(option.getValuesList());
             }
         }
 
-        return values.isEmpty() ? null : (String[]) values.toArray(new String[values.size()]);
+        return values.isEmpty() ? null : values.toArray(new String[values.size()]);
     }
 
     /**
@@ -192,9 +191,7 @@ public String[] getOptionValues(String opt)
     private Option resolveOption(String opt)
     {
         opt = Util.stripLeadingHyphens(opt);
-        for (Iterator it = options.iterator(); it.hasNext();)
-        {
-            Option option = (Option) it.next();
+        for (Option option : options) {
             if (opt.equals(option.getOpt()))
             {
                 return option;
@@ -268,13 +265,11 @@ public Properties getOptionProperties(String opt)
     {
         Properties props = new Properties();
 
-        for (Iterator it = options.iterator(); it.hasNext();)
+        for (Option option : options)
         {
-            Option option = (Option) it.next();
-
             if (opt.equals(option.getOpt()) || opt.equals(option.getLongOpt()))
             {
-                List values = option.getValuesList();
+                List<String> values = option.getValuesList();
                 if (values.size() >= 2)
                 {
                     // use the first 2 arguments as the key/value pair
@@ -310,7 +305,7 @@ public String[] getArgs()
      *
      * @return remaining items passed in but not parsed as a <code>List</code>.
      */
-    public List getArgList()
+    public List<String> getArgList()
     {
         return args;
     }
@@ -375,12 +370,12 @@ public Iterator iterator()
      */
     public Option[] getOptions()
     {
-        Collection processed = options;
+        Collection<Option> processed = options;
 
         // reinitialise array
         Option[] optionsArray = new Option[processed.size()];
 
         // return the array
-        return (Option[]) processed.toArray(optionsArray);
+        return processed.toArray(optionsArray);
     }
 }

src/main/java/org/apache/commons/cli/DefaultParser.java

@@ -19,7 +19,6 @@
 
 import java.util.ArrayList;
 import java.util.Enumeration;
-import java.util.Iterator;
 import java.util.List;
 import java.util.Properties;
 
@@ -51,7 +50,7 @@ public class DefaultParser implements CommandLineParser
     /** Flag indicating if tokens should no longer be analysed and simply added as arguments of the command line. */
     protected boolean skipParsing;
 
-    /** The required options expected to be found when parsing the command line. */
+    /** The required options and groups expected to be found when parsing the command line. */
     protected List expectedOpts;
 
     public CommandLine parse(Options options, String[] arguments) throws ParseException
@@ -104,19 +103,18 @@ public CommandLine parse(Options options, String[] arguments, Properties propert
         expectedOpts = new ArrayList(options.getRequiredOptions());
 
         // clear the data from the groups
-        for (Iterator it = options.getOptionGroups().iterator(); it.hasNext();)
+        for (OptionGroup group : options.getOptionGroups())
         {
-            OptionGroup group = (OptionGroup) it.next();
             group.setSelected(null);
         }
 
         cmd = new CommandLine();
 
         if (arguments != null)
         {
-            for (int i = 0; i < arguments.length; i++)
+            for (String argument : arguments)
             {
-                handleToken(arguments[i]);
+                handleToken(argument);
             }
         }
 
@@ -387,7 +385,7 @@ private void handleLongOption(String token) throws ParseException
      */
     private void handleLongOptionWithoutEqual(String token) throws ParseException
     {
-        List matchingOpts = options.getMatchingOptions(token);
+        List<String> matchingOpts = options.getMatchingOptions(token);
         if (matchingOpts.isEmpty())
         {
             handleUnknownToken(currentToken);
@@ -398,7 +396,7 @@ else if (matchingOpts.size() > 1)
         }
         else
         {
-            handleOption(options.getOption((String) matchingOpts.get(0)));
+            handleOption(options.getOption(matchingOpts.get(0)));
         }
     }
 
@@ -420,7 +418,7 @@ private void handleLongOptionWithEqual(String token) throws ParseException
 
         String opt = token.substring(0, pos);
 
-        List matchingOpts = options.getMatchingOptions(opt);
+        List<String> matchingOpts = options.getMatchingOptions(opt);
         if (matchingOpts.isEmpty())
         {
             handleUnknownToken(currentToken);
@@ -431,7 +429,7 @@ else if (matchingOpts.size() > 1)
         }
         else
         {
-            Option option = options.getOption((String) matchingOpts.get(0));
+            Option option = options.getOption(matchingOpts.get(0));
 
             if (option.acceptsArg())
             {
@@ -485,6 +483,7 @@ private void handleShortAndLongOption(String token) throws ParseException
         }
         else if (pos == -1)
         {
+            // no equal sign found (-xxx)
             if (options.hasShortOption(t))
             {
                 handleOption(options.getOption(t));
@@ -521,6 +520,7 @@ else if (isJavaProperty(t))
         }
         else
         {
+            // equal sign found (-xxx=yyy)
             String opt = t.substring(0, pos);
             String value = t.substring(pos + 1);
 
@@ -595,7 +595,7 @@ private void handleOption(Option option) throws ParseException
         // check the previous option before handling the next one
         checkRequiredArgs();
 
-        option = (Option) option.clone();
+        option = option.clone();
 
         updateRequiredOptions(option);
 

src/main/java/org/apache/commons/cli/HelpFormatter.java

@@ -142,7 +142,7 @@ public class HelpFormatter
      * 
      * Defaults to case-insensitive alphabetical sorting by option key
      */
-    protected Comparator optionComparator = new OptionComparator();
+    protected Comparator<Option> optionComparator = new OptionComparator();
 
     /**
      * Sets the 'width'.
@@ -334,7 +334,7 @@ public String getArgName()
      * 
      * @since 1.2
      */
-    public Comparator getOptionComparator()
+    public Comparator<Option> getOptionComparator()
     {
         return optionComparator;
     }
@@ -345,7 +345,7 @@ public Comparator getOptionComparator()
      * 
      * @since 1.2
      */
-    public void setOptionComparator(Comparator comparator)
+    public void setOptionComparator(Comparator<Option> comparator)
     {
         if (comparator == null)
         {
@@ -544,12 +544,12 @@ public void printUsage(PrintWriter pw, int width, String app, Options options)
         StringBuffer buff = new StringBuffer(getSyntaxPrefix()).append(app).append(" ");
 
         // create a list for processed option groups
-        final Collection processedGroups = new ArrayList();
+        final Collection<OptionGroup> processedGroups = new ArrayList<OptionGroup>();
 
         // temp variable
         Option option;
 
-        List optList = new ArrayList(options.getOptions());
+        List<Option> optList = new ArrayList<Option>(options.getOptions());
         Collections.sort(optList, getOptionComparator());
         // iterate over the options
         for (Iterator i = optList.iterator(); i.hasNext();)
@@ -610,7 +610,7 @@ private void appendOptionGroup(final StringBuffer buff, final OptionGroup group)
             buff.append("[");
         }
 
-        List optList = new ArrayList(group.getOptions());
+        List<Option> optList = new ArrayList<Option>(group.getOptions());
         Collections.sort(optList, getOptionComparator());
         // for each option in the OptionGroup
         for (Iterator i = optList.iterator(); i.hasNext();)
@@ -758,15 +758,14 @@ protected StringBuffer renderOptions(StringBuffer sb, int width, Options options
         // sort options ascending
         int max = 0;
         StringBuffer optBuf;
-        List prefixList = new ArrayList();
-
-        List optList = options.helpOptions();
-
+        List<StringBuffer> prefixList = new ArrayList<StringBuffer>();
+        
+        List<Option> optList = options.helpOptions();
+        
         Collections.sort(optList, getOptionComparator());
-
-        for (Iterator i = optList.iterator(); i.hasNext();)
+        
+        for (Option option : optList)
         {
-            Option option = (Option) i.next();
             optBuf = new StringBuffer();
 
             if (option.getOpt() == null)
@@ -1016,25 +1015,21 @@ protected String rtrim(String s)
      * This class implements the <code>Comparator</code> interface
      * for comparing Options.
      */
-    private static class OptionComparator implements Comparator
+    private static class OptionComparator implements Comparator<Option>
     {
-
         /**
          * Compares its two arguments for order. Returns a negative
          * integer, zero, or a positive integer as the first argument
          * is less than, equal to, or greater than the second.
          *
-         * @param o1 The first Option to be compared.
-         * @param o2 The second Option to be compared.
+         * @param opt1 The first Option to be compared.
+         * @param opt2 The second Option to be compared.
          * @return a negative integer, zero, or a positive integer as
          *         the first argument is less than, equal to, or greater than the
          *         second.
          */
-        public int compare(Object o1, Object o2)
+        public int compare(Option opt1, Option opt2)
         {
-            Option opt1 = (Option) o1;
-            Option opt2 = (Option) o2;
-
             return opt1.getKey().compareToIgnoreCase(opt2.getKey());
         }
     }

src/main/java/org/apache/commons/cli/MissingOptionException.java

@@ -28,7 +28,7 @@
  */
 public class MissingOptionException extends ParseException
 {
-    /** The list of missing options */
+    /** The list of missing options and groups */
     private List missingOptions;
 
     /**