Javadoc

Reduce vertical whitespace

Author: garydgregory

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

@@ -36,8 +36,8 @@ public class AlreadySelectedException extends ParseException {
     /**
      * Constructs a new {@code AlreadySelectedException} for the specified option group.
      *
-     * @param optionGroup the option group already selected
-     * @param option the option that triggered the exception
+     * @param optionGroup the option group already selected.
+     * @param option the option that triggered the exception.
      * @since 1.2
      */
     public AlreadySelectedException(final OptionGroup optionGroup, final Option option) {
@@ -48,7 +48,7 @@ public AlreadySelectedException(final OptionGroup optionGroup, final Option opti
     /**
      * Constructs a new {@code AlreadySelectedException} with the specified detail message.
      *
-     * @param message the detail message
+     * @param message the detail message.
      */
     public AlreadySelectedException(final String message) {
         this(message, null, null);
@@ -63,7 +63,7 @@ private AlreadySelectedException(final String message, final OptionGroup optionG
     /**
      * Gets the option that was added to the group and triggered the exception.
      *
-     * @return the related option
+     * @return the related option.
      * @since 1.2
      */
     public Option getOption() {
@@ -73,7 +73,7 @@ public Option getOption() {
     /**
      * Gets the option group where another option has been selected.
      *
-     * @return the related option group
+     * @return the related option group.
      * @since 1.2
      */
     public OptionGroup getOptionGroup() {

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

@@ -42,7 +42,6 @@ private static String createMessage(final String option, final Collection<String
         final StringBuilder buf = new StringBuilder("Ambiguous option: '");
         buf.append(option);
         buf.append("'  (could be: ");
-
         final Iterator<String> it = matchingOptions.iterator();
         while (it.hasNext()) {
             buf.append(Char.APOS);
@@ -53,7 +52,6 @@ private static String createMessage(final String option, final Collection<String
             }
         }
         buf.append(")");
-
         return buf.toString();
     }
 
@@ -63,8 +61,8 @@ private static String createMessage(final String option, final Collection<String
     /**
      * Constructs a new AmbiguousOptionException.
      *
-     * @param option the partial option name
-     * @param matchingOptions the options matching the name
+     * @param option the partial option name.
+     * @param matchingOptions the options matching the name.
      */
     public AmbiguousOptionException(final String option, final Collection<String> matchingOptions) {
         super(createMessage(option, matchingOptions), option);
@@ -74,7 +72,7 @@ public AmbiguousOptionException(final String option, final Collection<String> ma
     /**
      * Gets the options matching the partial name.
      *
-     * @return a collection of options matching the name
+     * @return a collection of options matching the name.
      */
     public Collection<String> getMatchingOptions() {
         return matchingOptions;

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

@@ -21,7 +21,7 @@ Licensed to the Apache Software Foundation (ASF) under one or more
  * The class BasicParser provides a very simple implementation of the {@link Parser#flatten(Options,String[],boolean)
  * flatten} method.
  *
- * @deprecated since 1.3, use the {@link DefaultParser} instead
+ * @deprecated since 1.3, use the {@link DefaultParser} instead.
  */
 @Deprecated
 public class BasicParser extends Parser {
@@ -43,14 +43,14 @@ public BasicParser() {
      * <strong>Note:</strong> {@code options} and {@code stopAtNonOption} are not used in this {@code flatten} method.
      * </p>
      *
-     * @param options The command line {@link Options}
-     * @param arguments The command line arguments to be parsed
+     * @param options The command line {@link Options}.
+     * @param arguments The command line arguments to be parsed.
      * @param stopAtNonOption Specifies whether to stop flattening when an non option is found.
      * @return The {@code arguments} String array.
      */
     @Override
     protected String[] flatten(@SuppressWarnings("unused") final Options options, final String[] arguments,
-        @SuppressWarnings("unused") final boolean stopAtNonOption) {
+            @SuppressWarnings("unused") final boolean stopAtNonOption) {
         // just echo the arguments
         return arguments;
     }

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

@@ -26,20 +26,20 @@ public interface CommandLineParser {
     /**
      * Parses the arguments according to the specified options.
      *
-     * @param options the specified Options
-     * @param arguments the command line arguments
-     * @return the list of atomic option and value tokens
+     * @param options the specified Options.
+     * @param arguments the command line arguments.
+     * @return the list of atomic option and value tokens.
      * @throws ParseException if there are any problems encountered while parsing the command line tokens.
      */
     CommandLine parse(Options options, String[] arguments) throws ParseException;
 
     /**
      * Parses the arguments according to the specified options and properties.
      *
-     * @param options the specified Options
-     * @param arguments the command line arguments
-     * @param properties command line option name-value pairs
-     * @return the list of atomic option and value tokens
+     * @param options the specified Options.
+     * @param arguments the command line arguments.
+     * @param properties command line option name-value pairs.
+     * @return the list of atomic option and value tokens.
      * @throws ParseException if there are any problems encountered while parsing the command line tokens.
      */
     /*
@@ -51,33 +51,28 @@ public interface CommandLineParser {
     /**
      * Parses the arguments according to the specified options.
      *
-     * @param options the specified Options
-     * @param arguments the command line arguments
+     * @param options the specified Options.
+     * @param arguments the command line arguments.
      * @param stopAtNonOption if {@code true} an unrecognized argument stops the parsing and the remaining arguments
      *        are added to the {@link CommandLine}s args list. If {@code false} an unrecognized argument triggers a
      *        ParseException.
      *
-     * @return the list of atomic option and value tokens
+     * @return the list of atomic option and value tokens.
      * @throws ParseException if there are any problems encountered while parsing the command line tokens.
      */
     CommandLine parse(Options options, String[] arguments, boolean stopAtNonOption) throws ParseException;
 
     /**
      * Parses the arguments according to the specified options and properties.
      *
-     * @param options the specified Options
-     * @param arguments the command line arguments
-     * @param properties command line option name-value pairs
+     * @param options the specified Options.
+     * @param arguments the command line arguments.
+     * @param properties command line option name-value pairs.
      * @param stopAtNonOption if {@code true} an unrecognized argument stops the parsing and the remaining arguments
      *        are added to the {@link CommandLine}s args list. If {@code false} an unrecognized argument triggers a
      *        ParseException.
      *
-     * @return the list of atomic option and value tokens
+     * @return the list of atomic option and value tokens.
      * @throws ParseException if there are any problems encountered while parsing the command line tokens.
      */
-    /*
-     * To maintain binary compatibility, this is commented out. It is still in the abstract Parser class, so most users will
-     * still reap the benefit. CommandLine parse(Options options, String[] arguments, Properties properties, boolean
-     * stopAtNonOption) throws ParseException;
-     */
 }

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

@@ -81,7 +81,7 @@ public interface Converter<T, E extends Exception> {
     /**
      * Applies the conversion function to the String argument.
      *
-     * @param string the String to convert
+     * @param string the String to convert.
      * @return the Object from the conversion.
      * @throws E on error.
      */

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

@@ -64,9 +64,9 @@ public static final class Builder implements Supplier<DefaultParser> {
 
         /**
          * Constructs a new {@code Builder} for a {@code DefaultParser} instance.
-         *
-         * Both allowPartialMatching and stripLeadingAndTrailingQuotes are true by default,
-         * mimicking the argument-less constructor.
+         * <p>
+         * Both allowPartialMatching and stripLeadingAndTrailingQuotes are true by default, mimicking the argument-less constructor.
+         * </p>
          */
         private Builder() {
         }
@@ -96,10 +96,12 @@ public DefaultParser get() {
 
         /**
          * Sets if partial matching of long options is supported.
-         *
+         * <p>
          * By "partial matching" we mean that given the following code:
+         * </p>
          *
          * <pre>
+         *
          * {
          *     &#64;code
          *     final Options options = new Options();
@@ -108,12 +110,13 @@ public DefaultParser get() {
          *     options.addOption(new Option("o", "option", true, "Turn on option with argument."));
          * }
          * </pre>
-         *
-         * If "partial matching" is turned on, {@code -de} only matches the {@code "debug"} option. However, with
-         * "partial matching" disabled, {@code -de} would enable both {@code debug} as well as {@code extract}
+         * <p>
+         * If "partial matching" is turned on, {@code -de} only matches the {@code "debug"} option. However, with "partial matching" disabled, {@code -de} would
+         * enable both {@code debug} as well as {@code extract}
+         * </p>
          *
          * @param allowPartialMatching whether to allow partial matching of long options.
-         * @return {@code this} instance..
+         * @return {@code this} instance.
          * @since 1.5.0
          */
         public Builder setAllowPartialMatching(final boolean allowPartialMatching) {
@@ -136,13 +139,14 @@ public Builder setDeprecatedHandler(final Consumer<Option> deprecatedHandler) {
         /**
          * Sets if balanced leading and trailing double quotes should be stripped from option arguments.
          *
-         * If "stripping of balanced leading and trailing double quotes from option arguments" is true,
-         * the outermost balanced double quotes of option arguments values will be removed.
-         * For example, {@code -o '"x"'} getValue() will return {@code x}, instead of {@code "x"}
-         *
-         * If "stripping of balanced leading and trailing double quotes from option arguments" is null,
-         * then quotes will be stripped from option values separated by space from the option, but
-         * kept in other cases, which is the historic behavior.
+         * <p>
+         * If "stripping of balanced leading and trailing double quotes from option arguments" is true, the outermost balanced double quotes of option arguments
+         * values will be removed. For example, {@code -o '"x"'} getValue() will return {@code x}, instead of {@code "x"}
+         * </p>
+         * <p>
+         * If "stripping of balanced leading and trailing double quotes from option arguments" is null, then quotes will be stripped from option values
+         * separated by space from the option, but kept in other cases, which is the historic behavior.
+         * </p>
          *
          * @param stripLeadingAndTrailingQuotes whether balanced leading and trailing double quotes should be stripped from option arguments.
          * @return {@code this} instance.
@@ -248,8 +252,9 @@ static int indexOfEqual(final String token) {
 
     /**
      * Creates a new DefaultParser instance with partial matching enabled.
-     *
+     * <p>
      * By "partial matching" we mean that given the following code:
+     * </p>
      *
      * <pre>
      * {
@@ -273,9 +278,9 @@ public DefaultParser() {
 
     /**
      * Create a new DefaultParser instance with the specified partial matching policy.
-     *
+     * <p>
      * By "partial matching" we mean that given the following code:
-     *
+     * </p>
      * <pre>
      * {
      *     &#64;code
@@ -285,10 +290,11 @@ public DefaultParser() {
      *     options.addOption(new Option("o", "option", true, "Turn on option with argument."));
      * }
      * </pre>
-     *
+     * <p>
      * with "partial matching" turned on, {@code -de} only matches the {@code "debug"} option. However, with
      * "partial matching" disabled, {@code -de} would enable both {@code debug} as well as {@code extract}
      * options.
+     * </p>
      *
      * @param allowPartialMatching if partial matching of long options shall be enabled
      */

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

@@ -24,7 +24,7 @@ Licensed to the Apache Software Foundation (ASF) under one or more
  * The class GnuParser provides an implementation of the {@link Parser#flatten(Options, String[], boolean) flatten}
  * method.
  *
- * @deprecated since 1.3, use the {@link DefaultParser} instead
+ * @deprecated since 1.3, use the {@link DefaultParser} instead.
  */
 @Deprecated
 public class GnuParser extends Parser {
@@ -47,8 +47,8 @@ public GnuParser() {
      *
      * @param options The Options to parse the arguments by.
      * @param arguments The arguments that have to be flattened.
-     * @param stopAtNonOption specifies whether to stop flattening when a non option has been encountered
-     * @return a String array of the flattened arguments
+     * @param stopAtNonOption specifies whether to stop flattening when a non option has been encountered.
+     * @return a String array of the flattened arguments.
      */
     @Override
     protected String[] flatten(final Options options, final String[] arguments, final boolean stopAtNonOption) {
@@ -84,15 +84,13 @@ protected String[] flatten(final Options options, final String[] arguments, fina
                 } else {
                     tokens.add(arg);
                 }
-
                 if (eatTheRest) {
                     for (i++; i < arguments.length; i++) { // NOPMD
                         tokens.add(arguments[i]);
                     }
                 }
             }
         }
-
         return tokens.toArray(Util.EMPTY_STRING_ARRAY);
     }
 }