Uses of Class
picocli.CommandLine.Help.ColorScheme
-
-
Uses of CommandLine.Help.ColorScheme in picocli
Fields in picocli declared as CommandLine.Help.ColorScheme Modifier and Type Field Description protected CommandLine.Help.ColorScheme
CommandLine.Help.Layout. colorScheme
Methods in picocli that return CommandLine.Help.ColorScheme Modifier and Type Method Description CommandLine.Help.ColorScheme
CommandLine.Help.ColorScheme.Builder. build()
Creates and returns a newColorScheme
with the values configured on this builder.CommandLine.Help.ColorScheme
CommandLine.AbstractHandler. colorScheme()
Deprecated.Returns the ColorScheme to use.CommandLine.Help.ColorScheme
CommandLine.Help. colorScheme()
Returns theColorScheme
model that this Help was constructed with.static CommandLine.Help.ColorScheme
CommandLine.Help. defaultColorScheme(CommandLine.Help.Ansi ansi)
Creates and returns a newCommandLine.Help.ColorScheme
initialized with picocli default values: commands are bold, options and parameters use a yellow foreground, and option parameters use italic.CommandLine.Help.ColorScheme
CommandLine. getColorScheme()
Returns the color scheme to use when printing help.Methods in picocli with parameters of type CommandLine.Help.ColorScheme Modifier and Type Method Description CommandLine.Help
CommandLine.IHelpFactory. create(CommandLine.Model.CommandSpec commandSpec, CommandLine.Help.ColorScheme colorScheme)
Returns aHelp
instance to assist in rendering the usage help messageString
CommandLine. getUsageMessage(CommandLine.Help.ColorScheme colorScheme)
Similar toCommandLine.usage(PrintStream, Help.ColorScheme)
, but returns the usage help message as a String instead of printing it to thePrintStream
.void
CommandLine.HelpCommand. init(CommandLine helpCommandLine, CommandLine.Help.ColorScheme colorScheme, PrintWriter out, PrintWriter err)
Initializes this object with the information needed to implement a help command that provides usage help for other commands.void
CommandLine.IHelpCommandInitializable2. init(CommandLine helpCommandLine, CommandLine.Help.ColorScheme colorScheme, PrintWriter outWriter, PrintWriter errWriter)
Initializes this object with the information needed to implement a help command that provides usage help for other commands.static boolean
CommandLine. printHelpIfRequested(List<CommandLine> parsedCommands, PrintStream out, PrintStream err, CommandLine.Help.ColorScheme colorScheme)
Deprecated.useCommandLine.executeHelpRequest(ParseResult)
insteadCommandLine.Help.Ansi.Text[][]
CommandLine.Help.IOptionRenderer. render(CommandLine.Model.OptionSpec option, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer, CommandLine.Help.ColorScheme scheme)
Returns a text representation of the specified option and its parameter(s) if any.CommandLine.Help.Ansi.Text[][]
CommandLine.Help.IParameterRenderer. render(CommandLine.Model.PositionalParamSpec param, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer, CommandLine.Help.ColorScheme scheme)
Returns a text representation of the specified positional parameter.CommandLine
CommandLine. setColorScheme(CommandLine.Help.ColorScheme colorScheme)
Sets the color scheme to use when printing help.CommandLine.Help.Ansi.Text
CommandLine.Model.ArgGroupSpec. synopsisText(CommandLine.Help.ColorScheme colorScheme, Set<CommandLine.Model.ArgSpec> outparam_groupArgs)
Returns the synopsis of this group.void
CommandLine. usage(PrintStream out, CommandLine.Help.ColorScheme colorScheme)
Prints a usage help message for the annotated command class to the specifiedPrintStream
.void
CommandLine. usage(PrintWriter writer, CommandLine.Help.ColorScheme colorScheme)
Similar toCommandLine.usage(PrintStream, Help.ColorScheme)
, but with the specifiedPrintWriter
instead of aPrintStream
.static void
CommandLine. usage(Object command, PrintStream out, CommandLine.Help.ColorScheme colorScheme)
Equivalent tonew CommandLine(command).usage(out, colorScheme)
.Constructors in picocli with parameters of type CommandLine.Help.ColorScheme Constructor Description Builder(CommandLine.Help.ColorScheme existing)
Constructs a color scheme builder with all attributes copied from the specified color scheme.Help(Object command, CommandLine.Help.ColorScheme colorScheme)
Help(CommandLine.Model.CommandSpec commandSpec, CommandLine.Help.ColorScheme colorScheme)
Constructs a newHelp
instance with the specified color scheme, initialized from annotatations on the specified class and superclasses.Layout(CommandLine.Help.ColorScheme colorScheme, int tableWidth)
Constructs a Layout with the specified color scheme, a new default TextTable, the default option renderer, and the default parameter renderer.Layout(CommandLine.Help.ColorScheme colorScheme, CommandLine.Help.TextTable textTable)
Constructs a Layout with the specified color scheme, the specified TextTable, the default option renderer, and the default parameter renderer.Layout(CommandLine.Help.ColorScheme colorScheme, CommandLine.Help.TextTable textTable, CommandLine.Help.IOptionRenderer optionRenderer, CommandLine.Help.IParameterRenderer parameterRenderer)
Constructs a Layout with the specified color scheme, the specified TextTable, the specified option renderer and the specified parameter renderer.
-