public abstract class Parser extends java.lang.Object implements CommandLineParser
Parser
creates CommandLine
s.
Parser
Modifier and Type | Field and Description |
---|---|
private CommandLine |
cmd
commandline instance
|
private Options |
options
current Options
|
private java.util.List |
requiredOptions
list of required options strings
|
Constructor and Description |
---|
Parser() |
Modifier and Type | Method and Description |
---|---|
private void |
checkRequiredOptions()
Throws a
MissingOptionException if all of the
required options are no present. |
protected abstract java.lang.String[] |
flatten(Options opts,
java.lang.String[] arguments,
boolean stopAtNonOption)
Subclasses must implement this method to reduce
the
arguments that have been passed to the parse
method. |
CommandLine |
parse(Options options,
java.lang.String[] arguments)
Parses the specified
arguments
based on the specifed Options . |
CommandLine |
parse(Options opts,
java.lang.String[] arguments,
boolean stopAtNonOption)
Parses the specified
arguments
based on the specifed Options . |
void |
processArgs(Option opt,
java.util.ListIterator iter) |
private void |
processOption(java.lang.String arg,
java.util.ListIterator iter) |
private CommandLine cmd
private Options options
private java.util.List requiredOptions
protected abstract java.lang.String[] flatten(Options opts, java.lang.String[] arguments, boolean stopAtNonOption)
Subclasses must implement this method to reduce
the arguments
that have been passed to the parse
method.
opts
- The Options to parse the arguments by.args
- The arguments that have to be flattened.stopAtNonOption
- specifies whether to stop
flattening when a non option has been encounteredpublic CommandLine parse(Options options, java.lang.String[] arguments) throws ParseException
Parses the specified arguments
based on the specifed Options
.
parse
in interface CommandLineParser
options
- the Options
arguments
- the arguments
CommandLine
ParseException
- if an error occurs when parsing the
arguments.public CommandLine parse(Options opts, java.lang.String[] arguments, boolean stopAtNonOption) throws ParseException
Parses the specified arguments
based on the specifed Options
.
parse
in interface CommandLineParser
options
- the Options
arguments
- the arguments
stopAtNonOption
- specifies whether to stop
interpreting the arguments when a non option has
been encountered and to add them to the CommandLines
args list.CommandLine
ParseException
- if an error occurs when parsing the
arguments.private void checkRequiredOptions() throws MissingOptionException
Throws a MissingOptionException
if all of the
required options are no present.
MissingOptionException
public void processArgs(Option opt, java.util.ListIterator iter) throws ParseException
ParseException
private void processOption(java.lang.String arg, java.util.ListIterator iter) throws ParseException
ParseException