# Uses of Class
org.apache.commons.cli.Options

Packages that use Options
Package
Description
org.apache.commons.cli
Apache Commons CLI provides a simple API for presenting, processing, and validating a Command Line Interface.
org.apache.commons.cli.help
The help production system.

- ## Uses of Options in org.apache.commons.cli

  Fields in org.apache.commons.cli declared as Options
  Modifier and Type
  Field
  Description
  `protected Options`
  DefaultParser.`options`
  The current options.
  Methods in org.apache.commons.cli that return Options
  Modifier and Type
  Method
  Description
  `Options`
  Options.`addOption(String opt, boolean hasArg, String description)`
  Adds an option that only contains a short-name.
  `Options`
  Options.`addOption(String opt, String description)`
  Adds an option that only contains a short name.
  `Options`
  Options.`addOption(String opt, String longOpt, boolean hasArg, String description)`
  Adds an option that contains a short-name and a long-name.
  `Options`
  Options.`addOption(Option opt)`
  Adds an option instance.
  `Options`
  Options.`addOptionGroup(OptionGroup optionGroup)`
  Adds the specified option group.
  `Options`
  Options.`addOptions(Options options)`
  Adds options to this option.
  `Options`
  Options.`addRequiredOption(String opt, String longOpt, boolean hasArg, String description)`
  Adds an option that contains a short-name and a long-name.
  `protected Options`
  Parser.`getOptions()`
  Deprecated.
  Gets the options.
  `static Options`
  PatternOptionBuilder.`parsePattern(String pattern)`
  Returns the `Options` instance represented by `pattern`.
  Methods in org.apache.commons.cli with parameters of type Options
  Modifier and Type
  Method
  Description
  `Options`
  Options.`addOptions(Options options)`
  Adds options to this option.
  `protected String[]`
  BasicParser.`flatten(Options options, String[] arguments, boolean stopAtNonOption)`
  Deprecated.
  A simple implementation of `Parser`'s abstract `flatten` method.
  `protected String[]`
  GnuParser.`flatten(Options options, String[] arguments, boolean stopAtNonOption)`
  Deprecated.
  This flatten method does so using the following rules: If an `Option` exists for the first character of the `arguments` entry AND an `Option` does not exist for the whole `argument` then add the first character as an option to the processed tokens list for example "-D" and add the rest of the entry to the also. Otherwise just add the token to the processed tokens list.
  `protected abstract String[]`
  Parser.`flatten(Options opts, String[] arguments, boolean stopAtNonOption)`
  Deprecated.
  Subclasses must implement this method to reduce the `arguments` that have been passed to the parse method.
  `protected String[]`
  PosixParser.`flatten(Options options, String[] arguments, boolean stopAtNonOption)`
  Deprecated.
  An implementation of `Parser`'s abstract `flatten` method.
  `CommandLine`
  CommandLineParser.`parse(Options options, String[] arguments)`
  Parses the arguments according to the specified options.
  `CommandLine`
  CommandLineParser.`parse(Options options, String[] arguments, boolean stopAtNonOption)`
  Parses the arguments according to the specified options.
  `CommandLine`
  DefaultParser.`parse(Options options, String[] arguments)`
  `CommandLine`
  DefaultParser.`parse(Options options, String[] arguments, boolean stopAtNonOption)`
  `CommandLine`
  DefaultParser.`parse(Options options, String[] arguments, Properties properties)`
  Parses the arguments according to the specified options and properties.
  `CommandLine`
  DefaultParser.`parse(Options options, String[] arguments, Properties properties, boolean stopAtNonOption)`
  Parses the arguments according to the specified options and properties.
  `CommandLine`
  DefaultParser.`parse(Options options, Properties properties, DefaultParser.NonOptionAction nonOptionAction, String... arguments)`
  Parses the arguments according to the specified options and properties.
  `CommandLine`
  Parser.`parse(Options options, String[] arguments)`
  Deprecated.
  Parses the specified `arguments` based on the specified `Options`.
  `CommandLine`
  Parser.`parse(Options options, String[] arguments, boolean stopAtNonOption)`
  Deprecated.
  Parses the specified `arguments` based on the specified `Options`.
  `CommandLine`
  Parser.`parse(Options options, String[] arguments, Properties properties)`
  Deprecated.
  Parses the arguments according to the specified options and properties.
  `CommandLine`
  Parser.`parse(Options options, String[] arguments, Properties properties, boolean stopAtNonOption)`
  Deprecated.
  Parses the arguments according to the specified options and properties.
  `void`
  HelpFormatter.`printHelp(int width, String cmdLineSyntax, String header, Options options, String footer)`
  Deprecated.
  Prints the help for `options` with the specified command line syntax.
  `void`
  HelpFormatter.`printHelp(int width, String cmdLineSyntax, String header, Options options, String footer, boolean autoUsage)`
  Deprecated.
  Prints the help for `options` with the specified command line syntax.
  `void`
  HelpFormatter.`printHelp(PrintWriter pw, int width, String cmdLineSyntax, String header, Options options, int leftPad, int descPad, String footer)`
  Deprecated.
  Prints the help for `options` with the specified command line syntax.
  `void`
  HelpFormatter.`printHelp(PrintWriter pw, int width, String cmdLineSyntax, String header, Options options, int leftPad, int descPad, String footer, boolean autoUsage)`
  Deprecated.
  Prints the help for `options` with the specified command line syntax.
  `void`
  HelpFormatter.`printHelp(String cmdLineSyntax, String header, Options options, String footer)`
  Deprecated.
  Prints the help for `options` with the specified command line syntax.
  `void`
  HelpFormatter.`printHelp(String cmdLineSyntax, String header, Options options, String footer, boolean autoUsage)`
  Deprecated.
  Prints the help for `options` with the specified command line syntax.
  `void`
  HelpFormatter.`printHelp(String cmdLineSyntax, Options options)`
  Deprecated.
  Prints the help for `options` with the specified command line syntax.
  `void`
  HelpFormatter.`printHelp(String cmdLineSyntax, Options options, boolean autoUsage)`
  Deprecated.
  Prints the help for `options` with the specified command line syntax.
  `void`
  HelpFormatter.`printOptions(PrintWriter pw, int width, Options options, int leftPad, int descPad)`
  Deprecated.
  Prints the help for the specified Options to the specified writer, using the specified width, left padding and description padding.
  `void`
  HelpFormatter.`printUsage(PrintWriter pw, int width, String app, Options options)`
  Deprecated.
  Prints the usage statement for the specified application.
  `protected StringBuffer`
  HelpFormatter.`renderOptions(StringBuffer sb, int width, Options options, int leftPad, int descPad)`
  Deprecated.
  Renders the specified Options and return the rendered Options in a StringBuffer.
  `protected void`
  Parser.`setOptions(Options options)`
  Deprecated.
  Sets the options.

- ## Uses of Options in org.apache.commons.cli.help

  Methods in org.apache.commons.cli.help with parameters of type Options
  Modifier and Type
  Method
  Description
  `void`
  AbstractHelpFormatter.`printHelp(String cmdLineSyntax, String header, Options options, String footer, boolean autoUsage)`
  Prints the help for a collection of `Option`s with the specified command line syntax.
  `final void`
  AbstractHelpFormatter.`printOptions(Options options)`
  Prints the option table for the specified `Options` to the `HelpAppendable`.
  `List<Option>`
  AbstractHelpFormatter.`sort(Options options)`
  Creates a new list of options ordered by the comparator.
  `String`
  AbstractHelpFormatter.`toSyntaxOptions(Options options)`
  Return the string representation of the options as used in the syntax display.