picocli

Class CommandLine.Model.UsageMessageSpec

java.lang.Object

picocli.CommandLine.Model.UsageMessageSpec

Enclosing class:

CommandLine.Model

public static class CommandLine.Model.UsageMessageSpec
extends java.lang.Object

Models the usage help message specification.

Since:

3.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_USAGE_WIDTH Constant holding the default usage message width: 80.

Constructor Summary

Constructors

Constructor and Description
UsageMessageSpec()

Method Summary

Modifier and Type	Method and Description
boolean	abbreviateSynopsis() Returns whether the synopsis line(s) should show an abbreviated synopsis without detailed option names.
CommandLine.Model.UsageMessageSpec	abbreviateSynopsis(boolean newValue) Sets whether the synopsis line(s) should show an abbreviated synopsis without detailed option names.
java.lang.String	commandListHeading() Returns the optional heading preceding the subcommand list.
CommandLine.Model.UsageMessageSpec	commandListHeading(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.UsageMessageSpec	customSynopsis(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.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.
java.lang.String	descriptionHeading() Returns the optional heading preceding the description section.
CommandLine.Model.UsageMessageSpec	descriptionHeading(java.lang.String newValue) Sets the heading preceding the description section.
java.lang.String[]	footer() Returns the optional footer text lines displayed at the bottom of the help message.
CommandLine.Model.UsageMessageSpec	footer(java.lang.String... footer) Sets the optional footer text lines displayed at the bottom of the help message.
java.lang.String	footerHeading() Returns the optional heading preceding the footer section.
CommandLine.Model.UsageMessageSpec	footerHeading(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.UsageMessageSpec	header(java.lang.String... header) Sets the optional header lines displayed at the top of the help message.
java.lang.String	headerHeading() Returns the optional heading preceding the header section.
CommandLine.Model.UsageMessageSpec	headerHeading(java.lang.String headerHeading) Sets the heading preceding the header section.
boolean	hidden() Returns whether this command should be hidden from the usage help message of the parent command.
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.
java.lang.String	optionListHeading() Returns the optional heading preceding the options list.
CommandLine.Model.UsageMessageSpec	optionListHeading(java.lang.String newValue) Sets the heading preceding the options list.
java.lang.String	parameterListHeading() Returns the optional heading preceding the parameter list.
CommandLine.Model.UsageMessageSpec	parameterListHeading(java.lang.String newValue) Sets the optional heading preceding the parameter list.
char	requiredOptionMarker() Returns the character used to prefix required options in the options list.
CommandLine.Model.UsageMessageSpec	requiredOptionMarker(char newValue) Sets the character used to prefix required options in the options list.
boolean	showDefaultValues() Returns whether the options list in the usage help message should show default values for all non-boolean options.
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.
boolean	sortOptions() Returns whether the options list in the usage help message should be sorted alphabetically.
CommandLine.Model.UsageMessageSpec	sortOptions(boolean newValue) Sets whether the options list in the usage help message should be sorted alphabetically.
java.lang.String	synopsisHeading() Returns the optional heading preceding the synopsis.
CommandLine.Model.UsageMessageSpec	synopsisHeading(java.lang.String newValue) Sets the optional heading preceding the synopsis.
int	width() Returns the maximum usage help message width.
CommandLine.Model.UsageMessageSpec	width(int newValue) Sets the maximum usage help message width to the specified value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_USAGE_WIDTH

public static final int DEFAULT_USAGE_WIDTH

Constant holding the default usage message width: 80.

See Also:

Constant Field Values

Constructor Detail

UsageMessageSpec

public UsageMessageSpec()

Method Detail

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 the width(int) method, or if not set, the default width.

Returns:

the maximum usage help message width. Never returns less than 55.

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 UsageMessageSpec for method chaining

Throws:

java.lang.IllegalArgumentException - if the specified width is less than 55

headerHeading

public java.lang.String headerHeading()

Returns the optional heading preceding the header section. Initialized from CommandLine.Command.headerHeading(), or null.

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 from CommandLine.Command.header() if the Command annotation 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 from CommandLine.Command.synopsisHeading(), "Usage: " by default.

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 from CommandLine.Command.customSynopsis() if the Command annotation 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 from CommandLine.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 from CommandLine.Command.description() if the Command annotation 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 from CommandLine.Command.parameterListHeading(), or null.

optionListHeading

public java.lang.String optionListHeading()

Returns the optional heading preceding the options list. Initialized from CommandLine.Command.optionListHeading(), or null.

sortOptions

public boolean sortOptions()

Returns whether the options list in the usage help message should be sorted alphabetically.

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.

hidden

public boolean hidden()

Returns whether this command should be hidden from the usage help message of the parent command.

Returns:

true if 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 from CommandLine.Command.commandListHeading(). "Commands:%n" by default.

footerHeading

public java.lang.String footerHeading()

Returns the optional heading preceding the footer section. Initialized from CommandLine.Command.footerHeading(), or null.

footer

public java.lang.String[] footer()

Returns the optional footer text lines displayed at the bottom of the help message. Initialized from CommandLine.Command.footer() if the Command annotation 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 from CommandLine.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

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

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

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

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