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

Class CommandLine.Help.DefaultParamLabelRenderer

java.lang.Object

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

All Implemented Interfaces:

CommandLine.Help.IParamLabelRenderer

Enclosing class:

CommandLine.Help

static class CommandLine.Help.DefaultParamLabelRenderer
extends java.lang.Object
implements CommandLine.Help.IParamLabelRenderer

DefaultParamLabelRenderer separates option parameters from their options with a separator string, surrounds optional values with '[' and ']' characters and uses ellipses ("...") to indicate that any number of values is allowed for options or parameters with variable arity.

Field Summary

Fields

Modifier and Type	Field	Description
java.lang.String	separator	The string to use to separate option parameters from their options.

Constructor Summary

Constructors

Constructor	Description
DefaultParamLabelRenderer(java.lang.String separator)	Constructs a new DefaultParamLabelRenderer with the specified separator string.

Method Summary

Modifier and Type	Method	Description
CommandLine.Help.Ansi.Text	renderParameterLabel(java.lang.reflect.Field field, CommandLine.Help.Ansi ansi, java.util.List<CommandLine.Help.Ansi.IStyle> styles)	Returns a text rendering of the Option parameter or positional parameter; returns an empty string "" if the option is a boolean and does not take a parameter.
private static java.lang.String	renderParameterName(java.lang.reflect.Field field)
java.lang.String	separator()	Returns the separator between option name and param label.

Methods inherited from class java.lang.Object

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

Field Detail

separator

public final java.lang.String separator

The string to use to separate option parameters from their options.

Constructor Detail

DefaultParamLabelRenderer

public DefaultParamLabelRenderer(java.lang.String separator)

Constructs a new DefaultParamLabelRenderer with the specified separator string.

Method Detail

separator

public java.lang.String separator()

Description copied from interface: CommandLine.Help.IParamLabelRenderer

Returns the separator between option name and param label.

Specified by:

separator in interface CommandLine.Help.IParamLabelRenderer

Returns:

the separator between option name and param label

renderParameterLabel

public CommandLine.Help.Ansi.Text renderParameterLabel(java.lang.reflect.Field field,
                                                       CommandLine.Help.Ansi ansi,
                                                       java.util.List<CommandLine.Help.Ansi.IStyle> styles)

Description copied from interface: CommandLine.Help.IParamLabelRenderer

Returns a text rendering of the Option parameter or positional parameter; returns an empty string "" if the option is a boolean and does not take a parameter.

Specified by:

renderParameterLabel in interface CommandLine.Help.IParamLabelRenderer

Parameters:

field - the annotated field with a parameter label

ansi - determines whether ANSI escape codes should be emitted or not

styles - the styles to apply to the parameter label

Returns:

a text rendering of the Option parameter or positional parameter

renderParameterName

private static java.lang.String renderParameterName(java.lang.reflect.Field field)