Package jargs.gnu

Class CmdLineParser

java.lang.Object
jargs.gnu.CmdLineParser

public class CmdLineParser extends Object
Largely GNU-compatible command-line options parser. Has short (-v) and long-form (--verbose) option support, and also allows options with associated values (-d 2, --debug 2, --debug=2). Option processing can be explicitly terminated by the argument '--'.
Version:
$Revision$
Author:
Steve Purcell
See Also:
  • Constructor Details

    • CmdLineParser

      public CmdLineParser()
  • Method Details

    • addOption

      public final CmdLineParser.Option addOption(CmdLineParser.Option opt)
      Add the specified Option to the list of accepted options.
      Parameters:
      opt - the opt
      Returns:
      the option
    • addStringOption

      public final CmdLineParser.Option addStringOption(char shortForm, String longForm)
      Convenience method for adding a string option.
      Parameters:
      shortForm - the short form
      longForm - the long form
      Returns:
      the new Option
    • addStringOption

      public final CmdLineParser.Option addStringOption(String longForm)
      Convenience method for adding a string option.
      Parameters:
      longForm - the long form
      Returns:
      the new Option
    • addIntegerOption

      public final CmdLineParser.Option addIntegerOption(char shortForm, String longForm)
      Convenience method for adding an integer option.
      Parameters:
      shortForm - the short form
      longForm - the long form
      Returns:
      the new Option
    • addIntegerOption

      public final CmdLineParser.Option addIntegerOption(String longForm)
      Convenience method for adding an integer option.
      Parameters:
      longForm - the long form
      Returns:
      the new Option
    • addLongOption

      public final CmdLineParser.Option addLongOption(char shortForm, String longForm)
      Convenience method for adding a long integer option.
      Parameters:
      shortForm - the short form
      longForm - the long form
      Returns:
      the new Option
    • addLongOption

      public final CmdLineParser.Option addLongOption(String longForm)
      Convenience method for adding a long integer option.
      Parameters:
      longForm - the long form
      Returns:
      the new Option
    • addDoubleOption

      public final CmdLineParser.Option addDoubleOption(char shortForm, String longForm)
      Convenience method for adding a double option.
      Parameters:
      shortForm - the short form
      longForm - the long form
      Returns:
      the new Option
    • addDoubleOption

      public final CmdLineParser.Option addDoubleOption(String longForm)
      Convenience method for adding a double option.
      Parameters:
      longForm - the long form
      Returns:
      the new Option
    • addBooleanOption

      public final CmdLineParser.Option addBooleanOption(char shortForm, String longForm)
      Convenience method for adding a boolean option.
      Parameters:
      shortForm - the short form
      longForm - the long form
      Returns:
      the new Option
    • addBooleanOption

      public final CmdLineParser.Option addBooleanOption(String longForm)
      Convenience method for adding a boolean option.
      Parameters:
      longForm - the long form
      Returns:
      the new Option
    • getOptionValue

      public final Object getOptionValue(CmdLineParser.Option o)
      Parameters:
      o - the o
      Returns:
      the option value
    • getOptionValue

      public final Object getOptionValue(CmdLineParser.Option o, Object def)
      Gets the option value.
      Parameters:
      o - the o
      def - the def
      Returns:
      the parsed value of the given Option, or the given default 'def' if the option was not set
    • getOptionValues

      public final List<String> getOptionValues(CmdLineParser.Option option)
      Gets the option values.
      Parameters:
      option - the option
      Returns:
      A Vector giving the parsed values of all the occurrences of the given Option, or an empty Vector if the option was not set.
    • getRemainingArgs

      public final List<String> getRemainingArgs()
      Gets the remaining args.
      Returns:
      the non-option arguments
    • parse

      Extract the options and non-option arguments from the given list of command-line arguments. The default locale is used for parsing options whose values might be locale-specific.
      Parameters:
      argv - the argv
      Throws:
      CmdLineParser.IllegalOptionValueException - the illegal option value exception
      CmdLineParser.UnknownOptionException - the unknown option exception
    • parse

      Extract the options and non-option arguments from the given list of command-line arguments. The specified locale is used for parsing options whose values might be locale-specific.
      Parameters:
      argv - the argv
      locale - the locale
      Throws:
      CmdLineParser.IllegalOptionValueException - the illegal option value exception
      CmdLineParser.UnknownOptionException - the unknown option exception