Package | Description |
---|---|
org.apache.logging.log4j.core.tools.picocli |
Modifier and Type | Method | Description |
---|---|---|
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(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.
|
Modifier and Type | Method | Description |
---|---|---|
static <C extends Callable<T>,T> |
CommandLine.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 new
CommandLine.Help.ColorScheme initialized with picocli default values: commands are bold,
options and parameters use a yellow foreground, and option parameters use italic. |
List<Object> |
CommandLine.DefaultExceptionHandler.handleException(CommandLine.ParameterException ex,
PrintStream out,
CommandLine.Help.Ansi ansi,
String... args) |
|
List<Object> |
CommandLine.IExceptionHandler.handleException(CommandLine.ParameterException ex,
PrintStream out,
CommandLine.Help.Ansi ansi,
String... args) |
Handles a
ParameterException that occurred while parsing the command
line arguments and optionally returns a list of results. |
List<Object> |
CommandLine.IParseResultHandler.handleParseResult(List<CommandLine> parsedCommands,
PrintStream out,
CommandLine.Help.Ansi ansi) |
Processes a List of
CommandLine objects resulting from successfully
parsing the command line arguments and optionally returns a list of results. |
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 . |
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. |
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.
|
List<Object> |
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 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(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> |
CommandLine.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 to
CommandLine.usage(PrintStream, Help.ColorScheme) with the default color scheme. |
static void |
CommandLine.usage(Object command,
PrintStream out,
CommandLine.Help.Ansi ansi) |
Equivalent to
new CommandLine(command).usage(out, ansi) . |
Constructor | Description |
---|---|
ColorScheme(CommandLine.Help.Ansi ansi) |
Constructs a new 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) |
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 a
TextTable with the specified columns. |
Copyright © 1999-2018. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.