Modifier and Type | Method | Description |
---|---|---|
CommandLine.Help.IParamLabelRenderer |
CommandLine.Help.createDefaultParamLabelRenderer() |
Returns a new default param label renderer that separates option parameters from their option name
with the specified separator string, and, unless
CommandLine.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.Help.IParamLabelRenderer |
CommandLine.Model.ArgGroupSpec.createLabelRenderer(CommandLine.Model.CommandSpec commandSpec) |
|
static CommandLine.Help.IParamLabelRenderer |
CommandLine.Help.createMinimalParamLabelRenderer() |
Returns a value renderer that returns the
paramLabel if defined or the field name otherwise. |
CommandLine.Help.IParamLabelRenderer |
CommandLine.Help.parameterLabelRenderer() |
Option and positional parameter value label renderer used for the synopsis line(s) and the option list.
|
Modifier and Type | Method | Description |
---|---|---|
void |
CommandLine.Help.Layout.addOption(CommandLine.Model.OptionSpec option,
CommandLine.Help.IParamLabelRenderer paramLabelRenderer) |
Delegates to the
option renderer of this layout to obtain
text values for the specified CommandLine.Model.OptionSpec , and then calls the CommandLine.Help.Layout.layout(CommandLine.Model.ArgSpec, CommandLine.Help.Ansi.Text[][])
method to write these text values into the correct cells in the TextTable. |
void |
CommandLine.Help.Layout.addOptions(List<CommandLine.Model.OptionSpec> options,
CommandLine.Help.IParamLabelRenderer paramLabelRenderer) |
Calls
CommandLine.Help.Layout.addOption(CommandLine.Model.OptionSpec, CommandLine.Help.IParamLabelRenderer) for all non-hidden Options in the list. |
void |
CommandLine.Help.Layout.addPositionalParameter(CommandLine.Model.PositionalParamSpec param,
CommandLine.Help.IParamLabelRenderer paramLabelRenderer) |
Delegates to the
parameter renderer of this layout
to obtain text values for the specified positional parameter, and then calls
CommandLine.Help.Layout.layout(CommandLine.Model.ArgSpec, CommandLine.Help.Ansi.Text[][]) to write these text values into the correct cells in the TextTable. |
void |
CommandLine.Help.Layout.addPositionalParameters(List<CommandLine.Model.PositionalParamSpec> params,
CommandLine.Help.IParamLabelRenderer paramLabelRenderer) |
Calls
CommandLine.Help.Layout.addPositionalParameter(CommandLine.Model.PositionalParamSpec, CommandLine.Help.IParamLabelRenderer) for all non-hidden Parameters in the list. |
String |
CommandLine.Help.optionList(CommandLine.Help.Layout layout,
Comparator<CommandLine.Model.OptionSpec> optionSort,
CommandLine.Help.IParamLabelRenderer valueLabelRenderer) |
Sorts all
Options with the specified comparator (if the comparator is non-null ),
then adds all non-hidden options to the
specified TextTable and returns the result of TextTable.toString(). |
String |
CommandLine.Help.parameterList(CommandLine.Help.Layout layout,
CommandLine.Help.IParamLabelRenderer paramLabelRenderer) |
Returns the section of the usage help message that lists the parameters with their descriptions.
|
CommandLine.Help.Ansi.Text[][] |
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.Ansi.Text[][] |
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.
|
Copyright © 2017–2019. All rights reserved.