Class CommandLine.Help.MinimalParameterRenderer
java.lang.Object
org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.MinimalParameterRenderer
- All Implemented Interfaces:
CommandLine.Help.IParameterRenderer
- Enclosing class:
CommandLine.Help
static class CommandLine.Help.MinimalParameterRenderer
extends Object
implements CommandLine.Help.IParameterRenderer
The MinimalParameterRenderer converts
Parameters to a single row with two columns of
text: the parameters label and a description. If multiple description lines exist, the first value is used.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionrender(CommandLine.Parameters param, Field field, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer, CommandLine.Help.ColorScheme scheme) Returns a text representation of the specified Parameters and the Field that captures the parameter values.
-
Constructor Details
-
MinimalParameterRenderer
MinimalParameterRenderer()
-
-
Method Details
-
render
public CommandLine.Help.Ansi.Text[][] render(CommandLine.Parameters param, Field field, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer, CommandLine.Help.ColorScheme scheme) Description copied from interface:CommandLine.Help.IParameterRendererReturns a text representation of the specified Parameters and the Field that captures the parameter values.- Specified by:
renderin interfaceCommandLine.Help.IParameterRenderer- Parameters:
param- the command line parameters to show online usage help forfield- the field that will hold the value for the command line parametersparameterLabelRenderer- 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
-