Package picocli
Class CommandLine.Help.DefaultParameterRenderer
- java.lang.Object
-
- picocli.CommandLine.Help.DefaultParameterRenderer
-
- All Implemented Interfaces:
CommandLine.Help.IParameterRenderer
- Enclosing class:
- CommandLine.Help
static class CommandLine.Help.DefaultParameterRenderer extends java.lang.Object implements CommandLine.Help.IParameterRenderer
The DefaultParameterRenderer converts positional parameters to five columns of text to match the default TextTable column layout. The first row of values looks like this:- the required option marker (if the parameter's arity is to have at least one value)
- empty string
- empty string
- parameter(s) label as rendered by the
CommandLine.Help.IParamLabelRenderer
- first element of the
CommandLine.Model.ArgSpec.description()
array
Following this, there will be one row for each of the remaining elements of the
CommandLine.Model.ArgSpec.description()
array, and these rows look like{"", "", "", param.description()[i]}
.
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
requiredMarker
private boolean
showDefaultValues
-
Constructor Summary
Constructors Constructor Description DefaultParameterRenderer(boolean showDefaultValues, java.lang.String requiredMarker)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CommandLine.Help.Ansi.Text[][]
render(CommandLine.Model.PositionalParamSpec param, CommandLine.Help.IParamLabelRenderer paramLabelRenderer, CommandLine.Help.ColorScheme scheme)
Returns a text representation of the specified positional parameter.
-
-
-
Method Detail
-
render
public CommandLine.Help.Ansi.Text[][] render(CommandLine.Model.PositionalParamSpec param, CommandLine.Help.IParamLabelRenderer paramLabelRenderer, CommandLine.Help.ColorScheme scheme)
Description copied from interface:CommandLine.Help.IParameterRenderer
Returns a text representation of the specified positional parameter.- Specified by:
render
in interfaceCommandLine.Help.IParameterRenderer
- Parameters:
param
- the positional parameter to show online usage help forparamLabelRenderer
- 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
-
-