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

Class CommandLine.Help.DefaultOptionRenderer

java.lang.Object

org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.DefaultOptionRenderer

All Implemented Interfaces:

CommandLine.Help.IOptionRenderer

Enclosing class:

CommandLine.Help

static class CommandLine.Help.DefaultOptionRenderer
extends java.lang.Object
implements CommandLine.Help.IOptionRenderer

The DefaultOptionRenderer converts Options 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 option is required)
2. 2-character short option name (or empty string if no short option exists)
3. comma separator (only if both short option and long option exist, empty string otherwise)
4. comma-separated string with long option name(s)
5. first element of the CommandLine.Option.description() array

Following this, there will be one row for each of the remaining elements of the CommandLine.Option.description() array, and these rows look like {"", "", "", option.description()[i]}.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.Object	command
java.lang.String	requiredMarker
private java.lang.String	sep
private boolean	showDefault

Constructor Summary

Constructors

Constructor and Description
DefaultOptionRenderer()

Method Summary

Modifier and Type	Method and Description
private java.lang.Object	createDefaultValue(java.lang.reflect.Field field)
private CommandLine.Help.Ansi.Text	createLongOptionText(java.lang.reflect.Field field, CommandLine.Help.IParamLabelRenderer renderer, CommandLine.Help.ColorScheme scheme, java.lang.String longOption)
CommandLine.Help.Ansi.Text[][]	render(CommandLine.Option option, java.lang.reflect.Field field, CommandLine.Help.IParamLabelRenderer paramLabelRenderer, CommandLine.Help.ColorScheme scheme) Returns a text representation of the specified Option and the Field that captures the option value.
private CommandLine.Help.Ansi.Text[][]	renderDescriptionLines(CommandLine.Option option, CommandLine.Help.ColorScheme scheme, java.lang.String requiredOption, java.lang.String shortOption, CommandLine.Help.Ansi.Text longOptionText, java.lang.Object defaultValue)

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

command

public java.lang.Object command

sep

private java.lang.String sep

showDefault

private boolean showDefault

Constructor Detail

DefaultOptionRenderer

DefaultOptionRenderer()

Method Detail

render

public CommandLine.Help.Ansi.Text[][] render(CommandLine.Option option,
                                             java.lang.reflect.Field field,
                                             CommandLine.Help.IParamLabelRenderer paramLabelRenderer,
                                             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 interface CommandLine.Help.IOptionRenderer

Parameters:

option - the command line option to show online usage help for

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

paramLabelRenderer - responsible for rendering option parameters to text

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

createDefaultValue

private java.lang.Object createDefaultValue(java.lang.reflect.Field field)

createLongOptionText

private CommandLine.Help.Ansi.Text createLongOptionText(java.lang.reflect.Field field,
                                                        CommandLine.Help.IParamLabelRenderer renderer,
                                                        CommandLine.Help.ColorScheme scheme,
                                                        java.lang.String longOption)

renderDescriptionLines

private CommandLine.Help.Ansi.Text[][] renderDescriptionLines(CommandLine.Option option,
                                                              CommandLine.Help.ColorScheme scheme,
                                                              java.lang.String requiredOption,
                                                              java.lang.String shortOption,
                                                              CommandLine.Help.Ansi.Text longOptionText,
                                                              java.lang.Object defaultValue)