Uses of Class
picocli.CommandLine.Model.OptionSpec
Packages that use CommandLine.Model.OptionSpec
Package
Description
Provides classes and interfaces for the main picocli command line parsing and
autocompletion
functionality.-
Uses of CommandLine.Model.OptionSpec in picocli
Fields in picocli declared as CommandLine.Model.OptionSpecMethods in picocli that return CommandLine.Model.OptionSpecModifier and TypeMethodDescriptionCommandLine.Model.OptionSpec.Builder.build()
Returns a validOptionSpec
instance.CommandLine.Model.CommandSpec.findOption
(char shortName) Returns the option with the specified short name, ornull
if no option with that name is defined for this command.CommandLine.Model.CommandSpec.findOption
(String name) Returns the option with the specified name, ornull
if no option with that name is defined for this command.CommandLine.ParseResult.matchedOption
(char shortName) Returns the option with the specified short name, ornull
if no option with that name was matched on the command line.CommandLine.ParseResult.matchedOption
(String name) Returns the option with the specified name, ornull
if no option with that name was matched on the command line.Methods in picocli that return types with arguments of type CommandLine.Model.OptionSpecModifier and TypeMethodDescriptionCommandLine.Model.ArgGroupSpec.allOptionsNested()
Returns all options configured for this group and all subgroups.CommandLine.Help.createDefaultOptionSort()
Returns a comparator for sorting options, ornull
, depending on the settings for this command.CommandLine.Help.createShortOptionArityAndNameComparator()
CommandLine.Help.createShortOptionNameComparator()
SortsOptionSpecs
by their option name in case-insensitive alphabetic order.CommandLine.ParseResult.matchedOptions()
Returns a list of matched options, in order they were matched on the command line.CommandLine.ParseResult.matchedOptionsSet()
Returns a set of matched options.CommandLine.Model.CommandSpec.negatedOptionsMap()
Returns a map of the negated option names to option spec objects configured for this command.CommandLine.Model.ArgGroupSpec.options()
Returns the list of options configured for this group.CommandLine.Model.CommandSpec.options()
Returns the list of options configured for this command.CommandLine.Model.CommandSpec.optionsMap()
Returns a map of the option names to option spec objects configured for this command.CommandLine.Model.CommandSpec.posixOptionsMap()
Returns a map of the short (single character) option names to option spec objects configured for this command.Methods in picocli with parameters of type CommandLine.Model.OptionSpecModifier and TypeMethodDescriptionvoid
CommandLine.Help.Layout.addOption
(CommandLine.Model.OptionSpec option, CommandLine.Help.IParamLabelRenderer paramLabelRenderer) Delegates to theoption renderer
of this layout to obtain text values for the specifiedCommandLine.Model.OptionSpec
, and then calls theCommandLine.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.addOption
(CommandLine.Model.OptionSpec option) Adds the specified option spec to the list of configured arguments to expect.CommandLine.ParseResult.Builder.addOption
(CommandLine.Model.OptionSpec option) Adds the specifiedOptionSpec
to the list of options that were matched on the command line.CommandLine.Model.OptionSpec.builder
(CommandLine.Model.OptionSpec original) Returns a Builder initialized from the specifiedOptionSpec
.boolean
CommandLine.ParseResult.hasMatchedOption
(CommandLine.Model.OptionSpec option) Returns whether the specified option was matched on the command line.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.Method parameters in picocli with type arguments of type CommandLine.Model.OptionSpecModifier and TypeMethodDescriptionvoid
CommandLine.Help.Layout.addAllOptions
(List<CommandLine.Model.OptionSpec> options, CommandLine.Help.IParamLabelRenderer paramLabelRenderer) CallsCommandLine.Help.Layout.addOption(CommandLine.Model.OptionSpec, CommandLine.Help.IParamLabelRenderer)
for all Options in the specified list.void
CommandLine.Help.Layout.addOptions
(List<CommandLine.Model.OptionSpec> options, CommandLine.Help.IParamLabelRenderer paramLabelRenderer) CallsCommandLine.Help.Layout.addOption(CommandLine.Model.OptionSpec, CommandLine.Help.IParamLabelRenderer)
for all non-hidden Options in the list.int
CommandLine.Help.calcLongOptionColumnWidth
(List<CommandLine.Model.OptionSpec> options, List<CommandLine.Model.PositionalParamSpec> positionals, CommandLine.Help.ColorScheme aColorScheme) Returns the width of the long options column in the usage help message.CommandLine.Help.createDefaultLayout
(List<CommandLine.Model.OptionSpec> options, List<CommandLine.Model.PositionalParamSpec> positionals, CommandLine.Help.ColorScheme aColorScheme) Returns aLayout
instance configured with the user preferences captured in this Help instance.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.protected CommandLine.Help.Ansi.Text
CommandLine.Help.createDetailedSynopsisOptionsText
(Collection<CommandLine.Model.ArgSpec> done, List<CommandLine.Model.OptionSpec> optionList, Comparator<CommandLine.Model.OptionSpec> optionSort, boolean clusterBooleanOptions) Returns a Text object containing a partial detailed synopsis showing only the specified options, starting with a" "
space.protected CommandLine.Help.Ansi.Text
CommandLine.Help.createDetailedSynopsisOptionsText
(Collection<CommandLine.Model.ArgSpec> done, List<CommandLine.Model.OptionSpec> optionList, Comparator<CommandLine.Model.OptionSpec> optionSort, boolean clusterBooleanOptions) Returns a Text object containing a partial detailed synopsis showing only the specified options, starting with a" "
space.CommandLine.Help.detailedSynopsis
(int synopsisHeadingLength, Comparator<CommandLine.Model.OptionSpec> optionSort, boolean clusterBooleanOptions) Generates a detailed synopsis message showing all options and parameters.CommandLine.Help.detailedSynopsis
(Comparator<CommandLine.Model.OptionSpec> optionSort, boolean clusterBooleanOptions) Deprecated.CommandLine.Help.optionList
(CommandLine.Help.Layout layout, Comparator<CommandLine.Model.OptionSpec> optionSort, CommandLine.Help.IParamLabelRenderer valueLabelRenderer) Sorts allOptions
with the specifiedcomparator
(if the comparator is non-null
), then adds all non-hidden options to the specified TextTable and returns the result of TextTable.toString().CommandLine.Help.optionListExcludingGroups
(List<CommandLine.Model.OptionSpec> options) Returns a description of the specified list of options.CommandLine.Help.optionListExcludingGroups
(List<CommandLine.Model.OptionSpec> optionList, CommandLine.Help.Layout layout, Comparator<CommandLine.Model.OptionSpec> optionSort, CommandLine.Help.IParamLabelRenderer valueLabelRenderer) Sorts allOptions
with the specifiedcomparator
(if the comparator is non-null
), then adds the specified options to the specified TextTable and returns the result of TextTable.toString().CommandLine.Help.optionListExcludingGroups
(List<CommandLine.Model.OptionSpec> optionList, CommandLine.Help.Layout layout, Comparator<CommandLine.Model.OptionSpec> optionSort, CommandLine.Help.IParamLabelRenderer valueLabelRenderer) Sorts allOptions
with the specifiedcomparator
(if the comparator is non-null
), then adds the specified options to the specified TextTable and returns the result of TextTable.toString().
CommandLine.Help.detailedSynopsis(int, Comparator, boolean)
instead.