Uses of Class
picocli.CommandLine.Model.ArgSpec
Packages that use CommandLine.Model.ArgSpec
Package
Description
Provides classes and interfaces for the main picocli command line parsing and
autocompletion functionality.-
Uses of CommandLine.Model.ArgSpec in picocli
Subclasses of CommandLine.Model.ArgSpec in picocliModifier and TypeClassDescriptionstatic classTheOptionSpecclass models aspects of a named option of a command, including whether it is required or optional, the option parameters supported (or required) by the option, and attributes for the usage help message describing the option.static classThePositionalParamSpecclass models aspects of a positional parameter of a command, including whether it is required or optional, and attributes for the usage help message describing the positional parameter.Methods in picocli that return CommandLine.Model.ArgSpecModifier and TypeMethodDescriptionCommandLine.ParameterException.getArgSpec()Returns theArgSpecobject for the (sub)command whose input could not be parsed.CommandLine.OverwrittenOptionException.getOverwritten()Returns theCommandLine.Model.ArgSpecfor the option which was being overwritten.CommandLine.Model.ArgSpec.messages(CommandLine.Model.Messages msgs) Sets the Messages for this ArgSpec, and returns this ArgSpec.CommandLine.Model.ArgSpec.root()Returns the root option or positional parameter (on the parent command), if this option or positional parameter was inherited; ornullif it was not.Methods in picocli that return types with arguments of type CommandLine.Model.ArgSpecModifier and TypeMethodDescriptionCommandLine.Model.ArgGroupSpec.args()Returns the options and positional parameters in this group; may be empty but notnull.CommandLine.Model.ArgGroupSpec.Builder.args()Returns the list of options and positional parameters that depend on this group.CommandLine.Model.CommandSpec.args()Returns the list of all options and positional parameters configured for this command.CommandLine.MissingParameterException.getMissing()CommandLine.ParseResult.matchedArgs()Returns a list of matched options and positional parameters, in order they were matched on the command line.CommandLine.Model.ArgGroupSpec.requiredArgs()Returns the required options and positional parameters in this group; may be empty but notnull.CommandLine.Model.CommandSpec.requiredArgs()Returns the list of required options and positional parameters configured for this command.Methods in picocli with parameters of type CommandLine.Model.ArgSpecModifier and TypeMethodDescriptionCommandLine.Model.CommandSpec.add(CommandLine.Model.ArgSpec arg) Adds the specified option spec or positional parameter spec to the list of configured arguments to expect.CommandLine.ParseResult.Builder.add(CommandLine.Model.ArgSpec arg, int position) Adds the specifiedOptionSpecorPositionalParamSpecto the list of options and parameters that were matched on the command line.CommandLine.Model.ArgGroupSpec.Builder.addArg(CommandLine.Model.ArgSpec arg) Adds the specified argument to the list of options and positional parameters that depend on this group.voidCommandLine.IParameterConsumer.consumeParameters(Stack<String> args, CommandLine.Model.ArgSpec argSpec, CommandLine.Model.CommandSpec commandSpec) Consumes as many of the specified command line arguments as needed by popping them off the specified Stack.CommandLine.IDefaultValueProvider.defaultValue(CommandLine.Model.ArgSpec argSpec) Returns the default value for an option or positional parameter ornull.CommandLine.PropertiesDefaultProvider.defaultValue(CommandLine.Model.ArgSpec argSpec) protected booleanCommandLine.Model.ArgSpec.equalsImpl(CommandLine.Model.ArgSpec other) voidCommandLine.Help.Layout.layout(CommandLine.Model.ArgSpec argSpec, CommandLine.Help.Ansi.Text[][] cellValues) Copies the specified text values into the correct cells in theCommandLine.Help.TextTable.CommandLine.ParseResult.GroupMatch.matchedValues(CommandLine.Model.ArgSpec argSpec) Returns the values matched for the specified argument, converted to the type of the argument.booleanCommandLine.IParameterPreprocessor.preprocess(Stack<String> args, CommandLine.Model.CommandSpec commandSpec, CommandLine.Model.ArgSpec argSpec, Map<String, Object> info) Called when either the command, option or positional parameter that has this preprocessor configured was recognized by the picocli parser.CommandLine.Model.CommandSpec.remove(CommandLine.Model.ArgSpec arg) (INCUBATING) Removes the specified option spec or positional parameter spec from the list of configured arguments to expect.CommandLine.Help.IParamLabelRenderer.renderParameterLabel(CommandLine.Model.ArgSpec argSpec, CommandLine.Help.Ansi ansi, List<CommandLine.Help.Ansi.IStyle> styles) Returns a text rendering of the option parameter or positional parameter; returns an empty string""if the option is a boolean and does not take a parameter.Method parameters in picocli with type arguments of type CommandLine.Model.ArgSpecModifier and TypeMethodDescriptionprotected CommandLine.Help.Ansi.TextCommandLine.Help.createDetailedSynopsisGroupsText(Set<CommandLine.Model.ArgSpec> outparam_groupArgs) Returns a Text object containing a partial detailed synopsis showing only the options and positional parameters in the specified validating groups, starting with a" "space.protected CommandLine.Help.Ansi.TextCommandLine.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.TextCommandLine.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.TextCommandLine.Help.createDetailedSynopsisPositionalsText(Collection<CommandLine.Model.ArgSpec> done) Returns a Text object containing a partial detailed synopsis showing only the positional parameters, starting with a" "space.CommandLine.Model.ArgGroupSpec.synopsisText(CommandLine.Help.ColorScheme colorScheme, Set<CommandLine.Model.ArgSpec> outparam_groupArgs) Returns the synopsis of this group.Constructors in picocli with parameters of type CommandLine.Model.ArgSpecModifierConstructorDescriptionMissingParameterException(CommandLine commandLine, CommandLine.Model.ArgSpec missing, String msg) OverwrittenOptionException(CommandLine commandLine, CommandLine.Model.ArgSpec overwritten, String msg) ParameterException(CommandLine commandLine, String msg, Throwable t, CommandLine.Model.ArgSpec argSpec, String value) Constructs a new ParameterException with the specified CommandLine and error message.ParameterException(CommandLine commandLine, String msg, CommandLine.Model.ArgSpec argSpec, String value) Constructs a new ParameterException with the specified CommandLine and error message.Constructor parameters in picocli with type arguments of type CommandLine.Model.ArgSpecModifierConstructorDescriptionMissingParameterException(CommandLine commandLine, Collection<CommandLine.Model.ArgSpec> missing, String msg)