Uses of Class
picocli.CommandLine.Model.PositionalParamSpec
-
Packages that use CommandLine.Model.PositionalParamSpec Package Description picocli Provides classes and interfaces for the main picocli command line parsing andautocompletion
functionality.picocli.codegen.docgen.manpage -
-
Uses of CommandLine.Model.PositionalParamSpec in picocli
Fields in picocli declared as CommandLine.Model.PositionalParamSpec Modifier and Type Field Description CommandLine.Model.PositionalParamSpec
CommandLine.Help. AT_FILE_POSITIONAL_PARAM
Fields in picocli with type parameters of type CommandLine.Model.PositionalParamSpec Modifier and Type Field Description private java.util.List<java.util.List<CommandLine.Model.PositionalParamSpec>>
CommandLine.ParseResult. matchedPositionalParams
private java.util.List<CommandLine.Model.PositionalParamSpec>
CommandLine.ParseResult. matchedPositionals
private java.util.List<CommandLine.Model.PositionalParamSpec>
CommandLine.ParseResult.Builder. matchedPositionalsList
private java.util.Set<CommandLine.Model.PositionalParamSpec>
CommandLine.ParseResult. matchedUniquePositionals
private java.util.List<CommandLine.Model.PositionalParamSpec>
CommandLine.Model.CommandSpec. positionalParameters
private java.util.List<java.util.List<CommandLine.Model.PositionalParamSpec>>
CommandLine.ParseResult.Builder. positionalParams
private java.util.Set<CommandLine.Model.PositionalParamSpec>
CommandLine.ParseResult.Builder. positionals
Methods in picocli that return CommandLine.Model.PositionalParamSpec Modifier and Type Method Description CommandLine.Model.PositionalParamSpec
CommandLine.Model.PositionalParamSpec.Builder. build()
Returns a validPositionalParamSpec
instance.CommandLine.Model.PositionalParamSpec
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.PositionalParamSpec Modifier and Type Method Description private java.util.List<CommandLine.Model.PositionalParamSpec>
CommandLine.Model.ArgGroupSpec. addGroupPositionalsToListRecursively(java.util.List<CommandLine.Model.PositionalParamSpec> result)
java.util.List<CommandLine.Model.PositionalParamSpec>
CommandLine.Model.ArgGroupSpec. allPositionalParametersNested()
Returns all positional parameters configured for this group and all subgroups.private java.util.List<CommandLine.Model.PositionalParamSpec>
CommandLine.Help. excludeHiddenAndGroupParams(java.util.List<CommandLine.Model.PositionalParamSpec> all)
java.util.List<CommandLine.Model.PositionalParamSpec>
CommandLine.ParseResult. matchedPositionals()
Returns a list of matched positional parameters, in order they were matched on the command line.java.util.List<CommandLine.Model.PositionalParamSpec>
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.java.util.Set<CommandLine.Model.PositionalParamSpec>
CommandLine.ParseResult. matchedPositionalsSet()
Returns a set of matched positional parameters.(package private) java.util.List<CommandLine.Model.PositionalParamSpec>
CommandLine.Help. positionalParameters()
java.util.List<CommandLine.Model.PositionalParamSpec>
CommandLine.Model.ArgGroupSpec. positionalParameters()
Returns the list of positional parameters configured for this group.java.util.List<CommandLine.Model.PositionalParamSpec>
CommandLine.Model.CommandSpec. positionalParameters()
Returns the list of positional parameters configured for this command.Methods in picocli with parameters of type CommandLine.Model.PositionalParamSpec Modifier and Type Method Description private static void
AutoComplete. addCandidatesForArgsFollowing(CommandLine.Model.PositionalParamSpec positionalSpec, java.util.List<java.lang.CharSequence> candidates)
CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. addPositional(CommandLine.Model.PositionalParamSpec positional)
Adds the specified positional parameter spec to the list of configured arguments to expect.CommandLine.ParseResult.Builder
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.private void
CommandLine.Model.CommandSpec. adjustRelativeIndices(CommandLine.Model.PositionalParamSpec newlyAdded)
Adjusts the index of the new positional param and all others with relative indices that were sorted after this positional.static CommandLine.Model.PositionalParamSpec.Builder
CommandLine.Model.PositionalParamSpec. builder(CommandLine.Model.PositionalParamSpec original)
Returns a Builder initialized from the specifiedPositionalSpec
.(package private) boolean
CommandLine.ParseResult.GroupMatchContainer. canMatchPositionalParam(CommandLine.Model.PositionalParamSpec positionalParam)
(package private) static CommandLine.Help.Ansi.Text
CommandLine.Help. concatPositionalText(java.lang.String prefix, CommandLine.Help.Ansi.Text text, CommandLine.Help.ColorScheme colorScheme, CommandLine.Model.PositionalParamSpec positionalParam, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer)
private CommandLine.Help.Ansi.Text
CommandLine.Model.ArgGroupSpec. concatPositionalText(java.lang.String prefix, CommandLine.Help.Ansi.Text text, CommandLine.Help.ColorScheme colorScheme, CommandLine.Model.PositionalParamSpec positionalParam)
private static CommandLine.Model.CommandSpec
AutoComplete. findCommandFor(CommandLine.Model.PositionalParamSpec positional, CommandLine.Model.CommandSpec commandSpec)
private static void
AutoComplete. generatePositionParamCompletionCandidates(java.lang.StringBuilder buff, CommandLine.Model.PositionalParamSpec f)
boolean
CommandLine.ParseResult. hasMatchedPositional(CommandLine.Model.PositionalParamSpec positional)
Returns whether the specified positional parameter was matched on the command line.private <T> T
CommandLine.ParseResult. matchedPositionalValue(CommandLine.Model.PositionalParamSpec positional, T defaultValue)
Returns the command line argument value of the specified positional parameter, converted to the type of the positional parameter, or the specified default value if the specified positional parameter isnull
.private java.lang.String
CommandLine.PropertiesDefaultProvider. positionalDefaultValue(CommandLine.Model.PositionalParamSpec positional)
CommandLine.Help.Ansi.Text[][]
CommandLine.Help.DefaultParameterRenderer. render(CommandLine.Model.PositionalParamSpec param, CommandLine.Help.IParamLabelRenderer paramLabelRenderer, CommandLine.Help.ColorScheme scheme)
CommandLine.Help.Ansi.Text[][]
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.CommandLine.Help.Ansi.Text[][]
CommandLine.Help.MinimalParameterRenderer. render(CommandLine.Model.PositionalParamSpec param, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer, CommandLine.Help.ColorScheme scheme)
Method parameters in picocli with type arguments of type CommandLine.Model.PositionalParamSpec Modifier and Type Method Description void
CommandLine.Help.Layout. addAllPositionalParameters(java.util.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.private java.util.List<CommandLine.Model.PositionalParamSpec>
CommandLine.Model.ArgGroupSpec. addGroupPositionalsToListRecursively(java.util.List<CommandLine.Model.PositionalParamSpec> result)
void
CommandLine.Help.Layout. addPositionalParameters(java.util.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.private static java.lang.String
CommandLine. createMissingParameterMessage(CommandLine.Model.ArgSpec argSpec, CommandLine.Range arity, java.util.List<CommandLine.Model.PositionalParamSpec> missingList, java.util.Stack<java.lang.String> args, int available)
private java.util.List<CommandLine.Model.PositionalParamSpec>
CommandLine.Help. excludeHiddenAndGroupParams(java.util.List<CommandLine.Model.PositionalParamSpec> all)
private static java.lang.String
AutoComplete. generatePositionalParamsCases(java.util.List<CommandLine.Model.PositionalParamSpec> posParams, java.lang.String indent, java.lang.String currWord)
java.lang.String
CommandLine.Help. parameterList(java.util.List<CommandLine.Model.PositionalParamSpec> positionalParams)
Returns the rendered positional parameters section of the usage help message for the specified positional parameters.java.lang.String
CommandLine.Help. parameterList(java.util.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.private static void
CommandLine. validatePositionalParameters(java.util.List<CommandLine.Model.PositionalParamSpec> positionals)
Constructors in picocli with parameters of type CommandLine.Model.PositionalParamSpec Constructor Description Builder(CommandLine.Model.PositionalParamSpec original)
-
Uses of CommandLine.Model.PositionalParamSpec in picocli.codegen.docgen.manpage
Methods in picocli.codegen.docgen.manpage with parameters of type CommandLine.Model.PositionalParamSpec Modifier and Type Method Description private static void
ManPageGenerator. writePositional(java.io.PrintWriter pw, CommandLine.Model.PositionalParamSpec positional, CommandLine.Help.IParameterRenderer parameterRenderer, CommandLine.Help.IParamLabelRenderer paramLabelRenderer)
-