Package com.aspectran.shell.command.option

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

    See Also:
    ParsedOptions, Serialized Form

    • Constructor Detail

      • Options

        public Options()

      • Options

        public Options​(boolean skipParsingAtNonOption)

    • Method Detail

      • getTitle

        public java.lang.String getTitle()

      • setTitle

        public void setTitle​(java.lang.String title)

      • isSkipParsingAtNonOption

        public boolean isSkipParsingAtNonOption()

      • setSkipParsingAtNonOption

        public void setSkipParsingAtNonOption​(boolean skipParsingAtNonOption)

      • 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​(Option opt)
        Adds an option instance.
        Parameters:
        opt - the option that is to be added
        Returns:
        the resulting Options instance

      • isEmpty

        public boolean isEmpty()
        Returns true if no options have been added.
        Returns:
        true if no options have been added

      • getAllOptions

        public java.util.Collection<Option> getAllOptions()
        Retrieve a read-only list of options in this set.
        Returns:
        read-only Collection of Option objects in this descriptor

      • getHelpOptions

        public java.util.List<Option> getHelpOptions()
        Returns the Options for use by the HelpFormatter.
        Returns:
        the List of Options

      • getRequiredOptions

        public java.util.List<java.lang.Object> getRequiredOptions()
        Returns the required options.
        Returns:
        read-only List of required options

      • getOption

        public Option getOption​(java.lang.String name)
        Retrieve the Option matching the long or short name specified.

        The leading hyphens in the name are ignored (up to 2).

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

      • getMatchingOptions

        public java.util.List<java.lang.String> getMatchingOptions​(java.lang.String name)
        Returns the options with a long name starting with the name specified.
        Parameters:
        name - the partial name of the option
        Returns:
        the options matching the partial name specified, or an empty list if none matches

      • hasOption

        public boolean hasOption​(java.lang.String name)
        Returns whether the named Option is a member of this Options.
        Parameters:
        name - short or long name of the Option
        Returns:
        true if the named Option is a member of this Options

      • hasLongOption

        public boolean hasLongOption​(java.lang.String name)
        Returns whether the named Option is a member of this Options.
        Parameters:
        name - long name of the Option
        Returns:
        true if the named Option is a member of this Options

      • hasShortOption

        public boolean hasShortOption​(java.lang.String name)
        Returns whether the named Option is a member of this Options.
        Parameters:
        name - short 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:
        the stringified form of this object