Class CommandLine.Model.UsageMessageSpec
- java.lang.Object
-
- picocli.CommandLine.Model.UsageMessageSpec
-
- Enclosing class:
- CommandLine.Model
public static class CommandLine.Model.UsageMessageSpec extends java.lang.ObjectModels the usage help message specification and can be used to customize the usage help message.This class provides two ways to customize the usage help message:
- Change the text of the predefined sections (this may also be done declaratively using the annotations)
- Add custom sections, or remove or re-order predefined sections
The pre-defined sections have getters and setters that return a String (or array of Strings). For example:
description()anddescription(String...)orheader()andheader(String...).Changing the section order, or adding custom sections can be accomplished with
sectionKeys(List)andsectionMap(Map). This gives complete freedom on how a usage help message section is rendered, but it also means that the section renderer is responsible for all aspects of rendering the section, including layout and emitting ANSI escape codes. TheCommandLine.Help.TextTableandCommandLine.Help.Ansi.Textclasses, and theCommandLine.Help.Ansi.string(String)andCommandLine.Help.Ansi.text(String)methods may be useful.The usage help message is created more or less like this:
// CommandLine.usage(...) or CommandLine.getUsageMessage(...) Help.ColorScheme colorScheme = Help.defaultColorScheme(Help.Ansi.AUTO); Help help = getHelpFactory().create(getCommandSpec(), colorScheme) StringBuilder result = new StringBuilder(); for (String key : getHelpSectionKeys()) { IHelpSectionRenderer renderer = getHelpSectionMap().get(key); if (renderer != null) { result.append(renderer.render(help)); } } // return or print resultWhere the default help section map is constructed like this:
// The default section renderers delegate to methods in Help for their implementation // (using Java 8 lambda notation for brevity): Map<String, IHelpSectionRenderer> sectionMap = new HashMap<>(); sectionMap.put(SECTION_KEY_HEADER_HEADING, help -> help.headerHeading()); sectionMap.put(SECTION_KEY_HEADER, help -> help.header()); sectionMap.put(SECTION_KEY_SYNOPSIS_HEADING, help -> help.synopsisHeading()); //e.g. Usage: sectionMap.put(SECTION_KEY_SYNOPSIS, help -> help.synopsis(help.synopsisHeadingLength())); //e.g. <cmd> [OPTIONS] <subcmd> [COMMAND-OPTIONS] [ARGUMENTS] sectionMap.put(SECTION_KEY_DESCRIPTION_HEADING, help -> help.descriptionHeading()); //e.g. %nDescription:%n%n sectionMap.put(SECTION_KEY_DESCRIPTION, help -> help.description()); //e.g. {"Converts foos to bars.", "Use options to control conversion mode."} sectionMap.put(SECTION_KEY_PARAMETER_LIST_HEADING, help -> help.parameterListHeading()); //e.g. %nPositional parameters:%n%n sectionMap.put(SECTION_KEY_PARAMETER_LIST, help -> help.parameterList()); //e.g. [FILE...] the files to convert sectionMap.put(SECTION_KEY_OPTION_LIST_HEADING, help -> help.optionListHeading()); //e.g. %nOptions:%n%n sectionMap.put(SECTION_KEY_OPTION_LIST, help -> help.optionList()); //e.g. -h, --help displays this help and exits sectionMap.put(SECTION_KEY_COMMAND_LIST_HEADING, help -> help.commandListHeading()); //e.g. %nCommands:%n%n sectionMap.put(SECTION_KEY_COMMAND_LIST, help -> help.commandList()); //e.g. add adds the frup to the frooble sectionMap.put(SECTION_KEY_EXIT_CODE_LIST_HEADING, help -> help.exitCodeListHeading()); sectionMap.put(SECTION_KEY_EXIT_CODE_LIST, help -> help.exitCodeList()); sectionMap.put(SECTION_KEY_FOOTER_HEADING, help -> help.footerHeading()); sectionMap.put(SECTION_KEY_FOOTER, help -> help.footer());- Since:
- 3.0
-
-
Field Summary
Fields Modifier and Type Field Description static intDEFAULT_USAGE_WIDTHConstant holding the default usage message width:80.static java.lang.StringSECTION_KEY_AT_FILE_PARAMETERstatic java.lang.StringSECTION_KEY_COMMAND_LISTstatic java.lang.StringSECTION_KEY_COMMAND_LIST_HEADINGstatic java.lang.StringSECTION_KEY_DESCRIPTIONstatic java.lang.StringSECTION_KEY_DESCRIPTION_HEADINGstatic java.lang.StringSECTION_KEY_END_OF_OPTIONSstatic java.lang.StringSECTION_KEY_EXIT_CODE_LISTstatic java.lang.StringSECTION_KEY_EXIT_CODE_LIST_HEADINGstatic java.lang.StringSECTION_KEY_FOOTERstatic java.lang.StringSECTION_KEY_FOOTER_HEADINGstatic java.lang.StringSECTION_KEY_HEADERstatic java.lang.StringSECTION_KEY_HEADER_HEADINGstatic java.lang.StringSECTION_KEY_OPTION_LISTstatic java.lang.StringSECTION_KEY_OPTION_LIST_HEADINGstatic java.lang.StringSECTION_KEY_PARAMETER_LISTstatic java.lang.StringSECTION_KEY_PARAMETER_LIST_HEADINGstatic java.lang.StringSECTION_KEY_SYNOPSISstatic java.lang.StringSECTION_KEY_SYNOPSIS_HEADING
-
Constructor Summary
Constructors Constructor Description UsageMessageSpec()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanabbreviateSynopsis()Returns whether the synopsis line(s) should show an abbreviated synopsis without detailed option names.CommandLine.Model.UsageMessageSpecabbreviateSynopsis(boolean newValue)Sets whether the synopsis line(s) should show an abbreviated synopsis without detailed option names.booleanadjustLineBreaksForWideCJKCharacters()Returns whether line breaks should take wide Chinese, Japanese and Korean characters into account for line-breaking purposes.CommandLine.Model.UsageMessageSpecadjustLineBreaksForWideCJKCharacters(boolean adjustForWideChars)Sets whether line breaks should take wide Chinese, Japanese and Korean characters into account, and returns this UsageMessageSpec.booleanautoWidth()Returns whether picocli should attempt to detect the terminal size and adjust the usage help message width to take the full terminal width.CommandLine.Model.UsageMessageSpecautoWidth(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.java.lang.StringcommandListHeading()Returns the optional heading preceding the subcommand list.CommandLine.Model.UsageMessageSpeccommandListHeading(java.lang.String newValue)Sets the optional heading preceding the subcommand list.java.lang.String[]customSynopsis()Returns the optional custom synopsis lines to use instead of the auto-generated synopsis.CommandLine.Model.UsageMessageSpeccustomSynopsis(java.lang.String... customSynopsis)Sets the optional custom synopsis lines to use instead of the auto-generated synopsis.java.lang.String[]description()Returns the optional text lines to use as the description of the help message, displayed between the synopsis and the options list.CommandLine.Model.UsageMessageSpecdescription(java.lang.String... description)Sets the optional text lines to use as the description of the help message, displayed between the synopsis and the options list.java.lang.StringdescriptionHeading()Returns the optional heading preceding the description section.CommandLine.Model.UsageMessageSpecdescriptionHeading(java.lang.String newValue)Sets the heading preceding the description section.java.util.Map<java.lang.String,java.lang.String>exitCodeList()Returns an unmodifiable map with values to be displayed in the exit codes section: keys are exit codes, values are descriptions.CommandLine.Model.UsageMessageSpecexitCodeList(java.util.Map<java.lang.String,java.lang.String> newValue)Sets the values to be displayed in the exit codes section: keys are exit codes, values are descriptions.java.lang.StringexitCodeListHeading()Returns the optional heading preceding the exit codes section, may contain"%n"line separators.CommandLine.Model.UsageMessageSpecexitCodeListHeading(java.lang.String newValue)Sets the optional heading preceding the exit codes section, may contain"%n"line separators.java.lang.String[]footer()Returns the optional footer text lines displayed at the bottom of the help message.CommandLine.Model.UsageMessageSpecfooter(java.lang.String... footer)Sets the optional footer text lines displayed at the bottom of the help message.java.lang.StringfooterHeading()Returns the optional heading preceding the footer section.CommandLine.Model.UsageMessageSpecfooterHeading(java.lang.String newValue)Sets the optional heading preceding the footer section.java.lang.String[]header()Returns the optional header lines displayed at the top of the help message.CommandLine.Model.UsageMessageSpecheader(java.lang.String... header)Sets the optional header lines displayed at the top of the help message.java.lang.StringheaderHeading()Returns the optional heading preceding the header section.CommandLine.Model.UsageMessageSpecheaderHeading(java.lang.String headerHeading)Sets the heading preceding the header section.CommandLine.IHelpFactoryhelpFactory()Returns theIHelpFactorythat is used to construct the usage help message.CommandLine.Model.UsageMessageSpechelpFactory(CommandLine.IHelpFactory helpFactory)Sets a newIHelpFactoryto customize the usage help message.booleanhidden()Returns whether this command should be hidden from the usage help message of the parent command.CommandLine.Model.UsageMessageSpechidden(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.static java.util.Map<java.lang.String,java.lang.String>keyValuesMap(java.lang.String... entries)Creates and returns aMapthat contains an entry for each specified String that is in"key:value"format.intlongOptionsMaxWidth()Returns the maximum usage help long options column max width to the specified value.CommandLine.Model.UsageMessageSpeclongOptionsMaxWidth(int newValue)Sets the maximum usage help long options column max width to the specified value.CommandLine.Model.Messagesmessages()Returns the Messages for this usage help message specification, ornull.CommandLine.Model.UsageMessageSpecmessages(CommandLine.Model.Messages msgs)Sets the Messages for this usageMessage specification, and returns this UsageMessageSpec.java.lang.StringoptionListHeading()Returns the optional heading preceding the options list.CommandLine.Model.UsageMessageSpecoptionListHeading(java.lang.String newValue)Sets the heading preceding the options list.java.lang.StringparameterListHeading()Returns the optional heading preceding the parameter list.CommandLine.Model.UsageMessageSpecparameterListHeading(java.lang.String newValue)Sets the optional heading preceding the parameter list.charrequiredOptionMarker()Returns the character used to prefix required options in the options list.CommandLine.Model.UsageMessageSpecrequiredOptionMarker(char newValue)Sets the character used to prefix required options in the options list.java.util.List<java.lang.String>sectionKeys()Returns the section keys in the order that the usage help message should render the sections.CommandLine.Model.UsageMessageSpecsectionKeys(java.util.List<java.lang.String> keys)Sets the section keys in the order that the usage help message should render the sections.java.util.Map<java.lang.String,CommandLine.IHelpSectionRenderer>sectionMap()Returns the map of section keys and renderers used to construct the usage help message.CommandLine.Model.UsageMessageSpecsectionMap(java.util.Map<java.lang.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.booleanshowAtFileInUsageHelp()Sets whether to show a[@<filename>...]entry in the synopsis and parameter list of the usage help message.CommandLine.Model.UsageMessageSpecshowAtFileInUsageHelp(boolean newValue)Sets whether to show a[@<filename>...]entry in the synopsis and parameter list of the usage help message.booleanshowDefaultValues()Returns whether the options list in the usage help message should show default values for all non-boolean options.CommandLine.Model.UsageMessageSpecshowDefaultValues(boolean newValue)Sets whether the options list in the usage help message should show default values for all non-boolean options.booleanshowEndOfOptionsDelimiterInUsageHelp()Sets whether to show a[--](End of Options) entry in the synopsis and options list of the usage help message.CommandLine.Model.UsageMessageSpecshowEndOfOptionsDelimiterInUsageHelp(boolean newValue)Sets whether to show a[--](End of Options) entry in the synopsis and options list of the usage help message.booleansortOptions()Returns whether the options list in the usage help message should be sorted alphabetically.CommandLine.Model.UsageMessageSpecsortOptions(boolean newValue)Sets whether the options list in the usage help message should be sorted alphabetically.booleansortSynopsis()Returns whether the options in the synopsis should be sorted alphabetically.CommandLine.Model.UsageMessageSpecsortSynopsis(boolean newValue)Sets whether the options in the synopsis should be sorted alphabetically.doublesynopsisAutoIndentThreshold()Returns 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.UsageMessageSpecsynopsisAutoIndentThreshold(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.java.lang.StringsynopsisHeading()Returns the optional heading preceding the synopsis.CommandLine.Model.UsageMessageSpecsynopsisHeading(java.lang.String newValue)Sets the optional heading preceding the synopsis.intsynopsisIndent()Returns 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 thewidth()times thesynopsisAutoIndentThreshold(),-1by default.CommandLine.Model.UsageMessageSpecsynopsisIndent(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(),-1by default.java.lang.StringsynopsisSubcommandLabel()Returns the String representing the subcommands in the synopsis.CommandLine.Model.UsageMessageSpecsynopsisSubcommandLabel(java.lang.String newValue)Sets the String representing the subcommands in the synopsis.intwidth()Returns the maximum usage help message width.CommandLine.Model.UsageMessageSpecwidth(int newValue)Sets the maximum usage help message width to the specified value.
-
-
-
Field Detail
-
SECTION_KEY_HEADER_HEADING
public static final java.lang.String SECTION_KEY_HEADER_HEADING
Section key to control the section renderer for the Header Heading section. The default renderer for this section callsCommandLine.Help.headerHeading(Object...).- Since:
- 3.9
- See Also:
- Constant Field Values
-
SECTION_KEY_HEADER
public static final java.lang.String SECTION_KEY_HEADER
Section key to control the section renderer for the Header section. The default renderer for this section callsCommandLine.Help.header(Object...).- Since:
- 3.9
- See Also:
- Constant Field Values
-
SECTION_KEY_SYNOPSIS_HEADING
public static final java.lang.String SECTION_KEY_SYNOPSIS_HEADING
Section key to control the section renderer for the Synopsis Heading section. The default renderer for this section callsCommandLine.Help.synopsisHeading(Object...).- Since:
- 3.9
- See Also:
- Constant Field Values
-
SECTION_KEY_SYNOPSIS
public static final java.lang.String SECTION_KEY_SYNOPSIS
Section key to control the section renderer for the Synopsis section. The default renderer for this section callsCommandLine.Help.synopsis(int).- Since:
- 3.9
- See Also:
- Constant Field Values
-
SECTION_KEY_DESCRIPTION_HEADING
public static final java.lang.String SECTION_KEY_DESCRIPTION_HEADING
Section key to control the section renderer for the Description Heading section. The default renderer for this section callsCommandLine.Help.descriptionHeading(Object...).- Since:
- 3.9
- See Also:
- Constant Field Values
-
SECTION_KEY_DESCRIPTION
public static final java.lang.String SECTION_KEY_DESCRIPTION
Section key to control the section renderer for the Description section. The default renderer for this section callsCommandLine.Help.description(Object...).- Since:
- 3.9
- See Also:
- Constant Field Values
-
SECTION_KEY_PARAMETER_LIST_HEADING
public static final java.lang.String SECTION_KEY_PARAMETER_LIST_HEADING
Section key to control the section renderer for the Parameter List Heading section. The default renderer for this section callsCommandLine.Help.parameterListHeading(Object...).- Since:
- 3.9
- See Also:
- Constant Field Values
-
SECTION_KEY_AT_FILE_PARAMETER
public static final java.lang.String SECTION_KEY_AT_FILE_PARAMETER
Section key to control the section renderer for the @-file parameter list section. The default renderer for this section callsCommandLine.Help.atFileParameterList().- Since:
- 4.2
- See Also:
- Constant Field Values
-
SECTION_KEY_PARAMETER_LIST
public static final java.lang.String SECTION_KEY_PARAMETER_LIST
Section key to control the section renderer for the Parameter List section. The default renderer for this section callsCommandLine.Help.parameterList().- Since:
- 3.9
- See Also:
- Constant Field Values
-
SECTION_KEY_OPTION_LIST_HEADING
public static final java.lang.String SECTION_KEY_OPTION_LIST_HEADING
Section key to control the section renderer for the Option List Heading section. The default renderer for this section callsCommandLine.Help.optionListHeading(Object...).- Since:
- 3.9
- See Also:
- Constant Field Values
-
SECTION_KEY_OPTION_LIST
public static final java.lang.String SECTION_KEY_OPTION_LIST
Section key to control the section renderer for the Option List section. The default renderer for this section callsCommandLine.Help.optionList().- Since:
- 3.9
- See Also:
- Constant Field Values
-
SECTION_KEY_END_OF_OPTIONS
public static final java.lang.String SECTION_KEY_END_OF_OPTIONS
Section key to control the section renderer for the--End of Options list section. The default renderer for this section callsCommandLine.Help.endOfOptionsList().- Since:
- 4.3
- See Also:
- Constant Field Values
-
SECTION_KEY_COMMAND_LIST_HEADING
public static final java.lang.String SECTION_KEY_COMMAND_LIST_HEADING
Section key to control the section renderer for the Subcommand List Heading section. The default renderer for this section callsCommandLine.Help.commandListHeading(Object...).- Since:
- 3.9
- See Also:
- Constant Field Values
-
SECTION_KEY_COMMAND_LIST
public static final java.lang.String SECTION_KEY_COMMAND_LIST
Section key to control the section renderer for the Subcommand List section. The default renderer for this section callsCommandLine.Help.commandList().- Since:
- 3.9
- See Also:
- Constant Field Values
-
SECTION_KEY_EXIT_CODE_LIST_HEADING
public static final java.lang.String SECTION_KEY_EXIT_CODE_LIST_HEADING
Section key to control the section renderer for the Exit Code List Heading section. The default renderer for this section callsCommandLine.Help.exitCodeListHeading(Object...).- Since:
- 4.0
- See Also:
- Constant Field Values
-
SECTION_KEY_EXIT_CODE_LIST
public static final java.lang.String SECTION_KEY_EXIT_CODE_LIST
Section key to control the section renderer for the Exit Code List section. The default renderer for this section callsCommandLine.Help.exitCodeList().- Since:
- 4.0
- See Also:
- Constant Field Values
-
SECTION_KEY_FOOTER_HEADING
public static final java.lang.String SECTION_KEY_FOOTER_HEADING
Section key to control the section renderer for the Footer Heading section. The default renderer for this section callsCommandLine.Help.footerHeading(Object...).- Since:
- 3.9
- See Also:
- Constant Field Values
-
SECTION_KEY_FOOTER
public static final java.lang.String SECTION_KEY_FOOTER
Section key to control the section renderer for the Footer section. The default renderer for this section callsCommandLine.Help.footer(Object...).- Since:
- 3.9
- See Also:
- Constant Field Values
-
DEFAULT_USAGE_WIDTH
public static final int DEFAULT_USAGE_WIDTH
Constant holding the default usage message width:80.- See Also:
- Constant Field Values
-
-
Method Detail
-
width
public CommandLine.Model.UsageMessageSpec width(int newValue)
Sets the maximum usage help message width to the specified value. Longer values are wrapped.- Parameters:
newValue- the new maximum usage help message width. Must be 55 or greater.- Returns:
- this
UsageMessageSpecfor method chaining - Throws:
java.lang.IllegalArgumentException- if the specified width is less than 55
-
longOptionsMaxWidth
public CommandLine.Model.UsageMessageSpec longOptionsMaxWidth(int newValue)
Sets the maximum usage help long options column max width to the specified value. This value controls the maximum width of the long options column: any positional parameter labels or long options that are longer than the specified value will overflow into the description column, and cause the description to be displayed on the next line.- Parameters:
newValue- the new maximum usage help long options column max width. Must be 20 or greater, otherwise the new value will be ignored.- Returns:
- this
UsageMessageSpecfor method chaining - Since:
- 4.2
-
width
public int width()
Returns the maximum usage help message width. Derived from system property"picocli.usage.width"if set, otherwise returns the value set via thewidth(int)method, or if not set, the default width.- Returns:
- the maximum usage help message width. Never returns less than 55.
-
longOptionsMaxWidth
public int longOptionsMaxWidth()
Returns the maximum usage help long options column max width to the specified value. This value controls the maximum width of the long options column: any positional parameter labels or long options that are longer than the specified value will overflow into the description column, and cause the description to be displayed on the next line.- Returns:
- the new maximum usage help long options column max width. Always 20 or greater.
- Since:
- 4.2
-
autoWidth
public boolean autoWidth()
Returns whether picocli should attempt to detect the terminal size and adjust the usage help message width to take the full terminal width. End users may enable this by setting system property"picocli.usage.width"toAUTO, and may disable this by setting this system property to a numeric value. This feature requires Java 7 or greater. The default isfalse.- Since:
- 4.0
- See Also:
CommandLine.Command.usageHelpAutoWidth()
-
autoWidth
public 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. The default isfalse.- Parameters:
detectTerminalSize- whether picocli should attempt to detect the terminal size- Since:
- 4.0
- See Also:
CommandLine.Command.usageHelpAutoWidth()
-
sectionKeys
public java.util.List<java.lang.String> sectionKeys()
Returns the section keys in the order that the usage help message should render the sections. This ordering may be modified with thesectionKeys setter. The default keys are (in order):SECTION_KEY_HEADER_HEADINGSECTION_KEY_HEADERSECTION_KEY_SYNOPSIS_HEADINGSECTION_KEY_SYNOPSISSECTION_KEY_DESCRIPTION_HEADINGSECTION_KEY_DESCRIPTIONSECTION_KEY_PARAMETER_LIST_HEADINGSECTION_KEY_AT_FILE_PARAMETERSECTION_KEY_PARAMETER_LISTSECTION_KEY_OPTION_LIST_HEADINGSECTION_KEY_OPTION_LISTSECTION_KEY_END_OF_OPTIONSSECTION_KEY_COMMAND_LIST_HEADINGSECTION_KEY_COMMAND_LISTSECTION_KEY_EXIT_CODE_LIST_HEADINGSECTION_KEY_EXIT_CODE_LISTSECTION_KEY_FOOTER_HEADINGSECTION_KEY_FOOTER
- Since:
- 3.9
-
sectionKeys
public CommandLine.Model.UsageMessageSpec sectionKeys(java.util.List<java.lang.String> keys)
Sets the section keys in the order that the usage help message should render the sections.- Since:
- 3.9
- See Also:
sectionKeys
-
sectionMap
public java.util.Map<java.lang.String,CommandLine.IHelpSectionRenderer> sectionMap()
Returns the map of section keys and renderers used to construct the usage help message. The usage help message can be customized by adding, replacing and removing section renderers from this map. Sections can be reordered with thesectionKeys setter. Sections that are either not in this map or not in the list returned bysectionKeysare omitted.- Since:
- 3.9
- See Also:
sectionKeys
-
sectionMap
public CommandLine.Model.UsageMessageSpec sectionMap(java.util.Map<java.lang.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.- Parameters:
map- the mapping of section keys to their renderers, must be non-null.- Returns:
- this UsageMessageSpec for method chaining
- Since:
- 3.9
- See Also:
sectionKeys,CommandLine.setHelpSectionMap(Map)
-
helpFactory
public CommandLine.IHelpFactory helpFactory()
Returns theIHelpFactorythat is used to construct the usage help message.- Since:
- 3.9
- See Also:
CommandLine.setHelpFactory(IHelpFactory)
-
helpFactory
public CommandLine.Model.UsageMessageSpec helpFactory(CommandLine.IHelpFactory helpFactory)
Sets a newIHelpFactoryto customize the usage help message.- Parameters:
helpFactory- the new help factory. Must be non-null.- Returns:
- this
UsageMessageSpecobject, to allow method chaining
-
headerHeading
public java.lang.String headerHeading()
Returns the optional heading preceding the header section. Initialized fromCommandLine.Command.headerHeading(), or""(empty string).
-
header
public java.lang.String[] header()
Returns the optional header lines displayed at the top of the help message. For subcommands, the first header line is displayed in the list of commands. Values are initialized fromCommandLine.Command.header()if theCommandannotation is present, otherwise this is an empty array and the help message has no header. Applications may programmatically set this field to create a custom help message.
-
synopsisHeading
public java.lang.String synopsisHeading()
Returns the optional heading preceding the synopsis. Initialized fromCommandLine.Command.synopsisHeading(),"Usage: "by default.
-
synopsisSubcommandLabel
public java.lang.String synopsisSubcommandLabel()
Returns the String representing the subcommands in the synopsis. Initialized fromCommandLine.Command.synopsisSubcommandLabel(),"[COMMANDS]"by default.- Since:
- 4.0
-
synopsisAutoIndentThreshold
public double synopsisAutoIndentThreshold()
Returns 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. The default value of this attribute is0.5. If the length of the synopsis heading plus the length of the fully qualified command name exceeds this fraction of the width, the 2nd and subsequent rows of a multi-line synopsis will be aligned to thesynopsisIndent()instead of the end of the command name.- Since:
- 4.0
-
synopsisIndent
public int synopsisIndent()
Returns 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 thewidth()times thesynopsisAutoIndentThreshold(),-1by default. A negative value for this option means that the 2nd line and subsequent lines are aligned to the synopsis heading length. A positive value means the exact number of spaces to indent for the 2nd line and subsequent lines of the synopsis.- Since:
- 4.0
-
abbreviateSynopsis
public boolean abbreviateSynopsis()
Returns whether the synopsis line(s) should show an abbreviated synopsis without detailed option names.
-
customSynopsis
public java.lang.String[] customSynopsis()
Returns the optional custom synopsis lines to use instead of the auto-generated synopsis. Initialized fromCommandLine.Command.customSynopsis()if theCommandannotation is present, otherwise this is an empty array and the synopsis is generated. Applications may programmatically set this field to create a custom help message.
-
descriptionHeading
public java.lang.String descriptionHeading()
Returns the optional heading preceding the description section. Initialized fromCommandLine.Command.descriptionHeading(), or null.
-
description
public java.lang.String[] description()
Returns the optional text lines to use as the description of the help message, displayed between the synopsis and the options list. Initialized fromCommandLine.Command.description()if theCommandannotation is present, otherwise this is an empty array and the help message has no description. Applications may programmatically set this field to create a custom help message.
-
parameterListHeading
public java.lang.String parameterListHeading()
Returns the optional heading preceding the parameter list. Initialized fromCommandLine.Command.parameterListHeading(), or null.
-
optionListHeading
public java.lang.String optionListHeading()
Returns the optional heading preceding the options list. Initialized fromCommandLine.Command.optionListHeading(), or null.
-
sortOptions
public boolean sortOptions()
Returns whether the options list in the usage help message should be sorted alphabetically.
-
sortSynopsis
public boolean sortSynopsis()
Returns whether the options in the synopsis should be sorted alphabetically.- Since:
- 4.7.7-SNAPSHOT
-
requiredOptionMarker
public char requiredOptionMarker()
Returns the character used to prefix required options in the options list.
-
showDefaultValues
public boolean showDefaultValues()
Returns whether the options list in the usage help message should show default values for all non-boolean options.
-
showAtFileInUsageHelp
public boolean showAtFileInUsageHelp()
Sets whether to show a[@<filename>...]entry in the synopsis and parameter list of the usage help message. (The entry is not shown if expanding parameter files is disabled.)- Since:
- 4.2
- See Also:
CommandLine.Command.showAtFileInUsageHelp()
-
showEndOfOptionsDelimiterInUsageHelp
public boolean showEndOfOptionsDelimiterInUsageHelp()
Sets whether to show a[--](End of Options) entry in the synopsis and options list of the usage help message.- Since:
- 4.3
- See Also:
CommandLine.Command.showEndOfOptionsDelimiterInUsageHelp()
-
hidden
public boolean hidden()
Returns whether this command should be hidden from the usage help message of the parent command.- Returns:
trueif this command should not appear in the usage help message of the parent command
-
commandListHeading
public java.lang.String commandListHeading()
Returns the optional heading preceding the subcommand list. Initialized fromCommandLine.Command.commandListHeading()."Commands:%n"by default.
-
exitCodeListHeading
public java.lang.String exitCodeListHeading()
Returns the optional heading preceding the exit codes section, may contain"%n"line separators.""(empty string) by default.
-
exitCodeList
public java.util.Map<java.lang.String,java.lang.String> exitCodeList()
Returns an unmodifiable map with values to be displayed in the exit codes section: keys are exit codes, values are descriptions. Descriptions may contain"%n"line separators. Callers may be interested in thekeyValuesMapmethod for creating a map from a list of"key:value"Strings.This may be configured in a resource bundle by listing up multiple
"key:value"pairs. For example:usage.exitCodeList.0 = 0:Successful program execution. usage.exitCodeList.1 = 64:Invalid input: an unknown option or invalid parameter was specified. usage.exitCodeList.2 = 70:Execution exception: an exception occurred while executing the business logic.
- Returns:
- an unmodifiable map with values to be displayed in the exit codes section, or an empty map if no exit codes are registered.
- Since:
- 4.0
- See Also:
keyValuesMap(String...)
-
keyValuesMap
public static java.util.Map<java.lang.String,java.lang.String> keyValuesMap(java.lang.String... entries)
Creates and returns aMapthat contains an entry for each specified String that is in"key:value"format.- Parameters:
entries- the strings to process; values that are not in"key:value"format are ignored- Returns:
- a
Mapwith an entry for each line, preserving the input order - Since:
- 4.0
-
footerHeading
public java.lang.String footerHeading()
Returns the optional heading preceding the footer section. Initialized fromCommandLine.Command.footerHeading(), or""(empty string).
-
footer
public java.lang.String[] footer()
Returns the optional footer text lines displayed at the bottom of the help message. Initialized fromCommandLine.Command.footer()if theCommandannotation is present, otherwise this is an empty array and the help message has no footer. Applications may programmatically set this field to create a custom help message.
-
headerHeading
public CommandLine.Model.UsageMessageSpec headerHeading(java.lang.String headerHeading)
Sets the heading preceding the header section. Initialized fromCommandLine.Command.headerHeading(), or null.- Returns:
- this UsageMessageSpec for method chaining
-
header
public CommandLine.Model.UsageMessageSpec header(java.lang.String... header)
Sets the optional header lines displayed at the top of the help message. For subcommands, the first header line is displayed in the list of commands.- Returns:
- this UsageMessageSpec for method chaining
-
synopsisHeading
public CommandLine.Model.UsageMessageSpec synopsisHeading(java.lang.String newValue)
Sets the optional heading preceding the synopsis.- Returns:
- this UsageMessageSpec for method chaining
-
synopsisSubcommandLabel
public CommandLine.Model.UsageMessageSpec synopsisSubcommandLabel(java.lang.String newValue)
Sets the String representing the subcommands in the synopsis.- Returns:
- this UsageMessageSpec for method chaining
- Since:
- 4.0
-
synopsisAutoIndentThreshold
public 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. The default value of this attribute is0.5. If the length of the synopsis heading plus the length of the fully qualified command name exceeds this fraction of the width, the 2nd and subsequent rows of a multi-line synopsis will be aligned to thesynopsisIndent()instead of the end of the command name.- Parameters:
newValue- the new threshold value. Must be a value between 0.0 and 0.9, inclusive- Returns:
- this UsageMessageSpec for method chaining
- Throws:
java.lang.IllegalArgumentException- if the specified value is less than 0.0 or greater than 0.9- Since:
- 4.0
-
synopsisIndent
public 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(),-1by default. A negative value for this option means that the 2nd line and subsequent lines are aligned to the synopsis heading length. A positive value means the exact number of spaces to indent for the 2nd line and subsequent lines of the synopsis.- Returns:
- this UsageMessageSpec for method chaining
- Since:
- 4.0
-
abbreviateSynopsis
public CommandLine.Model.UsageMessageSpec abbreviateSynopsis(boolean newValue)
Sets whether the synopsis line(s) should show an abbreviated synopsis without detailed option names.- Returns:
- this UsageMessageSpec for method chaining
-
customSynopsis
public CommandLine.Model.UsageMessageSpec customSynopsis(java.lang.String... customSynopsis)
Sets the optional custom synopsis lines to use instead of the auto-generated synopsis.- Returns:
- this UsageMessageSpec for method chaining
-
descriptionHeading
public CommandLine.Model.UsageMessageSpec descriptionHeading(java.lang.String newValue)
Sets the heading preceding the description section.- Returns:
- this UsageMessageSpec for method chaining
-
description
public CommandLine.Model.UsageMessageSpec description(java.lang.String... description)
Sets the optional text lines to use as the description of the help message, displayed between the synopsis and the options list.- Returns:
- this UsageMessageSpec for method chaining
-
parameterListHeading
public CommandLine.Model.UsageMessageSpec parameterListHeading(java.lang.String newValue)
Sets the optional heading preceding the parameter list.- Returns:
- this UsageMessageSpec for method chaining
-
optionListHeading
public CommandLine.Model.UsageMessageSpec optionListHeading(java.lang.String newValue)
Sets the heading preceding the options list.- Returns:
- this UsageMessageSpec for method chaining
-
sortOptions
public CommandLine.Model.UsageMessageSpec sortOptions(boolean newValue)
Sets whether the options list in the usage help message should be sorted alphabetically.- Returns:
- this UsageMessageSpec for method chaining
-
sortSynopsis
public CommandLine.Model.UsageMessageSpec sortSynopsis(boolean newValue)
Sets whether the options in the synopsis should be sorted alphabetically.- Returns:
- this UsageMessageSpec for method chaining
- Since:
- 4.7.7-SNAPSHOT
-
requiredOptionMarker
public CommandLine.Model.UsageMessageSpec requiredOptionMarker(char newValue)
Sets the character used to prefix required options in the options list.- Returns:
- this UsageMessageSpec for method chaining
-
showDefaultValues
public 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.- Returns:
- this UsageMessageSpec for method chaining
-
showAtFileInUsageHelp
public CommandLine.Model.UsageMessageSpec showAtFileInUsageHelp(boolean newValue)
Sets whether to show a[@<filename>...]entry in the synopsis and parameter list of the usage help message. (The entry is not shown if expanding parameter files is disabled.)- Returns:
- this UsageMessageSpec for method chaining
- Since:
- 4.2
- See Also:
CommandLine.Command.showAtFileInUsageHelp()
-
showEndOfOptionsDelimiterInUsageHelp
public 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.- Returns:
- this UsageMessageSpec for method chaining
- Since:
- 4.3
- See Also:
CommandLine.Command.showEndOfOptionsDelimiterInUsageHelp()
-
hidden
public 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.- Parameters:
value- enable or disable the hidden flag- Returns:
- this UsageMessageSpec for method chaining
- See Also:
CommandLine.Command.hidden()
-
commandListHeading
public CommandLine.Model.UsageMessageSpec commandListHeading(java.lang.String newValue)
Sets the optional heading preceding the subcommand list.- Returns:
- this UsageMessageSpec for method chaining
-
exitCodeListHeading
public CommandLine.Model.UsageMessageSpec exitCodeListHeading(java.lang.String newValue)
Sets the optional heading preceding the exit codes section, may contain"%n"line separators.""(empty string) by default.- Since:
- 4.0
-
exitCodeList
public CommandLine.Model.UsageMessageSpec exitCodeList(java.util.Map<java.lang.String,java.lang.String> newValue)
Sets the values to be displayed in the exit codes section: keys are exit codes, values are descriptions. Descriptions may contain"%n"line separators.This may be configured in a resource bundle by listing up multiple
"key:value"pairs. For example:usage.exitCodeList.0 = 0:Successful program execution. usage.exitCodeList.1 = 64:Invalid input: an unknown option or invalid parameter was specified. usage.exitCodeList.2 = 70:Execution exception: an exception occurred while executing the business logic.
- Parameters:
newValue- a map with values to be displayed in the exit codes section- Since:
- 4.0
- See Also:
keyValuesMap(String...)
-
footerHeading
public CommandLine.Model.UsageMessageSpec footerHeading(java.lang.String newValue)
Sets the optional heading preceding the footer section.- Returns:
- this UsageMessageSpec for method chaining
-
footer
public CommandLine.Model.UsageMessageSpec footer(java.lang.String... footer)
Sets the optional footer text lines displayed at the bottom of the help message.- Returns:
- this UsageMessageSpec for method chaining
-
messages
public CommandLine.Model.Messages messages()
Returns the Messages for this usage help message specification, ornull.- Returns:
- the Messages object that encapsulates this command's resource bundle
- Since:
- 3.6
-
messages
public CommandLine.Model.UsageMessageSpec messages(CommandLine.Model.Messages msgs)
Sets the Messages for this usageMessage specification, and returns this UsageMessageSpec.- Parameters:
msgs- the new Messages value that encapsulates this command's resource bundle, may benull- Since:
- 3.6
-
adjustLineBreaksForWideCJKCharacters
public boolean adjustLineBreaksForWideCJKCharacters()
Returns whether line breaks should take wide Chinese, Japanese and Korean characters into account for line-breaking purposes.- Returns:
- true if wide Chinese, Japanese and Korean characters are counted as double the size of other characters for line-breaking purposes
- Since:
- 4.0
-
adjustLineBreaksForWideCJKCharacters
public CommandLine.Model.UsageMessageSpec adjustLineBreaksForWideCJKCharacters(boolean adjustForWideChars)
Sets whether line breaks should take wide Chinese, Japanese and Korean characters into account, and returns this UsageMessageSpec.- Parameters:
adjustForWideChars- if true, wide Chinese, Japanese and Korean characters are counted as double the size of other characters for line-breaking purposes- Since:
- 4.0
-
-