Uses of Class
picocli.CommandLine.Model.PositionalParamSpec
Packages that use CommandLine.Model.PositionalParamSpec
Package
Description
Provides classes and interfaces for the main picocli command line parsing and
autocompletion
functionality.-
Uses of CommandLine.Model.PositionalParamSpec in picocli
Fields in picocli declared as CommandLine.Model.PositionalParamSpecMethods in picocli that return CommandLine.Model.PositionalParamSpecModifier and TypeMethodDescriptionCommandLine.Model.PositionalParamSpec.Builder.build()
Returns a validPositionalParamSpec
instance.CommandLine.ParseResult.matchedPositional
(int position) Returns the firstPositionalParamSpec
that matched an argument at the specified position, ornull
if no positional parameters were matched at that position.Methods in picocli that return types with arguments of type CommandLine.Model.PositionalParamSpecModifier and TypeMethodDescriptionCommandLine.Model.ArgGroupSpec.allPositionalParametersNested()
Returns all positional parameters configured for this group and all subgroups.CommandLine.ParseResult.matchedPositionals()
Returns a list of matched positional parameters, in order they were matched on the command line.CommandLine.ParseResult.matchedPositionals
(int position) Returns allPositionalParamSpec
objects that matched an argument at the specified position, or an empty list if no positional parameters were matched at that position.CommandLine.ParseResult.matchedPositionalsSet()
Returns a set of matched positional parameters.CommandLine.Model.ArgGroupSpec.positionalParameters()
Returns the list of positional parameters configured for this group.CommandLine.Model.CommandSpec.positionalParameters()
Returns the list of positional parameters configured for this command.Methods in picocli with parameters of type CommandLine.Model.PositionalParamSpecModifier and TypeMethodDescriptionCommandLine.Model.CommandSpec.addPositional
(CommandLine.Model.PositionalParamSpec positional) Adds the specified positional parameter spec to the list of configured arguments to expect.CommandLine.ParseResult.Builder.addPositionalParam
(CommandLine.Model.PositionalParamSpec positionalParam, int position) Adds the specifiedPositionalParamSpec
to the list of parameters that were matched on the command line.void
CommandLine.Help.Layout.addPositionalParameter
(CommandLine.Model.PositionalParamSpec param, CommandLine.Help.IParamLabelRenderer paramLabelRenderer) Delegates to theparameter renderer
of this layout to obtain text values for the specified positional parameter, and then callsCommandLine.Help.Layout.layout(CommandLine.Model.ArgSpec, CommandLine.Help.Ansi.Text[][])
to write these text values into the correct cells in the TextTable.CommandLine.Model.PositionalParamSpec.builder
(CommandLine.Model.PositionalParamSpec original) Returns a Builder initialized from the specifiedPositionalSpec
.boolean
CommandLine.ParseResult.hasMatchedPositional
(CommandLine.Model.PositionalParamSpec positional) Returns whether the specified positional parameter was matched on the command line.CommandLine.Help.IParameterRenderer.render
(CommandLine.Model.PositionalParamSpec param, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer, CommandLine.Help.ColorScheme scheme) Returns a text representation of the specified positional parameter.Method parameters in picocli with type arguments of type CommandLine.Model.PositionalParamSpecModifier and TypeMethodDescriptionvoid
CommandLine.Help.Layout.addAllPositionalParameters
(List<CommandLine.Model.PositionalParamSpec> params, CommandLine.Help.IParamLabelRenderer paramLabelRenderer) CallsCommandLine.Help.Layout.addPositionalParameter(CommandLine.Model.PositionalParamSpec, CommandLine.Help.IParamLabelRenderer)
for all positional parameters in the specified list.void
CommandLine.Help.Layout.addPositionalParameters
(List<CommandLine.Model.PositionalParamSpec> params, CommandLine.Help.IParamLabelRenderer paramLabelRenderer) CallsCommandLine.Help.Layout.addPositionalParameter(CommandLine.Model.PositionalParamSpec, CommandLine.Help.IParamLabelRenderer)
for all non-hidden Parameters in the list.CommandLine.Help.parameterList
(List<CommandLine.Model.PositionalParamSpec> positionalParams) Returns the rendered positional parameters section of the usage help message for the specified positional parameters.CommandLine.Help.parameterList
(List<CommandLine.Model.PositionalParamSpec> positionalParams, CommandLine.Help.Layout layout, CommandLine.Help.IParamLabelRenderer paramLabelRenderer) Returns the rendered section of the usage help message that lists the specified parameters with their descriptions.