-
- Enclosing class:
- CommandLine.Help
public static interface CommandLine.Help.IParamLabelRenderer
When customizing online usage help for an option parameter or a positional parameter, a customIParamLabelRenderer
can be used to render the parameter name or label to a String.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CommandLine.Help.Ansi.Text
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.String
separator()
Returns the separator between option name and param label.
-
-
-
Method Detail
-
renderParameterLabel
CommandLine.Help.Ansi.Text 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.- Parameters:
argSpec
- the named or positional parameter with a parameter labelansi
- determines whether ANSI escape codes should be emitted or notstyles
- the styles to apply to the parameter label- Returns:
- a text rendering of the Option parameter or positional parameter
- Since:
- 3.0
-
separator
String separator()
Returns the separator between option name and param label.- Returns:
- the separator between option name and param label
-
-