org.apache.logging.log4j.core.tools.picocli

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 java.lang.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

Constructor and Description
MinimalParameterRenderer()

Method Summary

Modifier and Type	Method and Description
CommandLine.Help.Ansi.Text[][]	render(CommandLine.Parameters param, java.lang.reflect.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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MinimalParameterRenderer

MinimalParameterRenderer()

Method Detail

render

public CommandLine.Help.Ansi.Text[][] render(CommandLine.Parameters param,
                                             java.lang.reflect.Field field,
                                             CommandLine.Help.IParamLabelRenderer parameterLabelRenderer,
                                             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:

param - the command line parameters to show online usage help for

field - the field that will hold the value for the command line parameters

parameterLabelRenderer - 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