Class CommandLine.Help.ColorScheme
java.lang.Object
org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.ColorScheme
- Enclosing class:
CommandLine.Help
All usage help message are generated with a color scheme that assigns certain styles and colors to common
parts of a usage message: the command name, options, positional parameters and option parameters.
Users may customize these styles by creating Help with a custom color scheme.
Note that these options and styles may not be rendered if ANSI escape codes are not enabled.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final CommandLine.Help.Ansi
final List
<CommandLine.Help.Ansi.IStyle> final List
<CommandLine.Help.Ansi.IStyle> final List
<CommandLine.Help.Ansi.IStyle> final List
<CommandLine.Help.Ansi.IStyle> -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new ColorScheme withCommandLine.Help.Ansi.AUTO
.Constructs a new ColorScheme with the specified Ansi enabled mode. -
Method Summary
Modifier and TypeMethodDescriptionprivate CommandLine.Help.ColorScheme
addAll
(List<CommandLine.Help.Ansi.IStyle> styles, CommandLine.Help.Ansi.IStyle... add) ansi()
Replaces colors and styles in this scheme with ones specified in system properties, and returns this scheme.commands
(CommandLine.Help.Ansi.IStyle... styles) Adds the specified styles to the registered styles for commands in this color scheme and returns this color scheme.commandText
(String command) Returns a Text with all command styles applied to the specified command string.optionParams
(CommandLine.Help.Ansi.IStyle... styles) Adds the specified styles to the registered styles for option parameters in this color scheme and returns this color scheme.optionParamText
(String optionParam) Returns a Text with all optionParam styles applied to the specified optionParam string.options
(CommandLine.Help.Ansi.IStyle... styles) Adds the specified styles to the registered styles for options in this color scheme and returns this color scheme.optionText
(String option) Returns a Text with all option styles applied to the specified option string.parameters
(CommandLine.Help.Ansi.IStyle... styles) Adds the specified styles to the registered styles for positional parameters in this color scheme and returns this color scheme.parameterText
(String parameter) Returns a Text with all parameter styles applied to the specified parameter string.private void
replace
(List<CommandLine.Help.Ansi.IStyle> styles, String property)
-
Field Details
-
commandStyles
-
optionStyles
-
parameterStyles
-
optionParamStyles
-
ansi
-
-
Constructor Details
-
ColorScheme
public ColorScheme()Constructs a new ColorScheme withCommandLine.Help.Ansi.AUTO
. -
ColorScheme
Constructs a new ColorScheme with the specified Ansi enabled mode.- Parameters:
ansi
- whether to emit ANSI escape codes or not
-
-
Method Details
-
commands
Adds the specified styles to the registered styles for commands in this color scheme and returns this color scheme.- Parameters:
styles
- the styles to add to the registered styles for commands in this color scheme- Returns:
- this color scheme to enable method chaining for a more fluent API
-
options
Adds the specified styles to the registered styles for options in this color scheme and returns this color scheme.- Parameters:
styles
- the styles to add to registered the styles for options in this color scheme- Returns:
- this color scheme to enable method chaining for a more fluent API
-
parameters
Adds the specified styles to the registered styles for positional parameters in this color scheme and returns this color scheme.- Parameters:
styles
- the styles to add to registered the styles for parameters in this color scheme- Returns:
- this color scheme to enable method chaining for a more fluent API
-
optionParams
Adds the specified styles to the registered styles for option parameters in this color scheme and returns this color scheme.- Parameters:
styles
- the styles to add to the registered styles for option parameters in this color scheme- Returns:
- this color scheme to enable method chaining for a more fluent API
-
commandText
Returns a Text with all command styles applied to the specified command string.- Parameters:
command
- the command string to apply the registered command styles to- Returns:
- a Text with all command styles applied to the specified command string
-
optionText
Returns a Text with all option styles applied to the specified option string.- Parameters:
option
- the option string to apply the registered option styles to- Returns:
- a Text with all option styles applied to the specified option string
-
parameterText
Returns a Text with all parameter styles applied to the specified parameter string.- Parameters:
parameter
- the parameter string to apply the registered parameter styles to- Returns:
- a Text with all parameter styles applied to the specified parameter string
-
optionParamText
Returns a Text with all optionParam styles applied to the specified optionParam string.- Parameters:
optionParam
- the option parameter string to apply the registered option parameter styles to- Returns:
- a Text with all option parameter styles applied to the specified option parameter string
-
applySystemProperties
Replaces colors and styles in this scheme with ones specified in system properties, and returns this scheme. Supported property names:picocli.color.commands
picocli.color.options
picocli.color.parameters
picocli.color.optionParams
Property values can be anything that
CommandLine.Help.Ansi.Style.parse(String)
can handle.- Returns:
- this ColorScheme
-
replace
-
addAll
private CommandLine.Help.ColorScheme addAll(List<CommandLine.Help.Ansi.IStyle> styles, CommandLine.Help.Ansi.IStyle... add) -
ansi
-