Package picocli
Class CommandLine.Help.MinimalOptionRenderer
java.lang.Object
picocli.CommandLine.Help.MinimalOptionRenderer
- All Implemented Interfaces:
CommandLine.Help.IOptionRenderer
- Enclosing class:
CommandLine.Help
static class CommandLine.Help.MinimalOptionRenderer
extends Object
implements CommandLine.Help.IOptionRenderer
The MinimalOptionRenderer converts
Options
to a single row with two columns of text: an
option name and a description. If multiple names or description lines exist, the first value is used.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionrender
(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.
-
Constructor Details
-
MinimalOptionRenderer
MinimalOptionRenderer()
-
-
Method Details
-
render
public CommandLine.Help.Ansi.Text[][] render(CommandLine.Model.OptionSpec option, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer, CommandLine.Help.ColorScheme scheme) Description copied from interface:CommandLine.Help.IOptionRenderer
Returns a text representation of the specified option and its parameter(s) if any.- Specified by:
render
in interfaceCommandLine.Help.IOptionRenderer
- Parameters:
option
- the command line option to show online usage help forparameterLabelRenderer
- responsible for rendering option parameters to textscheme
- color scheme for applying ansi color styles to options and option parameters- Returns:
- a 2-dimensional array of text values: one or more rows, each containing one or more columns
-