Package picocli
Interface CommandLine.Help.IParameterRenderer
-
- Enclosing class:
- CommandLine.Help
public static interface CommandLine.Help.IParameterRendererWhen customizing online help for positional parameters details, a customIParameterRenderercan be used to create textual representation of a Parameters field in a tabular format: one or more rows, each containing one or more columns. TheLayoutis responsible for placing these text values in theTextTable.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CommandLine.Help.Ansi.Text[][]render(CommandLine.Model.PositionalParamSpec param, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer, CommandLine.Help.ColorScheme scheme)Returns a text representation of the specified positional parameter.
-
-
-
Method Detail
-
render
CommandLine.Help.Ansi.Text[][] render(CommandLine.Model.PositionalParamSpec param, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer, CommandLine.Help.ColorScheme scheme)
Returns a text representation of the specified positional parameter.- Parameters:
param- the positional parameter to show online usage help forparameterLabelRenderer- responsible for rendering parameter labels to textscheme- color scheme for applying ansi color styles to positional parameters- Returns:
- a 2-dimensional array of text values: one or more rows, each containing one or more columns
- Since:
- 3.0
-
-