Interface OptionDescriptor

All Known Implementing Classes:
AbstractOptionSpec, AlternativeLongOptionSpec, ArgumentAcceptingOptionSpec, NoArgumentOptionSpec, NonOptionArgumentSpec, OptionalArgumentOptionSpec, OptionSpecBuilder, RequiredArgumentOptionSpec
public interface OptionDescriptor
Describes options that an option parser recognizes, in ways that might be useful to help screens.

  • Method Details

    • options

      List<String> options()
      A set of options that are mutually synonymous.
      Returns:
      synonymous options

    • description

      String description()
      Description of this option's purpose.
      Returns:
      a description for the option

    • defaultValues

      List<?> defaultValues()
      What values will the option take if none are specified on the command line?
      Returns:
      any default values for the option

    • isRequired

      boolean isRequired()
      Is this option required on a command line?
      Returns:
      whether the option is required

    • acceptsArguments

      boolean acceptsArguments()
      Does this option accept arguments?
      Returns:
      whether the option accepts arguments

    • requiresArgument

      boolean requiresArgument()
      Does this option require an argument?
      Returns:
      whether the option requires an argument

    • argumentDescription

      String argumentDescription()
      Gives a short description of the option's argument.
      Returns:
      a description for the option's argument

    • argumentTypeIndicator

      String argumentTypeIndicator()
      Gives an indication of the expected type of the option's argument.
      Returns:
      a description for the option's argument type

    • representsNonOptions

      boolean representsNonOptions()
      Tells whether this object represents the non-option arguments of a command line.
      Returns:
      true if this represents non-option arguments