Package org.apache.commons.cli

Class OptionGroup

  • All Implemented Interfaces:
    Serializable
    public class OptionGroup
extends Object
implements Serializable
    A group of mutually exclusive options.
    Version:
    $Id: OptionGroup.java 1749596 2016-06-21 20:27:06Z britter $
    See Also:
    Serialized Form

    • Constructor Detail

      • OptionGroup

        public OptionGroup()

    • Method Detail

      • 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

      • 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.

      • getSelected

        public String getSelected()
        Returns:
        the selected option name

      • setRequired

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

      • isRequired

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

      • toString

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