## Uses of Class
picocli.CommandLine.Help.Ansi

- Packages that use CommandLine.Help.Ansi
  Package | Description
  --- | ---
  picocli | Provides classes and interfaces for the main picocli command line parsing and `autocompletion` functionality.

- - ### Uses of CommandLine.Help.Ansi in picocli

    Methods in picocli that return CommandLine.Help.Ansi
    Modifier and Type | Method and Description
    --- | ---
    `CommandLine.Help.Ansi` | CommandLine.AbstractHandler.`ansi()` Returns the ANSI style to use.
    `CommandLine.Help.Ansi` | CommandLine.Help.`ansi()` Returns whether ANSI escape codes are enabled or not.
    `CommandLine.Help.Ansi` | CommandLine.Help.ColorScheme.`ansi()`
    `static CommandLine.Help.Ansi` | CommandLine.Help.Ansi.`valueOf(boolean enabled)` Returns Ansi.ON if the specified `enabled` flag is true, Ansi.OFF otherwise.
    `static CommandLine.Help.Ansi` | CommandLine.Help.Ansi.`valueOf(String name)` Returns the enum constant of this type with the specified name.
    `static CommandLine.Help.Ansi[]` | CommandLine.Help.Ansi.`values()` Returns an array containing the constants of this enum type, in the order they are declared.

    Methods in picocli with parameters of type CommandLine.Help.Ansi
    Modifier and Type | Method and Description
    --- | ---
    `static <C extends Callable<T>,T> T` | CommandLine.`call(Class<C> callableClass, CommandLine.IFactory factory, PrintStream out, CommandLine.Help.Ansi ansi, String... args)` Delegates to `CommandLine.call(Class, IFactory, PrintStream, PrintStream, Help.Ansi, String...)` with `System.err` for diagnostic error messages.
    `static <C extends Callable<T>,T> T` | CommandLine.`call(Class<C> callableClass, CommandLine.IFactory factory, PrintStream out, PrintStream err, CommandLine.Help.Ansi ansi, String... args)` Convenience method to allow command line application authors to avoid some boilerplate code in their application.
    `static <C extends Callable<T>,T> T` | CommandLine.`call(C callable, PrintStream out, CommandLine.Help.Ansi ansi, String... args)` Delegates to `CommandLine.call(Callable, PrintStream, PrintStream, Help.Ansi, String...)` with `System.err` for diagnostic error messages.
    `static <C extends Callable<T>,T> T` | CommandLine.`call(C callable, PrintStream out, PrintStream err, CommandLine.Help.Ansi ansi, String... args)` Convenience method to allow command line application authors to avoid some boilerplate code in their application.
    `static CommandLine.Help.ColorScheme` | CommandLine.Help.`defaultColorScheme(CommandLine.Help.Ansi ansi)` Creates and returns a new `CommandLine.Help.ColorScheme` initialized with picocli default values: commands are bold, options and parameters use a yellow foreground, and option parameters use italic.
    `static CommandLine.Help.TextTable` | CommandLine.Help.TextTable.`forColumns(CommandLine.Help.Ansi ansi, CommandLine.Help.Column... columns)` Constructs a `TextTable` with the specified columns.
    `static CommandLine.Help.TextTable` | CommandLine.Help.TextTable.`forColumnWidths(CommandLine.Help.Ansi ansi, int... columnWidths)` Constructs a new TextTable with columns with the specified width, all SPANning multiple columns on overflow except the last column which WRAPS to the next row.
    `static CommandLine.Help.TextTable` | CommandLine.Help.TextTable.`forDefaultColumns(CommandLine.Help.Ansi ansi, int usageHelpWidth)` Constructs a TextTable with five columns as follows: required option/parameter marker (width: 2, indent: 0, TRUNCATE on overflow) short option name (width: 2, indent: 0, TRUNCATE on overflow) comma separator (width: 1, indent: 0, TRUNCATE on overflow) long option name(s) (width: 24, indent: 1, SPAN multiple columns on overflow) description line(s) (width: 51, indent: 1, WRAP to next row on overflow)
    `static CommandLine.Help.TextTable` | CommandLine.Help.TextTable.`forDefaultColumns(CommandLine.Help.Ansi ansi, int longOptionsColumnWidth, int usageHelpWidth)` Constructs a TextTable with five columns as follows: required option/parameter marker (width: 2, indent: 0, TRUNCATE on overflow) short option name (width: 2, indent: 0, TRUNCATE on overflow) comma separator (width: 1, indent: 0, TRUNCATE on overflow) long option name(s) (width: 24, indent: 1, SPAN multiple columns on overflow) description line(s) (width: 51, indent: 1, WRAP to next row on overflow)
    `String` | CommandLine.`getUsageMessage(CommandLine.Help.Ansi ansi)` Similar to `CommandLine.usage(PrintStream, Help.Ansi)`, but returns the usage help message as a String instead of printing it to the `PrintStream`.
    `List<Object>` | CommandLine.IExceptionHandler.`handleException(CommandLine.ParameterException ex, PrintStream out, CommandLine.Help.Ansi ansi, String... args)` Deprecated. Handles a `ParameterException` that occurred while parsing the command line arguments and optionally returns a list of results.
    `List<Object>` | CommandLine.DefaultExceptionHandler.`handleException(CommandLine.ParameterException ex, PrintStream out, CommandLine.Help.Ansi ansi, String... args)`
    `List<Object>` | CommandLine.IParseResultHandler.`handleParseResult(List<CommandLine> parsedCommands, PrintStream out, CommandLine.Help.Ansi ansi)` Deprecated. Processes a List of `CommandLine` objects resulting from successfully parsing the command line arguments and optionally returns a list of results.
    `List<Object>` | CommandLine.RunFirst.`handleParseResult(List<CommandLine> parsedCommands, PrintStream out, CommandLine.Help.Ansi ansi)` Prints help if requested, and otherwise executes the top-level `Runnable` or `Callable` command.
    `List<Object>` | CommandLine.RunLast.`handleParseResult(List<CommandLine> parsedCommands, PrintStream out, CommandLine.Help.Ansi ansi)` Prints help if requested, and otherwise executes the most specific `Runnable` or `Callable` subcommand.
    `List<Object>` | CommandLine.RunAll.`handleParseResult(List<CommandLine> parsedCommands, PrintStream out, CommandLine.Help.Ansi ansi)` Prints help if requested, and otherwise executes the top-level command and all subcommands as `Runnable` or `Callable`.
    `void` | CommandLine.HelpCommand.`init(CommandLine helpCommandLine, CommandLine.Help.Ansi ansi, PrintStream out, PrintStream err)` Initializes this object with the information needed to implement a help command that provides usage help for other commands.
    `void` | CommandLine.IHelpCommandInitializable.`init(CommandLine helpCommandLine, CommandLine.Help.Ansi ansi, PrintStream out, PrintStream err)` Initializes this object with the information needed to implement a help command that provides usage help for other commands.
    `static Object` | CommandLine.`invoke(String methodName, Class<?> cls, PrintStream out, CommandLine.Help.Ansi ansi, String... args)` Delegates to `CommandLine.invoke(String, Class, PrintStream, PrintStream, Help.Ansi, String...)` with the specified stream for requested usage help messages, `System.err` for diagnostic error messages, and the specified Ansi mode.
    `static Object` | CommandLine.`invoke(String methodName, Class<?> cls, PrintStream out, PrintStream err, CommandLine.Help.Ansi ansi, String... args)` Convenience method to allow command line application authors to avoid some boilerplate code in their application.
    `static StringBuilder` | CommandLine.Help.`join(CommandLine.Help.Ansi ansi, int usageHelpWidth, String[] values, StringBuilder sb, Object... params)` Formats each of the specified values and appends it to the specified StringBuilder.
    `List<Object>` | CommandLine.`parseWithHandlers(CommandLine.IParseResultHandler handler, PrintStream out, CommandLine.Help.Ansi ansi, CommandLine.IExceptionHandler exceptionHandler, String... args)` Deprecated. use `CommandLine.parseWithHandlers(IParseResultHandler2, IExceptionHandler2, String...)` instead
    `static boolean` | CommandLine.`printHelpIfRequested(List<CommandLine> parsedCommands, PrintStream out, CommandLine.Help.Ansi ansi)` Deprecated. use `CommandLine.printHelpIfRequested(List, PrintStream, PrintStream, Help.Ansi)` instead
    `static boolean` | CommandLine.`printHelpIfRequested(List<CommandLine> parsedCommands, PrintStream out, PrintStream err, CommandLine.Help.Ansi ansi)` Helper method that may be useful when processing the list of `CommandLine` objects that result from successfully parsing command line arguments.
    `void` | CommandLine.`printVersionHelp(PrintStream out, CommandLine.Help.Ansi ansi)` Prints version information from the `CommandLine.Command.version()` annotation to the specified `PrintStream`.
    `void` | CommandLine.`printVersionHelp(PrintStream out, CommandLine.Help.Ansi ansi, Object... params)` Prints version information from the `CommandLine.Command.version()` annotation to the specified `PrintStream`.
    `CommandLine.Help.Ansi.Text` | CommandLine.Help.IParamLabelRenderer.`renderParameterLabel(CommandLine.Model.ArgSpec argSpec, CommandLine.Help.Ansi ansi, List<CommandLine.Help.Ansi.IStyle> styles)` Returns a text rendering of the option parameter or positional parameter; returns an empty string `""` if the option is a boolean and does not take a parameter.
    `static <R extends Runnable> void` | CommandLine.`run(Class<R> runnableClass, CommandLine.IFactory factory, PrintStream out, CommandLine.Help.Ansi ansi, String... args)` Delegates to `CommandLine.run(Class, IFactory, PrintStream, PrintStream, Help.Ansi, String...)` with `System.err` for diagnostic error messages.
    `static <R extends Runnable> void` | CommandLine.`run(Class<R> runnableClass, CommandLine.IFactory factory, PrintStream out, PrintStream err, CommandLine.Help.Ansi ansi, String... args)` Convenience method to allow command line application authors to avoid some boilerplate code in their application.
    `static <R extends Runnable> void` | CommandLine.`run(R runnable, PrintStream out, CommandLine.Help.Ansi ansi, String... args)` Delegates to `CommandLine.run(Runnable, PrintStream, PrintStream, Help.Ansi, String...)` with `System.err` for diagnostic error messages.
    `static <R extends Runnable> void` | CommandLine.`run(R runnable, PrintStream out, PrintStream err, CommandLine.Help.Ansi ansi, String... args)` Convenience method to allow command line application authors to avoid some boilerplate code in their application.
    `static void` | CommandLine.`usage(Object command, PrintStream out, CommandLine.Help.Ansi ansi)` Equivalent to `new CommandLine(command).usage(out, ansi)`.
    `void` | CommandLine.`usage(PrintStream out, CommandLine.Help.Ansi ansi)` Delegates to `CommandLine.usage(PrintStream, Help.ColorScheme)` with the default color scheme.
    `void` | CommandLine.`usage(PrintWriter writer, CommandLine.Help.Ansi ansi)` Similar to `CommandLine.usage(PrintStream, Help.Ansi)` but with the specified `PrintWriter` instead of a `PrintStream`.
    `T` | CommandLine.AbstractHandler.`useAnsi(CommandLine.Help.Ansi ansi)` Sets the ANSI style to use.

    Constructors in picocli with parameters of type CommandLine.Help.Ansi
    Constructor and Description
    `ColorScheme(CommandLine.Help.Ansi ansi)` Constructs a new empty ColorScheme with the specified Ansi enabled mode.
    `Help(Object command, CommandLine.Help.Ansi ansi)` Constructs a new `Help` instance with a default color scheme, initialized from annotatations on the specified class and superclasses.
    `TextTable(CommandLine.Help.Ansi ansi, CommandLine.Help.Column[] columns)`

Copyright © 2020. All rights reserved.