Uses of Enum
org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi
Packages that use CommandLine.Help.Ansi
-
Uses of CommandLine.Help.Ansi in org.apache.logging.log4j.core.tools.picocli
Fields in org.apache.logging.log4j.core.tools.picocli declared as CommandLine.Help.AnsiModifier and TypeFieldDescriptionprivate final CommandLine.Help.Ansi
CommandLine.Help.ColorScheme.ansi
private final CommandLine.Help.Ansi
CommandLine.Help.TextTable.ansi
Methods in org.apache.logging.log4j.core.tools.picocli that return CommandLine.Help.AnsiModifier and TypeMethodDescriptionCommandLine.Help.ansi()
Returns whether ANSI escape codes are enabled or not.CommandLine.Help.ColorScheme.ansi()
static CommandLine.Help.Ansi
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 org.apache.logging.log4j.core.tools.picocli with parameters of type CommandLine.Help.AnsiModifier and TypeMethodDescriptionstatic <C extends Callable<T>,
T>
TCommandLine.call
(C callable, PrintStream out, 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 newCommandLine.Help.ColorScheme
initialized with picocli default values: commands are bold, options and parameters use a yellow foreground, and option parameters use italic.CommandLine.DefaultExceptionHandler.handleException
(CommandLine.ParameterException ex, PrintStream out, CommandLine.Help.Ansi ansi, String... args) CommandLine.IExceptionHandler.handleException
(CommandLine.ParameterException ex, PrintStream out, CommandLine.Help.Ansi ansi, String... args) Handles aParameterException
that occurred while parsing the command line arguments and optionally returns a list of results.CommandLine.IParseResultHandler.handleParseResult
(List<CommandLine> parsedCommands, PrintStream out, CommandLine.Help.Ansi ansi) Processes a List ofCommandLine
objects resulting from successfully parsing the command line arguments and optionally returns a list of results.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 asRunnable
orCallable
.CommandLine.RunFirst.handleParseResult
(List<CommandLine> parsedCommands, PrintStream out, CommandLine.Help.Ansi ansi) Prints help if requested, and otherwise executes the top-levelRunnable
orCallable
command.CommandLine.RunLast.handleParseResult
(List<CommandLine> parsedCommands, PrintStream out, CommandLine.Help.Ansi ansi) Prints help if requested, and otherwise executes the most specificRunnable
orCallable
subcommand.private static String
CommandLine.Help.heading
(CommandLine.Help.Ansi ansi, String values, Object... params) static StringBuilder
CommandLine.Help.join
(CommandLine.Help.Ansi ansi, String[] values, StringBuilder sb, Object... params) Formats each of the specified values and appends it to the specified StringBuilder.CommandLine.parseWithHandlers
(CommandLine.IParseResultHandler handler, PrintStream out, CommandLine.Help.Ansi ansi, CommandLine.IExceptionHandler exceptionHandler, String... args) static boolean
CommandLine.printHelpIfRequested
(List<CommandLine> parsedCommands, PrintStream out, CommandLine.Help.Ansi ansi) Helper method that may be useful when processing the list ofCommandLine
objects that result from successfully parsing command line arguments.void
CommandLine.printVersionHelp
(PrintStream out, CommandLine.Help.Ansi ansi) Prints version information from theCommandLine.Command.version()
annotation to the specifiedPrintStream
.void
CommandLine.printVersionHelp
(PrintStream out, CommandLine.Help.Ansi ansi, Object... params) Prints version information from theCommandLine.Command.version()
annotation to the specifiedPrintStream
.CommandLine.Help.DefaultParamLabelRenderer.renderParameterLabel
(Field field, CommandLine.Help.Ansi ansi, List<CommandLine.Help.Ansi.IStyle> styles) CommandLine.Help.IParamLabelRenderer.renderParameterLabel
(Field field, 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>
voidCommandLine.run
(R runnable, PrintStream out, CommandLine.Help.Ansi ansi, String... args) Convenience method to allow command line application authors to avoid some boilerplate code in their application.void
CommandLine.usage
(PrintStream out, CommandLine.Help.Ansi ansi) Delegates toCommandLine.usage(PrintStream, Help.ColorScheme)
with the default color scheme.static void
CommandLine.usage
(Object command, PrintStream out, CommandLine.Help.Ansi ansi) Equivalent tonew CommandLine(command).usage(out, ansi)
.Constructors in org.apache.logging.log4j.core.tools.picocli with parameters of type CommandLine.Help.AnsiModifierConstructorDescriptionConstructs a new ColorScheme with the specified Ansi enabled mode.Help
(Object command, CommandLine.Help.Ansi ansi) Constructs a newHelp
instance with a default color scheme, initialized from annotatations on the specified class and superclasses.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)TextTable
(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.TextTable
(CommandLine.Help.Ansi ansi, CommandLine.Help.Column... columns) Constructs aTextTable
with the specified columns.