Package org.apache.commons.cli
Class Parser
java.lang.Object
org.apache.commons.cli.Parser
- All Implemented Interfaces:
CommandLineParser
- Direct Known Subclasses:
BasicParser,GnuParser,PosixParser
Deprecated.
since 1.3, the two-pass parsing with the flatten method is not enough flexible to handle complex cases
Parser creates CommandLines.-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidDeprecated.Throws aMissingOptionExceptionif all of the required options are not present.protected abstract String[]Deprecated.Subclasses must implement this method to reduce theargumentsthat have been passed to the parse method.protected OptionsDeprecated.Gets the options.protected ListDeprecated.Gets the required options.Deprecated.Parses the specifiedargumentsbased on the specifiedOptions.Deprecated.Parses the specifiedargumentsbased on the specifiedOptions.parse(Options options, String[] arguments, Properties properties) Deprecated.Parse the arguments according to the specified options and properties.parse(Options options, String[] arguments, Properties properties, boolean stopAtNonOption) Deprecated.Parse the arguments according to the specified options and properties.voidprocessArgs(Option opt, ListIterator<String> iter) Deprecated.Process the argument values for the specified Optionoptusing the values retrieved from the specified iteratoriter.protected voidprocessOption(String arg, ListIterator<String> iter) Deprecated.Process the Option specified byargusing the values retrieved from the specified iteratoriter.protected voidprocessProperties(Properties properties) Deprecated.Sets the values of Options using the values inproperties.protected voidsetOptions(Options options) Deprecated.Sets the options.
-
Field Details
-
cmd
Deprecated.CommandLine instance
-
-
Constructor Details
-
Parser
public Parser()Deprecated.
-
-
Method Details
-
checkRequiredOptions
Deprecated.Throws aMissingOptionExceptionif all of the required options are not present.- Throws:
MissingOptionException- if any of the required Options are not present.
-
flatten
protected abstract String[] flatten(Options opts, String[] arguments, boolean stopAtNonOption) throws ParseException Deprecated.Subclasses must implement this method to reduce theargumentsthat have been passed to the parse method.- Parameters:
opts- The Options to parse the arguments by.arguments- The arguments that have to be flattened.stopAtNonOption- specifies whether to stop flattening when a non option has been encountered- Returns:
- a String array of the flattened arguments
- Throws:
ParseException- if there are any problems encountered while parsing the command line tokens.
-
getOptions
Deprecated.Gets the options.- Returns:
- the options.
-
getRequiredOptions
Deprecated.Gets the required options.- Returns:
- the required options.
-
parse
Deprecated.Parses the specifiedargumentsbased on the specifiedOptions.- Specified by:
parsein interfaceCommandLineParser- Parameters:
options- theOptionsarguments- thearguments- Returns:
- the
CommandLine - Throws:
ParseException- if there are any problems encountered while parsing the command line tokens.
-
parse
public CommandLine parse(Options options, String[] arguments, boolean stopAtNonOption) throws ParseException Deprecated.Parses the specifiedargumentsbased on the specifiedOptions.- Specified by:
parsein interfaceCommandLineParser- Parameters:
options- theOptionsarguments- theargumentsstopAtNonOption- iftruean unrecognized argument stops the parsing and the remaining arguments are added to theCommandLines args list. Iffalsean unrecognized argument triggers a ParseException.- Returns:
- the
CommandLine - Throws:
ParseException- if an error occurs when parsing the arguments.
-
parse
public CommandLine parse(Options options, String[] arguments, Properties properties) throws ParseException Deprecated.Parse the arguments according to the specified options and properties.- Parameters:
options- the specified Optionsarguments- the command line argumentsproperties- command line option name-value pairs- Returns:
- the list of atomic option and value tokens
- Throws:
ParseException- if there are any problems encountered while parsing the command line tokens.- Since:
- 1.1
-
parse
public CommandLine parse(Options options, String[] arguments, Properties properties, boolean stopAtNonOption) throws ParseException Deprecated.Parse the arguments according to the specified options and properties.- Parameters:
options- the specified Optionsarguments- the command line argumentsproperties- command line option name-value pairsstopAtNonOption- iftruean unrecognized argument stops the parsing and the remaining arguments are added to theCommandLines args list. Iffalsean unrecognized argument triggers a ParseException.- Returns:
- the list of atomic option and value tokens
- Throws:
ParseException- if there are any problems encountered while parsing the command line tokens.- Since:
- 1.1
-
processArgs
Deprecated.Process the argument values for the specified Optionoptusing the values retrieved from the specified iteratoriter.- Parameters:
opt- The current Optioniter- The iterator over the flattened command line Options.- Throws:
ParseException- if an argument value is required and it is has not been found.
-
processOption
Deprecated.Process the Option specified byargusing the values retrieved from the specified iteratoriter.- Parameters:
arg- The String value representing an Optioniter- The iterator over the flattened command line arguments.- Throws:
ParseException- ifargdoes not represent an Option
-
processProperties
Deprecated.Sets the values of Options using the values inproperties.- Parameters:
properties- The value properties to be processed.- Throws:
ParseException- if there are any problems encountered while processing the properties.
-
setOptions
Deprecated.Sets the options.- Parameters:
options- the options.
-