Uses of Class
picocli.CommandLine.Model.UsageMessageSpec
Packages that use CommandLine.Model.UsageMessageSpec
Package
Description
Provides classes and interfaces for the main picocli command line parsing and
autocompletion
functionality.-
Uses of CommandLine.Model.UsageMessageSpec in picocli
Methods in picocli that return CommandLine.Model.UsageMessageSpecModifier and TypeMethodDescriptionCommandLine.Model.UsageMessageSpec.abbreviateSynopsis
(boolean newValue) Sets whether the synopsis line(s) should show an abbreviated synopsis without detailed option names.CommandLine.Model.UsageMessageSpec.adjustLineBreaksForWideCJKCharacters
(boolean adjustForWideChars) Sets whether line breaks should take wide Chinese, Japanese and Korean characters into account, and returns this UsageMessageSpec.CommandLine.Model.UsageMessageSpec.autoWidth
(boolean detectTerminalSize) Sets whether picocli should attempt to detect the terminal size and adjust the usage help message width to take the full terminal width.CommandLine.Model.UsageMessageSpec.commandListHeading
(String newValue) Sets the optional heading preceding the subcommand list.CommandLine.Model.UsageMessageSpec.customSynopsis
(String... customSynopsis) Sets the optional custom synopsis lines to use instead of the auto-generated synopsis.CommandLine.Model.UsageMessageSpec.description
(String... description) Sets the optional text lines to use as the description of the help message, displayed between the synopsis and the options list.CommandLine.Model.UsageMessageSpec.descriptionHeading
(String newValue) Sets the heading preceding the description section.CommandLine.Model.UsageMessageSpec.exitCodeList
(Map<String, String> newValue) Sets the values to be displayed in the exit codes section: keys are exit codes, values are descriptions.CommandLine.Model.UsageMessageSpec.exitCodeListHeading
(String newValue) Sets the optional heading preceding the exit codes section, may contain"%n"
line separators.Sets the optional footer text lines displayed at the bottom of the help message.CommandLine.Model.UsageMessageSpec.footerHeading
(String newValue) Sets the optional heading preceding the footer section.Sets the optional header lines displayed at the top of the help message.CommandLine.Model.UsageMessageSpec.headerHeading
(String headerHeading) Sets the heading preceding the header section.CommandLine.Model.UsageMessageSpec.helpFactory
(CommandLine.IHelpFactory helpFactory) Sets a newIHelpFactory
to customize the usage help message.CommandLine.Model.UsageMessageSpec.hidden
(boolean value) Set the hidden flag on this command to control whether to show or hide it in the help usage text of the parent command.CommandLine.Model.UsageMessageSpec.longOptionsMaxWidth
(int newValue) Sets the maximum usage help long options column max width to the specified value.CommandLine.Model.UsageMessageSpec.messages
(CommandLine.Model.Messages msgs) Sets the Messages for this usageMessage specification, and returns this UsageMessageSpec.CommandLine.Model.UsageMessageSpec.optionListHeading
(String newValue) Sets the heading preceding the options list.CommandLine.Model.UsageMessageSpec.parameterListHeading
(String newValue) Sets the optional heading preceding the parameter list.CommandLine.Model.UsageMessageSpec.requiredOptionMarker
(char newValue) Sets the character used to prefix required options in the options list.CommandLine.Model.UsageMessageSpec.sectionKeys
(List<String> keys) Sets the section keys in the order that the usage help message should render the sections.CommandLine.Model.UsageMessageSpec.sectionMap
(Map<String, CommandLine.IHelpSectionRenderer> map) Sets the map of section keys and renderers used to construct the usage help message to a copy of the specified map.CommandLine.Model.UsageMessageSpec.showAtFileInUsageHelp
(boolean newValue) Sets whether to show a[@<filename>...]
entry in the synopsis and parameter list of the usage help message.CommandLine.Model.UsageMessageSpec.showDefaultValues
(boolean newValue) Sets whether the options list in the usage help message should show default values for all non-boolean options.CommandLine.Model.UsageMessageSpec.showEndOfOptionsDelimiterInUsageHelp
(boolean newValue) Sets whether to show a[--]
(End of Options) entry in the synopsis and options list of the usage help message.CommandLine.Model.UsageMessageSpec.sortOptions
(boolean newValue) Sets whether the options list in the usage help message should be sorted alphabetically.CommandLine.Model.UsageMessageSpec.sortSynopsis
(boolean newValue) Sets whether the options in the synopsis should be sorted alphabetically.CommandLine.Model.UsageMessageSpec.synopsisAutoIndentThreshold
(double newValue) Sets the fraction of the usage helpwidth()
that is the threshold up to which the 2nd line and subsequent lines of a multi-line synopsis should be aligned to the end of the command name.CommandLine.Model.UsageMessageSpec.synopsisHeading
(String newValue) Sets the optional heading preceding the synopsis.CommandLine.Model.UsageMessageSpec.synopsisIndent
(int newValue) Sets the indentation to use on the 2nd line and subsequent lines of a multi-line synopsis when the length of the synopsis heading and the fully qualified command name exceed thesynopsisAutoIndentThreshold()
fraction of thewidth()
,-1
by default.CommandLine.Model.UsageMessageSpec.synopsisSubcommandLabel
(String newValue) Sets the String representing the subcommands in the synopsis.CommandLine.Model.CommandSpec.usageMessage()
Returns the usage help message specification for this command.CommandLine.Model.UsageMessageSpec.width
(int newValue) Sets the maximum usage help message width to the specified value.Methods in picocli with parameters of type CommandLine.Model.UsageMessageSpecModifier and TypeMethodDescriptionCommandLine.Model.CommandSpec.usageMessage
(CommandLine.Model.UsageMessageSpec settings) Initializes the usageMessage specification for this command from the specified settings and returns this commandSpec.