Class OptionGroup

java.lang.Object
org.apache.commons.cli.OptionGroup
All Implemented Interfaces:
Serializable

public class OptionGroup extends Object implements Serializable
A group of mutually exclusive options.
See Also:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      The serial version UID.
      See Also:
    • optionMap

      private final Map<String,Option> optionMap
      hold the options
    • selected

      private String selected
      The name of the selected option
    • required

      private boolean required
      specified whether this group is required
  • Constructor Details

    • OptionGroup

      public OptionGroup()
  • Method Details

    • addOption

      public OptionGroup addOption(Option option)
      Add the specified Option to this group.
      Parameters:
      option - the option to add to this group
      Returns:
      this option group with the option added
    • getNames

      public Collection<String> getNames()
      Returns:
      the names of the options in this group as a Collection
    • getOptions

      public Collection<Option> getOptions()
      Returns:
      the options in this group as a Collection
    • getSelected

      public String getSelected()
      Returns:
      the selected option name
    • isRequired

      public boolean isRequired()
      Tests whether this option group is required.
      Returns:
      whether this option group is required
    • setRequired

      public void setRequired(boolean required)
      Parameters:
      required - specifies if this group is required
    • setSelected

      public void setSelected(Option option) throws AlreadySelectedException
      Set the selected option of this group to name.
      Parameters:
      option - the option that is selected
      Throws:
      AlreadySelectedException - if an option from this group has already been selected.
    • toString

      public String toString()
      Returns the stringified version of this OptionGroup.
      Overrides:
      toString in class Object
      Returns:
      the stringified representation of this group