public class CmdLineParser extends Object
CommandLineInterpreter
Modifier and Type | Class and Description |
---|---|
static class |
CmdLineParser.IllegalOptionValueException
Thrown when an illegal or missing value is given by the user for
an option that takes a value.
|
static class |
CmdLineParser.NotFlagException
Thrown when the parsed commandline contains multiple concatenated
short options, such as -abcd, where one or more requires a value.
|
static class |
CmdLineParser.Option
Representation of a command-line option
|
static class |
CmdLineParser.OptionException
Base class for exceptions that may be thrown when options are parsed
|
static class |
CmdLineParser.UnknownOptionException
Thrown when the parsed command-line contains an option that is not
recognised.
|
static class |
CmdLineParser.UnknownSuboptionException
Thrown when the parsed commandline contains multiple concatenated
short options, such as -abcd, where one is unknown.
|
Constructor and Description |
---|
CmdLineParser() |
Modifier and Type | Method and Description |
---|---|
CmdLineParser.Option |
addBooleanOption(char shortForm,
String longForm)
Convenience method for adding a boolean option.
|
CmdLineParser.Option |
addBooleanOption(String longForm)
Convenience method for adding a boolean option.
|
CmdLineParser.Option |
addDoubleOption(char shortForm,
String longForm)
Convenience method for adding a double option.
|
CmdLineParser.Option |
addDoubleOption(String longForm)
Convenience method for adding a double option.
|
CmdLineParser.Option |
addIntegerOption(char shortForm,
String longForm)
Convenience method for adding an integer option.
|
CmdLineParser.Option |
addIntegerOption(String longForm)
Convenience method for adding an integer option.
|
CmdLineParser.Option |
addLongOption(char shortForm,
String longForm)
Convenience method for adding a long integer option.
|
CmdLineParser.Option |
addLongOption(String longForm)
Convenience method for adding a long integer option.
|
CmdLineParser.Option |
addStringOption(char shortForm,
String longForm)
Convenience method for adding a string option.
|
CmdLineParser.Option |
addStringOption(String longForm)
Convenience method for adding a string option.
|
Object |
getOptionValue(CmdLineParser.Option o)
Equivalent to
getOptionValue(o,
null) . |
Vector |
getOptionValues(CmdLineParser.Option option) |
String[] |
getRemainingArgs() |
void |
parse(String[] argv)
Extract the options and non-option arguments from the given
list of command-line arguments.
|
public final CmdLineParser.Option addStringOption(char shortForm, String longForm)
shortForm
- The short form for this optionlongForm
- The long form for this optionpublic final CmdLineParser.Option addStringOption(String longForm)
longForm
- The long form for this optionpublic final CmdLineParser.Option addIntegerOption(char shortForm, String longForm)
shortForm
- The short form for this optionlongForm
- The long form for this optionpublic final CmdLineParser.Option addIntegerOption(String longForm)
longForm
- The long form for this optionpublic final CmdLineParser.Option addLongOption(char shortForm, String longForm)
shortForm
- The short form for this optionlongForm
- The long form for this optionpublic final CmdLineParser.Option addLongOption(String longForm)
longForm
- The long form for this optionpublic final CmdLineParser.Option addDoubleOption(char shortForm, String longForm)
shortForm
- The short form for this optionlongForm
- The long form for this optionpublic final CmdLineParser.Option addDoubleOption(String longForm)
longForm
- The long form for this optionpublic final CmdLineParser.Option addBooleanOption(char shortForm, String longForm)
shortForm
- The short form for this optionlongForm
- The long form for this optionpublic final CmdLineParser.Option addBooleanOption(String longForm)
longForm
- The long form for this optionpublic final Object getOptionValue(CmdLineParser.Option o)
getOptionValue(o,
null)
.public final Vector getOptionValues(CmdLineParser.Option option)
public final String[] getRemainingArgs()
public final void parse(String[] argv) throws CmdLineParser.IllegalOptionValueException, CmdLineParser.UnknownOptionException
Copyright © 2003-2016, The Apache Software Foundation. All Rights Reserved. Generated 20160718-1621