Package org.apache.commons.cli
Class Options
- java.lang.Object
-
- org.apache.commons.cli.Options
-
- All Implemented Interfaces:
java.io.Serializable
public class Options extends java.lang.Object implements java.io.Serializable
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.
- Version:
- $Revision: 680644 $, $Date: 2008-07-29 01:13:48 -0700 (Tue, 29 Jul 2008) $
- Author:
- bob mcwhirter (bob @ werken.com), James Strachan
- See Also:
CommandLine
, Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Options()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Options
addOption(java.lang.String opt, boolean hasArg, java.lang.String description)
Add an option that only contains a short-name.Options
addOption(java.lang.String opt, java.lang.String longOpt, boolean hasArg, java.lang.String description)
Add an option that contains a short-name and a long-name.Options
addOption(Option opt)
Adds an option instanceOptions
addOptionGroup(OptionGroup group)
Add the specified option group.Option
getOption(java.lang.String opt)
Retrieve theOption
matching the long or short name specified.OptionGroup
getOptionGroup(Option opt)
Returns the OptionGroup theopt
belongs to.java.util.Collection
getOptions()
Retrieve a read-only list of options in this setjava.util.List
getRequiredOptions()
Returns the required options.boolean
hasOption(java.lang.String opt)
java.lang.String
toString()
Dump state, suitable for debugging.
-
-
-
Constructor Detail
-
Options
public Options()
-
-
Method Detail
-
addOptionGroup
public Options addOptionGroup(OptionGroup group)
Add the specified option group.- Parameters:
group
- the OptionGroup that is to be added- Returns:
- the resulting Options instance
-
addOption
public Options addOption(java.lang.String opt, boolean hasArg, java.lang.String description)
Add an option that only contains a short-name. It may be specified as requiring an argument.- Parameters:
opt
- Short single-character name of the option.hasArg
- flag signally if an argument is required after this optiondescription
- Self-documenting description- Returns:
- the resulting Options instance
-
addOption
public Options addOption(java.lang.String opt, java.lang.String longOpt, boolean hasArg, java.lang.String description)
Add an option that contains a short-name and a long-name. It may be specified as requiring an argument.- Parameters:
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- Returns:
- the resulting Options instance
-
addOption
public Options addOption(Option opt)
Adds an option instance- Parameters:
opt
- the option that is to be added- Returns:
- the resulting Options instance
-
getOptions
public java.util.Collection getOptions()
Retrieve a read-only list of options in this set- Returns:
- read-only Collection of
Option
objects in this descriptor
-
getRequiredOptions
public java.util.List getRequiredOptions()
Returns the required options.- Returns:
- List of required options
-
getOption
public Option getOption(java.lang.String opt)
Retrieve theOption
matching the long or short name specified. The leading hyphens in the name are ignored (up to 2).- Parameters:
opt
- short or long name of theOption
- Returns:
- the option represented by opt
-
hasOption
public boolean hasOption(java.lang.String opt)
-
getOptionGroup
public OptionGroup getOptionGroup(Option opt)
Returns the OptionGroup theopt
belongs to.- Parameters:
opt
- the option whose OptionGroup is being queried.- Returns:
- the OptionGroup if
opt
is part of an OptionGroup, otherwise return null
-
toString
public java.lang.String toString()
Dump state, suitable for debugging.- Overrides:
toString
in classjava.lang.Object
- Returns:
- Stringified form of this object
-
-