Interface | Description |
---|---|
CommandLine.Help.Ansi.IStyle |
Defines the interface for an ANSI escape sequence.
|
CommandLine.Help.IOptionRenderer |
When customizing online help for
Option details, a custom IOptionRenderer can be
used to create textual representation of an Option in a tabular format: one or more rows, each containing
one or more columns. |
CommandLine.Help.IParameterRenderer |
When customizing online help for
Parameters details, a custom IParameterRenderer
can be used to create textual representation of a Parameters field in a tabular format: one or more rows,
each containing one or more columns. |
CommandLine.Help.IParamLabelRenderer |
When customizing online usage help for an option parameter or a positional parameter, a custom
IParamLabelRenderer can be used to render the parameter name or label to a String. |
CommandLine.ITypeConverter<K> |
When parsing command line arguments and initializing
fields annotated with
@Option or @Parameters ,
String values can be converted to any type for which a ITypeConverter is registered. |
Class | Description |
---|---|
CommandLine |
CommandLine interpreter that uses reflection to initialize an annotated domain object with values obtained from the
command line arguments.
|
CommandLine.Help |
A collection of methods and inner classes that provide fine-grained control over the contents and layout of
the usage help message to display to end users when help is requested or invalid input values were specified.
|
CommandLine.Help.ColorScheme |
All usage help message are generated with a color scheme that assigns certain styles and colors to common
parts of a usage message: the command name, options, positional parameters and option parameters.
|
CommandLine.Help.Column | |
CommandLine.Help.Layout |
Use a Layout to format usage help text for options and parameters in tabular format.
|
CommandLine.Help.TextTable |
Responsible for spacing out
CommandLine.Help.Ansi.Text values according to the CommandLine.Help.Column definitions the table was
created with. |
CommandLine.Range |
Describes the number of parameters required and accepted by an option or a positional parameter.
|
Enum | Description |
---|---|
CommandLine.Help.Ansi |
Provides methods and inner classes to support using ANSI escape codes in usage help messages.
|
CommandLine.Help.Ansi.Style |
A set of pre-defined ANSI escape code styles and colors, and a set of convenience methods for parsing
text with embedded markup style names, as well as convenience methods for converting
styles to strings with embedded escape codes.
|
CommandLine.Help.Column.Overflow |
Policy for handling text that is longer than the column width:
span multiple columns, wrap to the next row, or simply truncate the portion that doesn't fit.
|
Exception | Description |
---|---|
CommandLine.DuplicateOptionAnnotationsException |
Exception indicating that multiple fields have been annotated with the same Option name.
|
CommandLine.MissingParameterException |
Exception indicating that a required parameter was not specified.
|
CommandLine.MissingTypeConverterException |
Exception indicating that an annotated field had a type for which no
CommandLine.ITypeConverter was
registered. |
CommandLine.OverwrittenOptionException |
Exception indicating that an option for a single-value field has been specified multiple times on the command line.
|
CommandLine.ParameterException |
Exception indicating something went wrong while parsing command line options.
|
CommandLine.ParameterIndexGapException |
Exception indicating that there was a gap in the indices of the fields annotated with
CommandLine.Parameters . |
CommandLine.UnmatchedArgumentException |
Exception indicating that a command line argument could not be mapped to any of the fields annotated with
CommandLine.Option or CommandLine.Parameters . |
Annotation Type | Description |
---|---|
CommandLine.Command |
Annotate your class with
@Command when you want more control over the format of the generated help
message. |
CommandLine.Option |
Annotate fields in your class with
@Option and picocli will initialize these fields when matching
arguments are specified on the command line. |
CommandLine.Parameters |
Fields annotated with
@Parameters will be initialized with positional parameters. |
Copyright © 1999-2017 The Apache Software Foundation. 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.