CommandLine.Help.DefaultParameterRenderer

java.lang.Object
- org.apache.logging.log4j.core.tools.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 Parameters to five columns of text to match the default TextTable column layout. The first row of values looks like this:
1. the required option marker (if the parameter's arity is to have at least one value)
2. empty string
3. empty string
4. parameter(s) label as rendered by the CommandLine.Help.IParamLabelRenderer
5. first element of the CommandLine.Parameters.description() array
Following this, there will be one row for each of the remaining elements of the CommandLine.Parameters.description() array, and these rows look like {"", "", "", param.description()[i]}.

Field Summary

Fields
Modifier and Type Field Description

java.lang.String requiredMarker

Constructor Summary

Constructors
Constructor Description

DefaultParameterRenderer()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CommandLine.Help.Ansi.Text[][]`	`render(CommandLine.Parameters params, java.lang.reflect.Field field, CommandLine.Help.IParamLabelRenderer paramLabelRenderer, CommandLine.Help.ColorScheme scheme)`	Returns a text representation of the specified Parameters and the Field that captures the parameter values.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - requiredMarker
```
public java.lang.String requiredMarker
```
- Constructor Detail
  - DefaultParameterRenderer
```
DefaultParameterRenderer()
```
- Method Detail
  - render
```
public CommandLine.Help.Ansi.Text[][] render(CommandLine.Parameters params,
                                             java.lang.reflect.Field field,
                                             CommandLine.Help.IParamLabelRenderer paramLabelRenderer,
                                             CommandLine.Help.ColorScheme scheme)
```
    Description copied from interface: CommandLine.Help.IParameterRenderer
    
    Returns a text representation of the specified Parameters and the Field that captures the parameter values.
    
    Specified by:
    
    render in interface CommandLine.Help.IParameterRenderer
    
    Parameters:
    
    params - the command line parameters to show online usage help for
    
    field - the field that will hold the value for the command line parameters
    
    paramLabelRenderer - responsible for rendering parameter labels to text
    
    scheme - 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