Fix checkstyle warnings, minor formatting, typos, complete javadoc for not yet implemented methods.

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

Author: netomi

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

@@ -26,7 +26,7 @@
  * if any exists, a flag indicating if an argument is required for
  * this option, and a self-documenting description of the option.</p>
  *
- * <p>An Option is not created independantly, but is create through
+ * <p>An Option is not created independently, but is create through
  * an instance of {@link Options}.<p>
  *
  * @see org.apache.commons.cli.Options

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

@@ -26,6 +26,13 @@
  */
 class OptionValidator
 {
+    /**
+     * Hide constructor for a utility class.
+     */
+    private OptionValidator()
+    {
+    }
+
     /**
      * Validates whether <code>opt</code> is a permissable Option
      * shortOpt.  The rules that specify if the <code>opt</code>
@@ -68,7 +75,8 @@ static void validateOption(String opt) throws IllegalArgumentException
             {
                 if (!isValidChar(ch))
                 {
-                    throw new IllegalArgumentException("The option '" + opt + "' contains an illegal character : '" + ch + "'");
+                    throw new IllegalArgumentException("The option '" + opt + "' contains an illegal "
+                                                       + "character : '" + ch + "'");
                 }
             }
         }

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

@@ -68,7 +68,8 @@ protected List getRequiredOptions()
      * flattening when a non option has been encountered
      * @return a String array of the flattened arguments
      */
-    protected abstract String[] flatten(Options opts, String[] arguments, boolean stopAtNonOption) throws ParseException;
+    protected abstract String[] flatten(Options opts, String[] arguments, boolean stopAtNonOption)
+            throws ParseException;
 
     /**
      * Parses the specified <code>arguments</code> based
@@ -139,7 +140,8 @@ public CommandLine parse(Options options, String[] arguments, boolean stopAtNonO
      *
      * @since 1.1
      */
-    public CommandLine parse(Options options, String[] arguments, Properties properties, boolean stopAtNonOption) throws ParseException
+    public CommandLine parse(Options options, String[] arguments, Properties properties, boolean stopAtNonOption)
+            throws ParseException
     {
         // clear out the data in options in case it's been used before (CLI-71)
         for (Option opt : options.helpOptions()) {

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

@@ -25,13 +25,13 @@
 import java.util.Date;
 
 /**
-  * This is a temporary implementation. TypeHandler will handle the
-  * pluggableness of OptionTypes and it will direct all of these types
-  * of conversion functionalities to ConvertUtils component in Commons
-  * already. BeanUtils I think.
-  *
-  * @version $Revision$, $Date$
-  */
+ * This is a temporary implementation. TypeHandler will handle the
+ * pluggableness of OptionTypes and it will direct all of these types
+ * of conversion functionalities to ConvertUtils component in Commons
+ * already. BeanUtils I think.
+ *
+ * @version $Revision$, $Date$
+ */
 public class TypeHandler
 {
     /**
@@ -178,10 +178,14 @@ public static Class createClass(String classname) throws ParseException
 
     /**
      * Returns the date represented by <code>str</code>.
+     * <p>
+     * This method is not yet implemented and always throws an
+     * {@link UnsupportedOperationException}.
      *
      * @param str the date string
      * @return The date if <code>str</code> is a valid date string,
      * otherwise return null.
+     * @throws UnsupportedOperationException always
      */
     public static Date createDate(String str) throws ParseException
     {
@@ -220,9 +224,13 @@ public static File createFile(String str) throws ParseException
 
     /**
      * Returns the File[] represented by <code>str</code>.
+     * <p>
+     * This method is not yet implemented and always throws an
+     * {@link UnsupportedOperationException}.
      *
      * @param str the paths to the files
      * @return The File[] represented by <code>str</code>.
+     * @throws UnsupportedOperationException always
      */
     public static File[] createFiles(String str) throws ParseException
     {

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

@@ -25,6 +25,13 @@
  */
 class Util
 {
+    /**
+     * Hide constructor for a utility class.
+     */
+    private Util()
+    {
+    }
+
     /**
      * Remove the hyphens from the begining of <code>str</code> and
      * return the new String.