Return-Path: X-Original-To: apmail-commons-commits-archive@minotaur.apache.org Delivered-To: apmail-commons-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 4D74DDA01 for ; Sun, 27 Jan 2013 22:00:45 +0000 (UTC) Received: (qmail 47525 invoked by uid 500); 27 Jan 2013 22:00:45 -0000 Delivered-To: apmail-commons-commits-archive@commons.apache.org Received: (qmail 47461 invoked by uid 500); 27 Jan 2013 22:00:45 -0000 Mailing-List: contact commits-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@commons.apache.org Delivered-To: mailing list commits@commons.apache.org Received: (qmail 47454 invoked by uid 99); 27 Jan 2013 22:00:45 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 27 Jan 2013 22:00:45 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 27 Jan 2013 22:00:43 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 830762388A32; Sun, 27 Jan 2013 22:00:24 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1439197 - in /commons/proper/cli/trunk/src/main/java/org/apache/commons/cli: Option.java OptionValidator.java Parser.java TypeHandler.java Util.java Date: Sun, 27 Jan 2013 22:00:24 -0000 To: commits@commons.apache.org From: tn@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20130127220024.830762388A32@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: tn Date: Sun Jan 27 22:00:23 2013 New Revision: 1439197 URL: http://svn.apache.org/viewvc?rev=1439197&view=rev Log: Fix checkstyle warnings, minor formatting, typos, complete javadoc for not yet implemented methods. Modified: commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/Option.java commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/OptionValidator.java commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/Parser.java commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/TypeHandler.java commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/Util.java Modified: commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/Option.java URL: http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/Option.java?rev=1439197&r1=1439196&r2=1439197&view=diff ============================================================================== --- commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/Option.java (original) +++ commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/Option.java Sun Jan 27 22:00:23 2013 @@ -26,7 +26,7 @@ import java.util.List; * if any exists, a flag indicating if an argument is required for * this option, and a self-documenting description of the option.

* - *

An Option is not created independantly, but is create through + *

An Option is not created independently, but is create through * an instance of {@link Options}.

* * @see org.apache.commons.cli.Options Modified: commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/OptionValidator.java URL: http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/OptionValidator.java?rev=1439197&r1=1439196&r2=1439197&view=diff ============================================================================== --- commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/OptionValidator.java (original) +++ commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/OptionValidator.java Sun Jan 27 22:00:23 2013 @@ -27,6 +27,13 @@ package org.apache.commons.cli; class OptionValidator { /** + * Hide constructor for a utility class. + */ + private OptionValidator() + { + } + + /** * Validates whether opt is a permissable Option * shortOpt. The rules that specify if the opt * is valid are: @@ -68,7 +75,8 @@ class OptionValidator { 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 + "'"); } } } Modified: commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/Parser.java URL: http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/Parser.java?rev=1439197&r1=1439196&r2=1439197&view=diff ============================================================================== --- commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/Parser.java (original) +++ commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/Parser.java Sun Jan 27 22:00:23 2013 @@ -68,7 +68,8 @@ public abstract class Parser implements * 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 arguments based @@ -139,7 +140,8 @@ public abstract class Parser implements * * @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()) { Modified: commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/TypeHandler.java URL: http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/TypeHandler.java?rev=1439197&r1=1439196&r2=1439197&view=diff ============================================================================== --- commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/TypeHandler.java (original) +++ commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/TypeHandler.java Sun Jan 27 22:00:23 2013 @@ -25,13 +25,13 @@ import java.net.URL; 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 class TypeHandler /** * Returns the date represented by str. + *

+ * This method is not yet implemented and always throws an + * {@link UnsupportedOperationException}. * * @param str the date string * @return The date if str is a valid date string, * otherwise return null. + * @throws UnsupportedOperationException always */ public static Date createDate(String str) throws ParseException { @@ -220,9 +224,13 @@ public class TypeHandler /** * Returns the File[] represented by str. + *

+ * This method is not yet implemented and always throws an + * {@link UnsupportedOperationException}. * * @param str the paths to the files * @return The File[] represented by str. + * @throws UnsupportedOperationException always */ public static File[] createFiles(String str) throws ParseException { Modified: commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/Util.java URL: http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/Util.java?rev=1439197&r1=1439196&r2=1439197&view=diff ============================================================================== --- commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/Util.java (original) +++ commons/proper/cli/trunk/src/main/java/org/apache/commons/cli/Util.java Sun Jan 27 22:00:23 2013 @@ -26,6 +26,13 @@ package org.apache.commons.cli; class Util { /** + * Hide constructor for a utility class. + */ + private Util() + { + } + + /** * Remove the hyphens from the begining of str and * return the new String. *