Uses of Interface
picocli.CommandLine.Help.IParamLabelRenderer
Packages that use CommandLine.Help.IParamLabelRenderer
Package
Description
Provides classes and interfaces for the main picocli command line parsing and
autocompletion functionality.-
Uses of CommandLine.Help.IParamLabelRenderer in picocli
Methods in picocli that return CommandLine.Help.IParamLabelRendererModifier and TypeMethodDescriptionCommandLine.Help.createDefaultParamLabelRenderer()Returns a new default param label renderer that separates option parameters from their option name with the specified separator string, and, unlessCommandLine.Model.ArgSpec.hideParamSyntax()is true, surrounds optional parameters with'['and']'characters and uses ellipses ("...") to indicate that any number of a parameter are allowed.CommandLine.Model.ArgGroupSpec.createLabelRenderer(CommandLine.Model.CommandSpec commandSpec) CommandLine.Help.createMinimalParamLabelRenderer()Returns a value renderer that returns theparamLabelif defined or the field name otherwise.CommandLine.Help.parameterLabelRenderer()Option and positional parameter value label renderer used for the synopsis line(s) and the option list.Methods in picocli with parameters of type CommandLine.Help.IParamLabelRendererModifier and TypeMethodDescriptionvoidCommandLine.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.voidCommandLine.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.voidCommandLine.Help.Layout.addOption(CommandLine.Model.OptionSpec option, CommandLine.Help.IParamLabelRenderer paramLabelRenderer) Delegates to theoption rendererof 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.voidCommandLine.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.voidCommandLine.Help.Layout.addPositionalParameter(CommandLine.Model.PositionalParamSpec param, CommandLine.Help.IParamLabelRenderer paramLabelRenderer) Delegates to theparameter rendererof 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.voidCommandLine.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.optionList(CommandLine.Help.Layout layout, Comparator<CommandLine.Model.OptionSpec> optionSort, CommandLine.Help.IParamLabelRenderer valueLabelRenderer) Sorts allOptionswith 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> optionList, CommandLine.Help.Layout layout, Comparator<CommandLine.Model.OptionSpec> optionSort, CommandLine.Help.IParamLabelRenderer valueLabelRenderer) Sorts allOptionswith 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.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.CommandLine.Help.parameterList(CommandLine.Help.Layout layout, CommandLine.Help.IParamLabelRenderer paramLabelRenderer) Returns the rendered section of the usage help message that lists all positional parameters in this command with their descriptions.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.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.