public static class CommandLine.Help.ColorScheme extends Object
Note that these options and styles may not be rendered if ANSI escape codes are not enabled.
From 4.0, instances of this class are immutable.
Modifier and Type | Class | Description |
---|---|---|
static class |
CommandLine.Help.ColorScheme.Builder |
Builder class to create
ColorScheme instances. |
Modifier and Type | Method | Description |
---|---|---|
CommandLine.Help.Ansi |
ansi() |
Returns the
Ansi setting of this color scheme. |
List<CommandLine.Help.Ansi.IStyle> |
commandStyles() |
Returns the registered styles for commands in this color scheme.
|
CommandLine.Help.Ansi.Text |
commandText(String command) |
Returns a Text with all command styles applied to the specified command string.
|
boolean |
equals(Object obj) |
|
int |
hashCode() |
|
List<CommandLine.Help.Ansi.IStyle> |
optionParamStyles() |
Returns the registered styles for option parameters in this color scheme.
|
CommandLine.Help.Ansi.Text |
optionParamText(String optionParam) |
Returns a Text with all optionParam styles applied to the specified optionParam string.
|
List<CommandLine.Help.Ansi.IStyle> |
optionStyles() |
Returns the registered styles for options in this color scheme.
|
CommandLine.Help.Ansi.Text |
optionText(String option) |
Returns a Text with all option styles applied to the specified option string.
|
List<CommandLine.Help.Ansi.IStyle> |
parameterStyles() |
Returns the registered styles for positional parameters in this color scheme.
|
CommandLine.Help.Ansi.Text |
parameterText(String parameter) |
Returns a Text with all parameter styles applied to the specified parameter string.
|
public CommandLine.Help.Ansi.Text commandText(String command)
command
- the command string to apply the registered command styles topublic CommandLine.Help.Ansi.Text optionText(String option)
option
- the option string to apply the registered option styles topublic CommandLine.Help.Ansi.Text parameterText(String parameter)
parameter
- the parameter string to apply the registered parameter styles topublic CommandLine.Help.Ansi.Text optionParamText(String optionParam)
optionParam
- the option parameter string to apply the registered option parameter styles topublic CommandLine.Help.Ansi ansi()
Ansi
setting of this color scheme.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()
Copyright © 2017–2019. All rights reserved.