org.apache.commons.cli
Class Options

java.lang.Object
  |
  +--org.apache.commons.cli.Options

public class Options
extends java.lang.Object

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: 1.5 $
Author:
bob mcwhirter (bob @ werken.com), James Strachan
See Also:
CommandLine

Field Summary
private  java.util.Map longOpts
          a map of the options with the long key
private  java.util.Map optionGroups
          a map of the option groups
private  java.util.List requiredOpts
          a map of the required options
private  java.util.Map shortOpts
          a map of the options with the character key
 
Constructor Summary
Options()
          Construct a new Options descriptor
 
Method Summary
 Options addOption(Option opt)
          Adds an option instance
 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 addOptionGroup(OptionGroup group)
          Add the specified option group.
 Option getOption(java.lang.String opt)
          Retrieve the named Option
 OptionGroup getOptionGroup(Option opt)
          Returns the OptionGroup the opt belongs to.
 java.util.Collection getOptions()
          Retrieve a read-only list of options in this set
 java.util.List getRequiredOptions()
          Returns the required options as a java.util.Collection.
 boolean hasOption(java.lang.String opt)
          Returns whether the named Option is a member of this Options
(package private)  java.util.List helpOptions()
          Returns the Options for use by the HelpFormatter.
 java.lang.String toString()
          Dump state, suitable for debugging.
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

shortOpts

private java.util.Map shortOpts
a map of the options with the character key

longOpts

private java.util.Map longOpts
a map of the options with the long key

requiredOpts

private java.util.List requiredOpts
a map of the required options

optionGroups

private java.util.Map optionGroups
a map of the option groups
Constructor Detail

Options

public Options()

Construct a new Options descriptor

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 option
description - 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 option
description - 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

helpOptions

java.util.List helpOptions()

Returns the Options for use by the HelpFormatter.

Returns:
the List of Options

getRequiredOptions

public java.util.List getRequiredOptions()

Returns the required options as a java.util.Collection.

Returns:
Collection of required options

getOption

public Option getOption(java.lang.String opt)

Retrieve the named Option

Parameters:
opt - short or long name of the Option
Returns:
the option represented by opt

hasOption

public boolean hasOption(java.lang.String opt)

Returns whether the named Option is a member of this Options

Parameters:
opt - short or long name of the Option
Returns:
true if the named Option is a member of this Options

getOptionGroup

public OptionGroup getOptionGroup(Option opt)

Returns the OptionGroup the opt 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 class java.lang.Object
Returns:
Stringified form of this object