public static class CommandLine.Help.ColorScheme.Builder extends Object
ColorScheme instances.| Constructor and Description |
|---|
Builder()
Constructs an empty color scheme builder with Ansi.AUTO.
|
Builder(CommandLine.Help.Ansi ansi)
Constructs an empty color scheme builder with the specified Ansi value.
|
Builder(CommandLine.Help.ColorScheme existing)
Constructs a color scheme builder with all attributes copied from the specified color scheme.
|
| Modifier and Type | Method and Description |
|---|---|
CommandLine.Help.Ansi |
ansi()
Returns the
Ansi setting of this color scheme builder. |
CommandLine.Help.ColorScheme.Builder |
ansi(CommandLine.Help.Ansi ansi)
Returns the
Ansi setting of this color scheme builder. |
CommandLine.Help.ColorScheme.Builder |
applySystemProperties()
Replaces colors and styles in this scheme builder with ones specified in system properties, and returns this builder.
|
CommandLine.Help.ColorScheme |
build()
Creates and returns a new
ColorScheme with the values configured on this builder. |
CommandLine.Help.ColorScheme.Builder |
commands(CommandLine.Help.Ansi.IStyle... styles)
Adds the specified styles to the registered styles for commands in this color scheme builder and returns this builder.
|
List<CommandLine.Help.Ansi.IStyle> |
commandStyles()
Returns the registered styles for commands in this color scheme builder.
|
Map<String,CommandLine.Help.Ansi.IStyle> |
customMarkupMap()
Returns the custom mapping from markup names (the names of the
CommandLine.Help.Ansi.Style enum constants, like bold, italic, fg_blue, bg_green, etc) to CommandLine.Help.Ansi.IStyle objects in this color scheme. |
CommandLine.Help.ColorScheme.Builder |
customMarkupMap(Map<String,CommandLine.Help.Ansi.IStyle> newValue)
Sets the custom mapping from markup names (the names of the
CommandLine.Help.Ansi.Style enum constants, like bold, italic, fg_blue, bg_green, etc) to CommandLine.Help.Ansi.IStyle objects in this color scheme. |
CommandLine.Help.ColorScheme.Builder |
errors(CommandLine.Help.Ansi.IStyle... styles)
Adds the specified styles to the registered styles for errors in this color scheme builder and returns this builder.
|
List<CommandLine.Help.Ansi.IStyle> |
errorStyles()
Returns the registered styles for errors in this color scheme builder.
|
CommandLine.Help.ColorScheme.Builder |
optionParams(CommandLine.Help.Ansi.IStyle... styles)
Adds the specified styles to the registered styles for option parameters in this color scheme builder and returns this builder.
|
List<CommandLine.Help.Ansi.IStyle> |
optionParamStyles()
Returns the registered styles for option parameters in this color scheme builder.
|
CommandLine.Help.ColorScheme.Builder |
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.
|
List<CommandLine.Help.Ansi.IStyle> |
optionStyles()
Returns the registered styles for options in this color scheme builder.
|
CommandLine.Help.ColorScheme.Builder |
parameters(CommandLine.Help.Ansi.IStyle... styles)
Adds the specified styles to the registered styles for positional parameters in this color scheme builder and returns this builder.
|
List<CommandLine.Help.Ansi.IStyle> |
parameterStyles()
Returns the registered styles for positional parameters in this color scheme builder.
|
CommandLine.Help.ColorScheme.Builder |
stackTraces(CommandLine.Help.Ansi.IStyle... styles)
Adds the specified styles to the registered styles for stack traces in this color scheme builder and returns this builder.
|
List<CommandLine.Help.Ansi.IStyle> |
stackTraceStyles()
Returns the registered styles for stack traces in this color scheme builder.
|
public Builder()
public Builder(CommandLine.Help.Ansi ansi)
public Builder(CommandLine.Help.ColorScheme existing)
public CommandLine.Help.Ansi ansi()
Ansi setting of this color scheme builder.public CommandLine.Help.ColorScheme.Builder ansi(CommandLine.Help.Ansi ansi)
Ansi setting of this color scheme builder.public List<CommandLine.Help.Ansi.IStyle> commandStyles()
public List<CommandLine.Help.Ansi.IStyle> optionStyles()
public List<CommandLine.Help.Ansi.IStyle> parameterStyles()
public List<CommandLine.Help.Ansi.IStyle> optionParamStyles()
public List<CommandLine.Help.Ansi.IStyle> errorStyles()
public List<CommandLine.Help.Ansi.IStyle> stackTraceStyles()
public Map<String,CommandLine.Help.Ansi.IStyle> customMarkupMap()
CommandLine.Help.Ansi.Style enum constants, like bold, italic, fg_blue, bg_green, etc) to CommandLine.Help.Ansi.IStyle objects in this color scheme.
By default this returns null, unless a custom map was configured.public CommandLine.Help.ColorScheme.Builder customMarkupMap(Map<String,CommandLine.Help.Ansi.IStyle> newValue)
CommandLine.Help.Ansi.Style enum constants, like bold, italic, fg_blue, bg_green, etc) to CommandLine.Help.Ansi.IStyle objects in this color scheme.public CommandLine.Help.ColorScheme.Builder commands(CommandLine.Help.Ansi.IStyle... styles)
styles - the styles to add to the registered styles for commands in this color scheme builderpublic CommandLine.Help.ColorScheme.Builder options(CommandLine.Help.Ansi.IStyle... styles)
styles - the styles to add to registered the styles for options in this color scheme builderpublic CommandLine.Help.ColorScheme.Builder parameters(CommandLine.Help.Ansi.IStyle... styles)
styles - the styles to add to registered the styles for parameters in this color scheme builderpublic CommandLine.Help.ColorScheme.Builder optionParams(CommandLine.Help.Ansi.IStyle... styles)
styles - the styles to add to the registered styles for option parameters in this color scheme builderpublic CommandLine.Help.ColorScheme.Builder errors(CommandLine.Help.Ansi.IStyle... styles)
styles - the styles to add to the registered styles for errors in this color scheme builderpublic CommandLine.Help.ColorScheme.Builder stackTraces(CommandLine.Help.Ansi.IStyle... styles)
styles - the styles to add to the registered styles for stack traces in this color scheme builderpublic CommandLine.Help.ColorScheme.Builder applySystemProperties()
picocli.color.commandspicocli.color.optionspicocli.color.parameterspicocli.color.optionParamspicocli.color.errorspicocli.color.stackTracesProperty values can be anything that CommandLine.Help.Ansi.Style.parse(String) can handle.
public CommandLine.Help.ColorScheme build()
ColorScheme with the values configured on this builder.