Class CommandLine.Help.MinimalOptionRenderer
- java.lang.Object
-
- org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.MinimalOptionRenderer
-
- All Implemented Interfaces:
CommandLine.Help.IOptionRenderer
- Enclosing class:
- CommandLine.Help
static class CommandLine.Help.MinimalOptionRenderer extends java.lang.Object implements CommandLine.Help.IOptionRenderer
The MinimalOptionRenderer convertsOptions
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 Constructor Description MinimalOptionRenderer()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CommandLine.Help.Ansi.Text[][]
render(CommandLine.Option option, java.lang.reflect.Field field, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer, CommandLine.Help.ColorScheme scheme)
Returns a text representation of the specified Option and the Field that captures the option value.
-
-
-
Method Detail
-
render
public CommandLine.Help.Ansi.Text[][] render(CommandLine.Option option, java.lang.reflect.Field field, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer, CommandLine.Help.ColorScheme scheme)
Description copied from interface:CommandLine.Help.IOptionRenderer
Returns a text representation of the specified Option and the Field that captures the option value.- Specified by:
render
in interfaceCommandLine.Help.IOptionRenderer
- Parameters:
option
- the command line option to show online usage help forfield
- the field that will hold the value for the command line optionparameterLabelRenderer
- 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
-
-