org.apache.commons.cli
Class Options
Main entry-point into the library.
Options represents a collection of
Option
objects, which
describe the possible options for a command-line.
It may flexibly parse long and short options, with or without
values. Additionally, it may parse only a portion of a commandline,
allowing for flexible multi-stage parsing.
private Map | longOpts - a map of the options with the long key
|
private Map | optionGroups - a map of the option groups
|
private List | requiredOpts - a map of the required options
|
private Map | shortOpts - a map of the options with the character key
|
Options() - Construct a new Options descriptor
|
longOpts
private Map longOpts
a map of the options with the long key
optionGroups
private Map optionGroups
a map of the option groups
requiredOpts
private List requiredOpts
a map of the required options
shortOpts
private Map shortOpts
a map of the options with the character key
Options
public Options()
Construct a new Options descriptor
addOption
public Options addOption(String opt,
String longOpt,
boolean hasArg,
String description)
Add an option that contains a short-name and a long-name
It may be specified as requiring an argument.
opt
- Short single-character name of the option.longOpt
- Long multi-character name of the option.hasArg
- flag signally if an argument is required after this optiondescription
- Self-documenting description
- the resulting Options instance
addOption
public Options addOption(String opt,
boolean hasArg,
String description)
Add an option that only contains a short-name
It may be specified as requiring an argument.
opt
- Short single-character name of the option.hasArg
- flag signally if an argument is required after this optiondescription
- Self-documenting description
- the resulting Options instance
addOption
public Options addOption(Option opt)
Adds an option instance
opt
- the option that is to be added
- the resulting Options instance
addOptionGroup
public Options addOptionGroup(OptionGroup group)
Add the specified option group.
group
- the OptionGroup that is to be added
- the resulting Options instance
getOption
public Option getOption(String opt)
opt
- short or long name of the Option
- the option represented by opt
getOptionGroup
public OptionGroup getOptionGroup(Option opt)
Returns the OptionGroup the opt
belongs to.
opt
- the option whose OptionGroup is being queried.
- the OptionGroup if
opt
is part
of an OptionGroup, otherwise return null
getOptions
public Collection getOptions()
Retrieve a read-only list of options in this set
- read-only Collection of
Option
objects in this descriptor
getRequiredOptions
public List getRequiredOptions()
Returns the required options as a
java.util.Collection
.
- Collection of required options
hasOption
public boolean hasOption(String opt)
opt
- short or long name of the Option
helpOptions
(package private) List helpOptions()
Returns the Options for use by the HelpFormatter.
toString
public String toString()
Dump state, suitable for debugging.
- Stringified form of this object