Modifier and Type | Method | Description |
---|---|---|
CommandLine.Model.OptionSpec |
CommandLine.Model.OptionSpec.Builder.build() |
Returns a valid
OptionSpec instance. |
CommandLine.Model.OptionSpec |
CommandLine.Model.CommandSpec.findOption(char shortName) |
Returns the option with the specified short name, or
null if no option with that name is defined for this command. |
CommandLine.Model.OptionSpec |
CommandLine.Model.CommandSpec.findOption(String name) |
Returns the option with the specified name, or
null if no option with that name is defined for this command. |
CommandLine.Model.OptionSpec |
CommandLine.ParseResult.matchedOption(char shortName) |
Returns the option with the specified short name, or
null if no option with that name was matched
on the command line. |
CommandLine.Model.OptionSpec |
CommandLine.ParseResult.matchedOption(String name) |
Returns the option with the specified name, or
null if no option with that name was matched on the command line. |
Modifier and Type | Method | Description |
---|---|---|
static Comparator<CommandLine.Model.OptionSpec> |
CommandLine.Help.createShortOptionArityAndNameComparator() |
|
static Comparator<CommandLine.Model.OptionSpec> |
CommandLine.Help.createShortOptionNameComparator() |
Sorts
OptionSpecs by their option name in case-insensitive alphabetic order. |
List<CommandLine.Model.OptionSpec> |
CommandLine.ParseResult.matchedOptions() |
Returns a list of matched options, in order they were matched on the command line.
|
Set<CommandLine.Model.OptionSpec> |
CommandLine.ParseResult.matchedOptionsSet() |
Returns a set of matched options.
|
Map<String,CommandLine.Model.OptionSpec> |
CommandLine.Model.CommandSpec.negatedOptionsMap() |
Returns a map of the negated option names to option spec objects configured for this command.
|
List<CommandLine.Model.OptionSpec> |
CommandLine.Model.ArgGroupSpec.options() |
Returns the list of options configured for this group.
|
List<CommandLine.Model.OptionSpec> |
CommandLine.Model.CommandSpec.options() |
Returns the list of options configured for this command.
|
Map<String,CommandLine.Model.OptionSpec> |
CommandLine.Model.CommandSpec.optionsMap() |
Returns a map of the option names to option spec objects configured for this command.
|
Map<Character,CommandLine.Model.OptionSpec> |
CommandLine.Model.CommandSpec.posixOptionsMap() |
Returns a map of the short (single character) option names to option spec objects configured for this command.
|
Modifier and Type | Method | Description |
---|---|---|
void |
CommandLine.Help.Layout.addOption(CommandLine.Model.OptionSpec option,
CommandLine.Help.IParamLabelRenderer paramLabelRenderer) |
Delegates to the
option renderer of this layout to obtain
text values for the specified CommandLine.Model.OptionSpec , and then calls the CommandLine.Help.Layout.layout(CommandLine.Model.ArgSpec, CommandLine.Help.Ansi.Text[][])
method to write these text values into the correct cells in the TextTable. |
CommandLine.Model.CommandSpec |
CommandLine.Model.CommandSpec.addOption(CommandLine.Model.OptionSpec option) |
Adds the specified option spec to the list of configured arguments to expect.
|
CommandLine.ParseResult.Builder |
CommandLine.ParseResult.Builder.addOption(CommandLine.Model.OptionSpec option) |
Adds the specified
OptionSpec to the list of options that were matched on the command line. |
static CommandLine.Model.OptionSpec.Builder |
CommandLine.Model.OptionSpec.builder(CommandLine.Model.OptionSpec original) |
Returns a Builder initialized from the specified
OptionSpec . |
boolean |
CommandLine.ParseResult.hasMatchedOption(CommandLine.Model.OptionSpec option) |
Returns whether the specified option was matched on the command line.
|
CommandLine.Help.Ansi.Text[][] |
CommandLine.Help.IOptionRenderer.render(CommandLine.Model.OptionSpec option,
CommandLine.Help.IParamLabelRenderer parameterLabelRenderer,
CommandLine.Help.ColorScheme scheme) |
Returns a text representation of the specified option and its parameter(s) if any.
|
Modifier and Type | Method | Description |
---|---|---|
void |
CommandLine.Help.Layout.addOptions(List<CommandLine.Model.OptionSpec> options,
CommandLine.Help.IParamLabelRenderer paramLabelRenderer) |
Calls
CommandLine.Help.Layout.addOption(CommandLine.Model.OptionSpec, CommandLine.Help.IParamLabelRenderer) for all non-hidden Options in the list. |
protected CommandLine.Help.Ansi.Text |
CommandLine.Help.createDetailedSynopsisOptionsText(Collection<CommandLine.Model.ArgSpec> done,
Comparator<CommandLine.Model.OptionSpec> optionSort,
boolean clusterBooleanOptions) |
Returns a Text object containing a partial detailed synopsis showing only the options, starting with a
" " space. |
String |
CommandLine.Help.detailedSynopsis(int synopsisHeadingLength,
Comparator<CommandLine.Model.OptionSpec> optionSort,
boolean clusterBooleanOptions) |
Generates a detailed synopsis message showing all options and parameters.
|
String |
CommandLine.Help.detailedSynopsis(Comparator<CommandLine.Model.OptionSpec> optionSort,
boolean clusterBooleanOptions) |
Deprecated.
|
String |
CommandLine.Help.optionList(CommandLine.Help.Layout layout,
Comparator<CommandLine.Model.OptionSpec> optionSort,
CommandLine.Help.IParamLabelRenderer valueLabelRenderer) |
Sorts all
Options with the specified comparator (if the comparator is non-null ),
then adds all non-hidden options to the
specified TextTable and returns the result of TextTable.toString(). |
Copyright © 2017–2019. All rights reserved.