Package | Description |
---|---|
org.apache.logging.log4j.core.tools.picocli |
Modifier and Type | Field and Description |
---|---|
CommandLine.Help.IParamLabelRenderer |
CommandLine.Help.parameterLabelRenderer
Option and positional parameter value label renderer used for the synopsis line(s) and the option list.
|
Modifier and Type | Method and Description |
---|---|
CommandLine.Help.IParamLabelRenderer |
CommandLine.Help.createDefaultParamLabelRenderer()
Returns a new default value renderer that separates option parameters from their options with the specified separator string, surrounds optional parameters with
'[' and ']'
characters and uses ellipses ("...") to indicate that any number of a parameter are allowed. |
static CommandLine.Help.IParamLabelRenderer |
CommandLine.Help.createMinimalParamLabelRenderer()
Returns a value renderer that returns the
paramLabel if defined or the field name otherwise. |
Modifier and Type | Method and Description |
---|---|
void |
CommandLine.Help.Layout.addOption(Field field,
CommandLine.Help.IParamLabelRenderer paramLabelRenderer)
Delegates to the
option renderer of this layout to obtain
text values for the specified CommandLine.Option , and then calls the CommandLine.Help.Layout.layout(Field, CommandLine.Help.Ansi.Text[][])
method to write these text values into the correct cells in the TextTable. |
void |
CommandLine.Help.Layout.addOptions(List<Field> fields,
CommandLine.Help.IParamLabelRenderer paramLabelRenderer)
Calls
CommandLine.Help.Layout.addOption(Field, CommandLine.Help.IParamLabelRenderer) for all non-hidden Options in the list. |
void |
CommandLine.Help.Layout.addPositionalParameter(Field field,
CommandLine.Help.IParamLabelRenderer paramLabelRenderer)
Delegates to the
parameter renderer of this layout
to obtain text values for the specified CommandLine.Parameters , and then calls
CommandLine.Help.Layout.layout(Field, CommandLine.Help.Ansi.Text[][]) to write these text values into the correct cells in the TextTable. |
void |
CommandLine.Help.Layout.addPositionalParameters(List<Field> fields,
CommandLine.Help.IParamLabelRenderer paramLabelRenderer)
Calls
CommandLine.Help.Layout.addPositionalParameter(Field, CommandLine.Help.IParamLabelRenderer) for all non-hidden Parameters in the list. |
String |
CommandLine.Help.optionList(CommandLine.Help.Layout layout,
Comparator<Field> optionSort,
CommandLine.Help.IParamLabelRenderer valueLabelRenderer)
Sorts all
Options with the specified comparator (if the comparator is non-null ),
then adds all non-hidden options to the
specified TextTable and returns the result of TextTable.toString(). |
String |
CommandLine.Help.parameterList(CommandLine.Help.Layout layout,
CommandLine.Help.IParamLabelRenderer paramLabelRenderer)
Returns the section of the usage help message that lists the parameters with their descriptions.
|
CommandLine.Help.Ansi.Text[][] |
CommandLine.Help.IOptionRenderer.render(CommandLine.Option option,
Field field,
CommandLine.Help.IParamLabelRenderer parameterLabelRenderer,
CommandLine.Help.ColorScheme scheme)
Returns a text representation of the specified Option and the Field that captures the option value.
|
CommandLine.Help.Ansi.Text[][] |
CommandLine.Help.IParameterRenderer.render(CommandLine.Parameters parameters,
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.
|
Copyright © 1999-2021 The Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.