Skip navigation links
A B C D E F G H I J K L M N O P Q R S T U V W 

A

abbreviatedOptionsAllowed() - Method in class picocli.CommandLine.Model.ParserSpec
 
abbreviatedOptionsAllowed(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
abbreviatedSubcommandsAllowed() - Method in class picocli.CommandLine.Model.ParserSpec
 
abbreviatedSubcommandsAllowed(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
abbreviatedSynopsis() - Method in class picocli.CommandLine.Help
Generates a generic synopsis like <command name> [OPTIONS] [PARAM1 [PARAM2]...], omitting parts that don't apply to the command (e.g., does not show [OPTIONS] if the command has no options).
abbreviateSynopsis() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns whether the synopsis line(s) should show an abbreviated synopsis without detailed option names.
abbreviateSynopsis(boolean) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets whether the synopsis line(s) should show an abbreviated synopsis without detailed option names.
AbstractHandler() - Constructor for class picocli.CommandLine.AbstractHandler
Deprecated.
 
AbstractParseResultHandler() - Constructor for class picocli.CommandLine.AbstractParseResultHandler
Deprecated.
 
add(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.Model.CommandSpec
Adds the specified option spec or positional parameter spec to the list of configured arguments to expect.
add(CommandLine.Model.ArgSpec, int) - Method in class picocli.CommandLine.ParseResult.Builder
Adds the specified OptionSpec or PositionalParamSpec to the list of options and parameters that were matched on the command line.
addAllOptions(List<CommandLine.Model.OptionSpec>, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help.Layout
addAllPositionalParameters(List<CommandLine.Model.PositionalParamSpec>, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help.Layout
addAllSubcommands(Map<String, CommandLine>) - Method in class picocli.CommandLine.Help
Registers all specified subcommands with this Help.
addArg(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Adds the specified argument to the list of options and positional parameters that depend on this group.
addArgGroup(CommandLine.Model.ArgGroupSpec) - Method in class picocli.CommandLine.Model.CommandSpec
Adds the specified argument group to the groups in this command.
addEmptyRow() - Method in class picocli.CommandLine.Help.TextTable
Adds the required char[] slots for a new row to the CommandLine.Help.TextTable.columnValues field.
addError(CommandLine.PicocliException) - Method in class picocli.CommandLine.ParseResult.Builder
 
addMethodSubcommands() - Method in class picocli.CommandLine.Model.CommandSpec
Reflects on the class of the user object and registers any command methods (class methods annotated with @Command) as subcommands.
addMethodSubcommands(CommandLine.IFactory) - Method in class picocli.CommandLine.Model.CommandSpec
Reflects on the class of the user object and registers any command methods (class methods annotated with @Command) as subcommands.
addMixin(String, Object) - Method in class picocli.CommandLine
Adds the options and positional parameters in the specified mixin to this command.
addMixin(String, CommandLine.Model.CommandSpec, CommandLine.Model.IAnnotatedElement) - Method in class picocli.CommandLine.Model.CommandSpec
Adds the specified mixin CommandSpec object to the map of mixins for this command.
addMixin(String, CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.Model.CommandSpec
Adds the specified mixin CommandSpec object to the map of mixins for this command.
addOption(CommandLine.Model.OptionSpec, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help.Layout
Delegates to the option renderer of this layout to obtain text values for the specified CommandLine.Model.OptionSpec, and then calls the CommandLine.Help.Layout.layout(CommandLine.Model.ArgSpec, CommandLine.Help.Ansi.Text[][]) method to write these text values into the correct cells in the TextTable.
addOption(CommandLine.Model.OptionSpec) - Method in class picocli.CommandLine.Model.CommandSpec
Adds the specified option spec to the list of configured arguments to expect.
addOption(CommandLine.Model.OptionSpec) - Method in class picocli.CommandLine.ParseResult.Builder
Adds the specified OptionSpec to the list of options that were matched on the command line.
addOptions(List<CommandLine.Model.OptionSpec>, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help.Layout
addParentCommandElement(CommandLine.Model.IAnnotatedElement) - Method in class picocli.CommandLine.Model.CommandSpec
Adds the specified {@literal @}ParentCommand-annotated program element to the list of elements for this command.
addPattern(String, String, String) - Method in class picocli.CommandLine.RegexTransformer.Builder
Adds the specified negative replacement and synopsis replacement for the specified regular expression.
addPositional(CommandLine.Model.PositionalParamSpec) - Method in class picocli.CommandLine.Model.CommandSpec
Adds the specified positional parameter spec to the list of configured arguments to expect.
addPositionalParam(CommandLine.Model.PositionalParamSpec, int) - Method in class picocli.CommandLine.ParseResult.Builder
Adds the specified PositionalParamSpec to the list of parameters that were matched on the command line.
addPositionalParameter(CommandLine.Model.PositionalParamSpec, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help.Layout
Delegates to the parameter renderer of this layout to obtain text values for the specified positional parameter, and then calls CommandLine.Help.Layout.layout(CommandLine.Model.ArgSpec, CommandLine.Help.Ansi.Text[][]) to write these text values into the correct cells in the TextTable.
addPositionalParameters(List<CommandLine.Model.PositionalParamSpec>, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help.Layout
addRowValues(String...) - Method in class picocli.CommandLine.Help.TextTable
Delegates to CommandLine.Help.TextTable.addRowValues(CommandLine.Help.Ansi.Text...), after ensuring that multi-line values are layed out in the correct row and column.
addRowValues(CommandLine.Help.Ansi.Text...) - Method in class picocli.CommandLine.Help.TextTable
Adds a new empty row, then calls putValue for each of the specified values, adding more empty rows if the return value indicates that the value spanned multiple columns or was wrapped to multiple rows.
addSpecElement(CommandLine.Model.IAnnotatedElement) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Adds the specified {@literal @}Spec annotated program element to the list of spec elements for this group.
addSpecElement(CommandLine.Model.IAnnotatedElement) - Method in class picocli.CommandLine.Model.CommandSpec
Adds the specified {@literal @}Spec-annotated program element to the list of elements for this command.
addSubcommand(Object) - Method in class picocli.CommandLine
Registers a subcommand with the name obtained from the @Command(name = "...") annotation attribute of the specified command.
addSubcommand(String, Object) - Method in class picocli.CommandLine
Registers a subcommand with the specified name.
addSubcommand(String, Object, String...) - Method in class picocli.CommandLine
Registers a subcommand with the specified name and all specified aliases.
addSubcommand(String, Object) - Method in class picocli.CommandLine.Help
addSubcommand(String, CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.Model.CommandSpec
Adds the specified subcommand with the specified name.
addSubcommand(String, CommandLine) - Method in class picocli.CommandLine.Model.CommandSpec
Adds the specified subcommand with the specified name.
addSubgroup(CommandLine.Model.ArgGroupSpec) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Adds the specified group to the list of subgroups that this group is composed of.
addUnmatched(String) - Method in class picocli.CommandLine.ParseResult.Builder
Adds the specified command line argument to the list of unmatched command line arguments.
addUnmatched(Stack<String>) - Method in class picocli.CommandLine.ParseResult.Builder
Adds all elements of the specified command line arguments stack to the list of unmatched command line arguments.
addUnmatchedArgsBinding(CommandLine.Model.UnmatchedArgsBinding) - Method in class picocli.CommandLine.Model.CommandSpec
Adds the specified UnmatchedArgsBinding to the list of model objects to capture unmatched arguments for this command.
adjustLineBreaksForWideCJKCharacters() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns whether line breaks should take wide Chinese, Japanese and Korean characters into account for line-breaking purposes.
adjustLineBreaksForWideCJKCharacters(boolean) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets whether line breaks should take wide Chinese, Japanese and Korean characters into account, and returns this UsageMessageSpec.
aliases() - Method in class picocli.CommandLine.Help
Returns the list of aliases for the command in this Help.
aliases() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the alias command names of this subcommand.
aliases(String...) - Method in class picocli.CommandLine.Model.CommandSpec
Sets the alternative names by which this subcommand is recognized on the command line.
allOptionsNested() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns all options configured for this group and all subgroups.
allowOptionsAsOptionParameters() - Method in class picocli.CommandLine.Model.ParserSpec
 
allowOptionsAsOptionParameters(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
allowSubcommandsAsOptionParameters() - Method in class picocli.CommandLine.Model.ParserSpec
 
allowSubcommandsAsOptionParameters(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
allPositionalParametersNested() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns all positional parameters configured for this group and all subgroups.
allSubcommands() - Method in class picocli.CommandLine.Help
Returns the map of all subcommand Help instances (including hidden commands) for this command Help.
andExit(int) - Method in class picocli.CommandLine.AbstractHandler
Deprecated.
use CommandLine.execute(String...) instead, and call System.exit() in the application.
annotatedElement - Variable in class picocli.CommandLine.Model.ArgSpec
 
ansi() - Method in class picocli.CommandLine.AbstractHandler
ansi() - Method in class picocli.CommandLine.Help
Returns whether ANSI escape codes are enabled or not.
ansi() - Method in class picocli.CommandLine.Help.ColorScheme
Returns the Ansi setting of this color scheme.
ansi() - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Returns the Ansi setting of this color scheme builder.
ansi(CommandLine.Help.Ansi) - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Set the Ansi setting of this color scheme builder.
append(String) - Method in class picocli.CommandLine.Help.Ansi.Text
append(CommandLine.Help.Ansi.Text) - Method in class picocli.CommandLine.Help.Ansi.Text
apply(String, List<CommandLine.Help.Ansi.IStyle>) - Method in enum picocli.CommandLine.Help.Ansi
apply(String, List<CommandLine.Help.Ansi.IStyle>) - Method in class picocli.CommandLine.Help.ColorScheme
Returns a new Text object where all the specified styles are applied to the full length of the specified plain text.
applySystemProperties() - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Replaces colors and styles in this scheme builder with ones specified in system properties, and returns this builder.
argGroups() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the argument groups in this command.
args() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the options and positional parameters in this group; may be empty but not null.
args() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the list of options and positional parameters that depend on this group.
args() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the list of all options and positional parameters configured for this command.
arity() - Method in class picocli.CommandLine.Model.ArgSpec
Returns how many arguments this option or positional parameter requires.
aritySatisfiedByAttachedOptionParam() - Method in class picocli.CommandLine.Model.ParserSpec
Returns true if options with attached arguments should not consume subsequent arguments and should not validate arity.
aritySatisfiedByAttachedOptionParam(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
Returns true if options with attached arguments should not consume subsequent arguments and should not validate arity.
asCommandLineList() - Method in class picocli.CommandLine.ParseResult
Returns this ParseResult as a list of CommandLine objects, one for each matched command/subcommand.
AT_FILE_POSITIONAL_PARAM - Variable in class picocli.CommandLine.Help
 
atFileCommentChar() - Method in class picocli.CommandLine.Model.ParserSpec
 
atFileCommentChar(Character) - Method in class picocli.CommandLine.Model.ParserSpec
 
atFileParameterList() - Method in class picocli.CommandLine.Help
Returns the section of the usage help message that lists the @-file and its description.
AutoComplete - Class in picocli
Stand-alone tool that generates bash auto-complete scripts for picocli-based command line applications.
AutoComplete.GenerateCompletion - Class in picocli
Command that generates a Bash/ZSH completion script for its top-level command.
autoWidth() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns whether picocli should attempt to detect the terminal size and adjust the usage help message width to take the full terminal width.
autoWidth(boolean) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets whether picocli should attempt to detect the terminal size and adjust the usage help message width to take the full terminal width.
auxiliaryTypes() - Method in class picocli.CommandLine.Model.ArgSpec
Returns auxiliary type information used when the CommandLine.Model.ArgSpec.type() is a generic type like Collection, Map or Optional; returns the concrete type when CommandLine.Model.ArgSpec.type() is an abstract class, otherwise, returns the same as CommandLine.Model.ArgSpec.type().

B

bash(String, File, File, CommandLine) - Static method in class picocli.AutoComplete
Generates source code for an autocompletion bash script for the specified picocli-based application, and writes this script to the specified out file, and optionally writes an invocation script to the specified command file.
bash(String, CommandLine) - Static method in class picocli.AutoComplete
Generates and returns the source code for an autocompletion bash script for the specified picocli-based application.
bg(String) - Static method in enum picocli.CommandLine.Help.Ansi.Style
Parses the specified style markup and returns the associated style.
build() - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Creates and returns a new ColorScheme with the values configured on this builder.
build() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns a valid ArgGroupSpec instance.
build() - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Returns a valid OptionSpec instance.
build() - Method in class picocli.CommandLine.Model.PositionalParamSpec.Builder
Returns a valid PositionalParamSpec instance.
build() - Method in class picocli.CommandLine.ParseResult.Builder
Creates and returns a new ParseResult instance for this builder's configuration.
build() - Method in class picocli.CommandLine.RegexTransformer.Builder
 
Builder() - Constructor for class picocli.CommandLine.Help.ColorScheme.Builder
Constructs an empty color scheme builder with Ansi.AUTO.
Builder(CommandLine.Help.Ansi) - Constructor for class picocli.CommandLine.Help.ColorScheme.Builder
Constructs an empty color scheme builder with the specified Ansi value.
Builder(CommandLine.Help.ColorScheme) - Constructor for class picocli.CommandLine.Help.ColorScheme.Builder
Constructs a color scheme builder with all attributes copied from the specified color scheme.
builder() - Static method in class picocli.CommandLine.Model.ArgGroupSpec
builder(CommandLine.Model.IAnnotatedElement) - Static method in class picocli.CommandLine.Model.ArgGroupSpec
Returns a new CommandLine.Model.ArgGroupSpec.Builder associated with the specified annotated element.
builder(String, String...) - Static method in class picocli.CommandLine.Model.OptionSpec
 
builder(String[]) - Static method in class picocli.CommandLine.Model.OptionSpec
 
builder(CommandLine.Model.IAnnotatedElement, CommandLine.IFactory) - Static method in class picocli.CommandLine.Model.OptionSpec
 
builder(CommandLine.Model.OptionSpec) - Static method in class picocli.CommandLine.Model.OptionSpec
Returns a Builder initialized from the specified OptionSpec.
builder() - Static method in class picocli.CommandLine.Model.PositionalParamSpec
 
builder(CommandLine.Model.PositionalParamSpec) - Static method in class picocli.CommandLine.Model.PositionalParamSpec
Returns a Builder initialized from the specified PositionalSpec.
builder(CommandLine.Model.IAnnotatedElement, CommandLine.IFactory) - Static method in class picocli.CommandLine.Model.PositionalParamSpec
 
builder(CommandLine.Model.CommandSpec) - Static method in class picocli.CommandLine.ParseResult
Creates and returns a new ParseResult.Builder for the specified command spec.
Builder() - Constructor for class picocli.CommandLine.RegexTransformer.Builder
Constructs an empty builder.
Builder(CommandLine.RegexTransformer) - Constructor for class picocli.CommandLine.RegexTransformer.Builder
Constructs a builder populated with the values from the specified RegexTransformer.

C

calcLongOptionColumnWidth(List<CommandLine.Model.OptionSpec>, List<CommandLine.Model.PositionalParamSpec>, CommandLine.Help.ColorScheme) - Method in class picocli.CommandLine.Help
Returns the width of the long options column in the usage help message.
call(C, String...) - Static method in class picocli.CommandLine
call(C, PrintStream, String...) - Static method in class picocli.CommandLine
call(C, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
call(C, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
call(Class<C>, CommandLine.IFactory, String...) - Static method in class picocli.CommandLine
call(Class<C>, CommandLine.IFactory, PrintStream, String...) - Static method in class picocli.CommandLine
call(Class<C>, CommandLine.IFactory, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
call(Class<C>, CommandLine.IFactory, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
caseInsensitiveEnumValuesAllowed() - Method in class picocli.CommandLine.Model.ParserSpec
 
caseInsensitiveEnumValuesAllowed(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
Cell(int, int) - Constructor for class picocli.CommandLine.Help.TextTable.Cell
Constructs a new Cell with the specified coordinates in the table.
cellAt(int, int) - Method in class picocli.CommandLine.Help.TextTable
clearExecutionResults() - Method in class picocli.CommandLine
Clears the execution result of a previous invocation from this CommandLine and all subcommands.
clone() - Method in class picocli.CommandLine.Help.Ansi.Text
 
collectErrors() - Method in class picocli.CommandLine.Model.ParserSpec
Returns true if exceptions during parsing should be collected instead of thrown.
collectErrors(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
Sets whether exceptions during parsing should be collected instead of thrown.
colorScheme() - Method in class picocli.CommandLine.AbstractHandler
Deprecated.
Returns the ColorScheme to use.
colorScheme() - Method in class picocli.CommandLine.Help
Returns the ColorScheme model that this Help was constructed with.
colorScheme - Variable in class picocli.CommandLine.Help.Layout
 
colorScheme() - Method in class picocli.CommandLine.Help.Layout
Returns the ColorScheme used to create Text objects in this layout.
Column(int, int, CommandLine.Help.Column.Overflow) - Constructor for class picocli.CommandLine.Help.Column
 
column - Variable in class picocli.CommandLine.Help.TextTable.Cell
Table column index (zero based).
columns() - Method in class picocli.CommandLine.Help.TextTable
The column definitions of this table.
columnValues - Variable in class picocli.CommandLine.Help.TextTable
The char[] slots of the TextTable to copy text values into.
command() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the command this option or positional parameter belongs to.
CommandLine - Class in picocli
CommandLine interpreter that uses reflection to initialize an annotated user object with values obtained from the command line arguments.
CommandLine(Object) - Constructor for class picocli.CommandLine
Constructs a new CommandLine interpreter with the specified object (which may be an annotated user object or a CommandSpec) and a default factory.
CommandLine(Object, CommandLine.IFactory) - Constructor for class picocli.CommandLine
Constructs a new CommandLine interpreter with the specified object (which may be an annotated user object or a CommandSpec) and object factory.
commandLine() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the CommandLine constructed with this CommandSpec model.
commandLine(CommandLine) - Method in class picocli.CommandLine.Model.CommandSpec
Sets the CommandLine constructed with this CommandSpec model.
commandLine - Variable in exception picocli.CommandLine.ParameterException
 
CommandLine.AbstractHandler<R,T extends CommandLine.AbstractHandler<R,T>> - Class in picocli
CommandLine.AbstractParseResultHandler<R> - Class in picocli
CommandLine.ArgGroup - Annotation Type in picocli
A Command may define one or more ArgGroups: a group of options, positional parameters or a mixture of the two.
CommandLine.Command - Annotation Type in picocli
Annotate your class with @Command when you want more control over the format of the generated help message.
CommandLine.DefaultExceptionHandler<R> - Class in picocli
CommandLine.DuplicateNameException - Exception in picocli
Exception indicating that multiple named elements have incorrectly used the same name.
CommandLine.DuplicateOptionAnnotationsException - Exception in picocli
Exception indicating that multiple fields have been annotated with the same Option name.
CommandLine.ExecutionException - Exception in picocli
Exception indicating a problem while invoking a command or subcommand.
CommandLine.ExitCode - Class in picocli
Defines some exit codes used by picocli as default return values from the execute and executeHelpRequest methods.
CommandLine.Help - Class in picocli
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.Ansi - Enum in picocli
Provides methods and inner classes to support using ANSI escape codes in usage help messages.
CommandLine.Help.Ansi.IStyle - Interface in picocli
Defines the interface for an ANSI escape sequence.
CommandLine.Help.Ansi.Style - Enum in picocli
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.Ansi.Text - Class in picocli
Encapsulates rich text with styles and colors.
CommandLine.Help.ColorScheme - Class in picocli
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.ColorScheme.Builder - Class in picocli
Builder class to create ColorScheme instances.
CommandLine.Help.Column - Class in picocli
Columns define the width, indent (leading number of spaces in a column before the value) and Overflow policy of a column in a TextTable.
CommandLine.Help.Column.Overflow - Enum in picocli
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.
CommandLine.Help.IOptionRenderer - Interface in picocli
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 - Interface in picocli
When customizing online help for positional 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 - Interface in picocli
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.Help.Layout - Class in picocli
Use a Layout to format usage help text for options and parameters in tabular format.
CommandLine.Help.TextTable - Class in picocli
Responsible for spacing out CommandLine.Help.Ansi.Text values according to the CommandLine.Help.Column definitions the table was created with.
CommandLine.Help.TextTable.Cell - Class in picocli
Helper class to index positions in a Help.TextTable.
CommandLine.Help.Visibility - Enum in picocli
Controls the visibility of certain aspects of the usage help message.
CommandLine.HelpCommand - Class in picocli
Help command that can be installed as a subcommand on all application commands.
CommandLine.IDefaultValueProvider - Interface in picocli
Provides default value for a command.
CommandLine.IExceptionHandler - Interface in picocli
CommandLine.IExceptionHandler2<R> - Interface in picocli
CommandLine.IExecutionExceptionHandler - Interface in picocli
Classes implementing this interface know how to handle Exceptions that occurred while executing the Runnable, Callable or Method user object of the command.
CommandLine.IExecutionStrategy - Interface in picocli
Implementations are responsible for "executing" the user input and returning an exit code.
CommandLine.IExitCodeExceptionMapper - Interface in picocli
Interface that provides the appropriate exit code that will be returned from the execute method for an exception that occurred during parsing or while invoking the command's Runnable, Callable, or Method.
CommandLine.IExitCodeGenerator - Interface in picocli
@Command-annotated classes can implement this interface to specify an exit code that will be returned from the execute method when the command is successfully invoked.
CommandLine.IFactory - Interface in picocli
Factory for instantiating classes that are registered declaratively with annotation attributes, like CommandLine.Command.subcommands(), CommandLine.Option.converter(), CommandLine.Parameters.converter() and CommandLine.Command.versionProvider().
CommandLine.IHelpCommandInitializable - Interface in picocli
CommandLine.IHelpCommandInitializable2 - Interface in picocli
Help commands that provide usage help for other commands can implement this interface to be initialized with the information they need.
CommandLine.IHelpFactory - Interface in picocli
Creates the CommandLine.Help instance used to render the usage help message.
CommandLine.IHelpSectionRenderer - Interface in picocli
Renders a section of the usage help message.
CommandLine.IModelTransformer - Interface in picocli
Provides a way to modify how the command model is built.
CommandLine.INegatableOptionTransformer - Interface in picocli
Determines the option name transformation of negatable boolean options.
CommandLine.InitializationException - Exception in picocli
Exception indicating a problem during CommandLine initialization.
CommandLine.IParameterConsumer - Interface in picocli
Options or positional parameters can be assigned a IParameterConsumer that implements custom logic to process the parameters for this option or this position.
CommandLine.IParameterExceptionHandler - Interface in picocli
Classes implementing this interface know how to handle ParameterExceptions (usually from invalid user input).
CommandLine.IParameterPreprocessor - Interface in picocli
Options, positional parameters and commands can be assigned a IParameterPreprocessor that implements custom logic to preprocess the parameters for this option, position or command.
CommandLine.IParseResultHandler - Interface in picocli
Deprecated.
CommandLine.IParseResultHandler2<R> - Interface in picocli
CommandLine.ITypeConverter<K> - Interface in picocli
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.
CommandLine.IVersionProvider - Interface in picocli
Provides version information for a command.
CommandLine.MaxValuesExceededException - Exception in picocli
Exception indicating that more values were specified for an option or parameter than its arity allows.
CommandLine.MissingParameterException - Exception in picocli
Exception indicating that a required parameter was not specified.
CommandLine.MissingTypeConverterException - Exception in picocli
Exception indicating that an annotated field had a type for which no CommandLine.ITypeConverter was registered.
CommandLine.Mixin - Annotation Type in picocli
Fields annotated with @Mixin are "expanded" into the current command: @Option and @Parameters in the mixin class are added to the options and positional parameters of this command.
CommandLine.Model - Class in picocli
This class provides a namespace for classes and interfaces that model concepts and attributes of command line interfaces in picocli.
CommandLine.Model.ArgGroupSpec - Class in picocli
The ArgGroupSpec class models a group of arguments (options, positional parameters or a mixture of the two).
CommandLine.Model.ArgGroupSpec.Builder - Class in picocli
Builder responsible for creating valid ArgGroupSpec objects.
CommandLine.Model.ArgSpec - Class in picocli
CommandLine.Model.CommandSpec - Class in picocli
The CommandSpec class models a command specification, including the options, positional parameters and subcommands supported by the command, as well as attributes for the version help message and the usage help message of the command.
CommandLine.Model.IAnnotatedElement - Interface in picocli
Internal interface to allow annotation processors to construct a command model at compile time.
CommandLine.Model.IExtensible - Interface in picocli
Interface to allow extending the capabilities of other interface without Java 8 default methods.
CommandLine.Model.IGetter - Interface in picocli
Customizable getter for obtaining the current value of an option or positional parameter.
CommandLine.Model.IOrdered - Interface in picocli
Interface for sorting options and groups together.
CommandLine.Model.IScope - Interface in picocli
The scope of a getter/setter binding is the context where the current value should be gotten from or set to.
CommandLine.Model.IScoped - Interface in picocli
This interface provides access to an CommandLine.Model.IScope instance.
CommandLine.Model.ISetter - Interface in picocli
Customizable setter for modifying the value of an option or positional parameter.
CommandLine.Model.ITypeInfo - Interface in picocli
Encapculates type information for an option or parameter to make this information available both at runtime and at compile time (when Class values are not available).
CommandLine.Model.Messages - Class in picocli
Utility class for getting resource bundle strings.
CommandLine.Model.MethodParam - Class in picocli
Command method parameter, similar to java.lang.reflect.Parameter (not available before Java 8).
CommandLine.Model.OptionSpec - Class in picocli
The OptionSpec class models aspects of a named option of a command, including whether it is required or optional, the option parameters supported (or required) by the option, and attributes for the usage help message describing the option.
CommandLine.Model.OptionSpec.Builder - Class in picocli
Builder responsible for creating valid OptionSpec objects.
CommandLine.Model.ParserSpec - Class in picocli
Models parser configuration specification.
CommandLine.Model.PositionalParamSpec - Class in picocli
The PositionalParamSpec class models aspects of a positional parameter of a command, including whether it is required or optional, and attributes for the usage help message describing the positional parameter.
CommandLine.Model.PositionalParamSpec.Builder - Class in picocli
Builder responsible for creating valid PositionalParamSpec objects.
CommandLine.Model.UnmatchedArgsBinding - Class in picocli
This class allows applications to specify a custom binding that will be invoked for unmatched arguments.
CommandLine.Model.UsageMessageSpec - Class in picocli
Models the usage help message specification and can be used to customize the usage help message.
CommandLine.MutuallyExclusiveArgsException - Exception in picocli
Exception indicating that the user input included multiple arguments from a mutually exclusive group.
CommandLine.Option - Annotation Type in picocli
Annotate fields in your class with @Option and picocli will initialize these fields when matching arguments are specified on the command line.
CommandLine.OverwrittenOptionException - Exception in picocli
Exception indicating that an option for a single-value option field has been specified multiple times on the command line.
CommandLine.ParameterException - Exception in picocli
Exception indicating something went wrong while parsing command line options.
CommandLine.ParameterIndexGapException - Exception in picocli
Exception indicating that there was a gap in the indices of the fields annotated with CommandLine.Parameters.
CommandLine.Parameters - Annotation Type in picocli
Fields annotated with @Parameters will be initialized with positional parameters.
CommandLine.ParentCommand - Annotation Type in picocli
Fields annotated with @ParentCommand will be initialized with the parent command of the current subcommand.
CommandLine.ParseResult - Class in picocli
Encapsulates the result of parsing an array of command line arguments.
CommandLine.ParseResult.Builder - Class in picocli
Builds immutable ParseResult instances.
CommandLine.ParseResult.GroupMatch - Class in picocli
A group's multiplicity specifies how many matches of a group may appear on the command line.
CommandLine.ParseResult.GroupMatchContainer - Class in picocli
Provides information about an CommandLine.ArgGroup that was matched on the command line.
CommandLine.PicocliException - Exception in picocli
Base class of all exceptions thrown by picocli.CommandLine.
CommandLine.PropertiesDefaultProvider - Class in picocli
IDefaultValueProvider implementation that loads default values for command line options and positional parameters from a properties file or Properties object.
CommandLine.Range - Class in picocli
Describes the number of parameters required and accepted by an option or a positional parameter.
CommandLine.RegexTransformer - Class in picocli
A regular expression-based option name transformation for negatable options.
CommandLine.RegexTransformer.Builder - Class in picocli
Builder for creating RegexTransformer objects.
CommandLine.RunAll - Class in picocli
Command line execution strategy that prints help if requested, and otherwise executes the top-level command and all subcommands as Runnable, Callable or Method.
CommandLine.RunFirst - Class in picocli
Command line execution strategy that prints help if requested, and otherwise executes the top-level Runnable or Callable command.
CommandLine.RunLast - Class in picocli
Command line execution strategy that prints help if requested, and otherwise executes the most specific Runnable or Callable subcommand.
CommandLine.ScopeType - Enum in picocli
Specifies the scope of the element.
CommandLine.Spec - Annotation Type in picocli
Fields annotated with @Spec will be initialized with the CommandSpec for the command the field is part of.
CommandLine.Spec.Target - Enum in picocli
Identifies what kind of CommandSpec should be injected.
CommandLine.TraceLevel - Enum in picocli
Enumerates over the trace level values for filtering which internal debug statements should be printed.
CommandLine.Tracer - Class in picocli
Utility class for printing internal debug statements.
CommandLine.TypeConversionException - Exception in picocli
Exception thrown by CommandLine.ITypeConverter implementations to indicate a String could not be converted.
CommandLine.Unmatched - Annotation Type in picocli
Fields annotated with @Unmatched will be initialized with the list of unmatched command line arguments, if any.
CommandLine.UnmatchedArgumentException - Exception in picocli
Exception indicating that a command line argument could not be mapped to any of the fields annotated with CommandLine.Option or CommandLine.Parameters.
CommandLine.UseDefaultConverter - Class in picocli
Converter that can be used to signal to picocli that it should use the default converter.
commandList() - Method in class picocli.CommandLine.Help
Returns a 2-column list with the command names and first line of their header or (if absent) description of the commands returned by CommandLine.Help.subcommands().
commandList(Map<String, CommandLine.Help>) - Method in class picocli.CommandLine.Help
Returns a 2-column list with the command names and first line of their header or (if absent) description of the specified command map.
commandListHeading(Object...) - Method in class picocli.CommandLine.Help
Returns the text displayed before the command list; an empty string if there are no commands, otherwise the result of String.format(commandListHeading, params).
commandListHeading() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional heading preceding the subcommand list.
commandListHeading(String) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the optional heading preceding the subcommand list.
commandNamesText(String) - Method in class picocli.CommandLine.Help
Returns a Text object containing the command name and all aliases, separated with the specified separator.
commands(CommandLine.Help.Ansi.IStyle...) - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Adds the specified styles to the registered styles for commands in this color scheme builder and returns this builder.
commandSpec() - Method in class picocli.CommandLine.Help
Returns the CommandSpec model that this Help was constructed with.
commandSpec() - Method in class picocli.CommandLine.Model.Messages
Returns the CommandSpec of this object, never null.
commandSpec() - Method in class picocli.CommandLine.ParseResult
Returns the CommandSpec for the matched command.
commandStyles() - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Returns the registered styles for commands in this color scheme builder.
commandStyles() - Method in class picocli.CommandLine.Help.ColorScheme
Returns the registered styles for commands in this color scheme.
commandText(String) - Method in class picocli.CommandLine.Help.ColorScheme
Returns a Text with all command styles applied to the specified command string.
compareTo(CommandLine.Range) - Method in class picocli.CommandLine.Range
 
complete(CommandLine.Model.CommandSpec, String[], int, int, int, List<CharSequence>) - Static method in class picocli.AutoComplete
 
completionCandidates() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the explicitly set completion candidates for this option or positional parameter, valid enum constant names, or null if this option or positional parameter does not have any completion candidates and its type is not an enum.
concat(String) - Method in class picocli.CommandLine.Help.Ansi.Text
Returns a copy of this Text instance with the specified text concatenated to the end.
concat(CommandLine.Help.Ansi.Text) - Method in class picocli.CommandLine.Help.Ansi.Text
Returns a copy of this Text instance with the specified text concatenated to the end.
consumeParameters(Stack<String>, CommandLine.Model.ArgSpec, CommandLine.Model.CommandSpec) - Method in interface picocli.CommandLine.IParameterConsumer
Consumes as many of the specified command line arguments as needed by popping them off the specified Stack.
container() - Method in class picocli.CommandLine.ParseResult.GroupMatch
Returns the container GroupMatchContainer of this match.
contains(int) - Method in class picocli.CommandLine.Range
Returns true if this Range includes the specified value, false otherwise.
convert(String) - Method in interface picocli.CommandLine.ITypeConverter
Converts the specified command line argument value to some domain object.
convert(String) - Method in class picocli.CommandLine.UseDefaultConverter
Always throws UnsupportedOperationException.
converters() - Method in class picocli.CommandLine.Model.ArgSpec
Returns one or more type converters to use to convert the command line argument into a strongly typed value (or key-value pair for map fields).
copy(CommandLine.Model.CommandSpec, CommandLine.Model.Messages) - Static method in class picocli.CommandLine.Model.Messages
Returns a copy of the specified Messages object with the CommandSpec replaced by the specified one.
create(Class<K>) - Method in interface picocli.CommandLine.IFactory
Returns an instance of the specified class.
create(CommandLine.Model.CommandSpec, CommandLine.Help.ColorScheme) - Method in interface picocli.CommandLine.IHelpFactory
Returns a Help instance to assist in rendering the usage help message
create() - Static method in class picocli.CommandLine.Model.CommandSpec
Creates and returns a new CommandSpec without any associated user object.
createCaseInsensitive() - Static method in class picocli.CommandLine.RegexTransformer
Returns the RegexTransformer for case-insensitive negatable options.
createDefault() - Static method in class picocli.CommandLine.RegexTransformer
Returns the RegexTransformer used by default for negatable options.
createDefaultLayout() - Method in class picocli.CommandLine.Help
Returns a Layout instance configured with the user preferences captured in this Help instance.
createDefaultLayout(List<CommandLine.Model.OptionSpec>, List<CommandLine.Model.PositionalParamSpec>, CommandLine.Help.ColorScheme) - Method in class picocli.CommandLine.Help
Returns a Layout instance configured with the user preferences captured in this Help instance.
createDefaultOptionRenderer() - Method in class picocli.CommandLine.Help
Returns a new default OptionRenderer which converts Options to five columns of text to match the default TextTable column layout.
createDefaultOptionSort() - Method in class picocli.CommandLine.Help
Returns a comparator for sorting options, or null, depending on the settings for this command.
createDefaultParameterRenderer() - Method in class picocli.CommandLine.Help
Returns a new default ParameterRenderer which converts positional parameters to four columns of text to match the default TextTable column layout.
createDefaultParamLabelRenderer() - Method in class picocli.CommandLine.Help
Returns a new default param label renderer that separates option parameters from their option name with the specified separator string, and, unless CommandLine.Model.ArgSpec.hideParamSyntax() is true, surrounds optional parameters with '[' and ']' characters and uses ellipses ("...") to indicate that any number of a parameter are allowed.
createDetailedSynopsisCommandText() - Method in class picocli.CommandLine.Help
Returns a Text object containing a partial detailed synopsis showing only the subcommands, starting with a " " space.
createDetailedSynopsisEndOfOptionsText() - Method in class picocli.CommandLine.Help
Returns a Text object containing a partial detailed synopsis showing only the end of options delimiter (if enabled), starting with a " " space.
createDetailedSynopsisGroupsText(Set<CommandLine.Model.ArgSpec>) - Method in class picocli.CommandLine.Help
Returns a Text object containing a partial detailed synopsis showing only the options and positional parameters in the specified validating groups, starting with a " " space.
createDetailedSynopsisOptionsText(Collection<CommandLine.Model.ArgSpec>, Comparator<CommandLine.Model.OptionSpec>, boolean) - Method in class picocli.CommandLine.Help
Returns a Text object containing a partial detailed synopsis showing only the options, starting with a " " space.
createDetailedSynopsisOptionsText(Collection<CommandLine.Model.ArgSpec>, List<CommandLine.Model.OptionSpec>, Comparator<CommandLine.Model.OptionSpec>, boolean) - Method in class picocli.CommandLine.Help
Returns a Text object containing a partial detailed synopsis showing only the specified options, starting with a " " space.
createDetailedSynopsisPositionalsText(Collection<CommandLine.Model.ArgSpec>) - Method in class picocli.CommandLine.Help
Returns a Text object containing a partial detailed synopsis showing only the positional parameters, starting with a " " space.
createHeading(String, Object...) - Method in class picocli.CommandLine.Help
Returns a String that can be used as a help section heading.
createLabelRenderer(CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
createMinimalOptionRenderer() - Static method in class picocli.CommandLine.Help
Returns a new minimal OptionRenderer which converts Options to a single row with two columns of text: an option name and a description.
createMinimalParameterRenderer() - Static method in class picocli.CommandLine.Help
Returns a new minimal ParameterRenderer which converts positional parameters to a single row with two columns of text: an option name and a description.
createMinimalParamLabelRenderer() - Static method in class picocli.CommandLine.Help
Returns a value renderer that returns the paramLabel if defined or the field name otherwise.
createShortOptionArityAndNameComparator() - Static method in class picocli.CommandLine.Help
Sorts OptionSpecs by their option max arity first, by min arity next, and by option name last.
createShortOptionNameComparator() - Static method in class picocli.CommandLine.Help
Sorts OptionSpecs by their option name in case-insensitive alphabetic order.
createTextTable(Map<?, ?>) - Method in class picocli.CommandLine.Help
Returns a 2-column TextTable containing data from the specified map: the keys are put in the left column and the map values are in the right column.
CSI - Static variable in interface picocli.CommandLine.Help.Ansi.IStyle
The Control Sequence Introducer (CSI) escape sequence "\u001b[".
customMarkupMap() - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Returns the custom mapping from markup names (the names of the CommandLine.Help.Ansi.Style enum constants, like bold, italic, fg_blue, bg_green, etc) to CommandLine.Help.Ansi.IStyle objects in this color scheme.
customMarkupMap(Map<String, CommandLine.Help.Ansi.IStyle>) - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Sets the custom mapping from markup names (the names of the CommandLine.Help.Ansi.Style enum constants, like bold, italic, fg_blue, bg_green, etc) to CommandLine.Help.Ansi.IStyle objects in this color scheme.
customMarkupMap() - Method in class picocli.CommandLine.Help.ColorScheme
Returns the custom mapping from markup names (the names of the CommandLine.Help.Ansi.Style enum constants, like bold, italic, fg_blue, bg_green, etc) to CommandLine.Help.Ansi.IStyle objects in this color scheme.
customSynopsis(Object...) - Method in class picocli.CommandLine.Help
Returns command custom synopsis as a string.
customSynopsis() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional custom synopsis lines to use instead of the auto-generated synopsis.
customSynopsis(String...) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the optional custom synopsis lines to use instead of the auto-generated synopsis.

D

debug(String, Object...) - Method in class picocli.CommandLine.Tracer
Prints the specified message if the current trace level is DEBUG or higher.
DEFAULT_COMMAND_NAME - Static variable in class picocli.CommandLine.Help
Constant String holding the default program name, value defined in CommandLine.Model.CommandSpec.DEFAULT_COMMAND_NAME.
DEFAULT_COMMAND_NAME - Static variable in class picocli.CommandLine.Model.CommandSpec
Constant String holding the default program name: "<main class>" .
DEFAULT_FALLBACK_VALUE - Static variable in class picocli.CommandLine.Model.OptionSpec
 
DEFAULT_SEPARATOR - Static variable in class picocli.CommandLine.Help
Constant String holding the default string that separates options from option parameters, value defined in CommandLine.Model.ParserSpec.DEFAULT_SEPARATOR.
DEFAULT_USAGE_WIDTH - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Constant holding the default usage message width: 80.
defaultArity(Field) - Static method in class picocli.CommandLine.Range
Returns the default arity Range: for interactive options/positional parameters, this is 0; for options this is effectively "0..1" for booleans and 1 for other types, for parameters booleans have arity 1, arrays or Collections have arity "0..*", and other types have arity 1.
defaultArity(Class<?>) - Static method in class picocli.CommandLine.Range
Deprecated.
defaultColorScheme(CommandLine.Help.Ansi) - Static method in class picocli.CommandLine.Help
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.
defaultExceptionHandler() - Static method in class picocli.CommandLine
Convenience method that returns new DefaultExceptionHandler<List<Object>>().
DefaultExceptionHandler() - Constructor for class picocli.CommandLine.DefaultExceptionHandler
Deprecated.
 
defaultFactory() - Static method in class picocli.CommandLine
Returns the default CommandLine.IFactory implementation used if no factory was specified in the CommandLine constructor.
defaultValue(CommandLine.Model.ArgSpec) - Method in interface picocli.CommandLine.IDefaultValueProvider
Returns the default value for an option or positional parameter or null.
defaultValue() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the default value to assign if this option or positional parameter was not specified on the command line, before splitting and type conversion.
defaultValue(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.PropertiesDefaultProvider
 
defaultValueProvider() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the default value provider for this command.
defaultValueProvider(CommandLine.IDefaultValueProvider) - Method in class picocli.CommandLine.Model.CommandSpec
Sets default value provider for this command.
defaultValueString() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the default value String for the purpose of displaying it in the description, without interpolating variables.
defaultValueString(boolean) - Method in class picocli.CommandLine.Model.ArgSpec
Returns the default value String displayed in the description; interpolating variables if specified.
description(Object...) - Method in class picocli.CommandLine.Help
Returns command description text as a string.
description() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the description of this option or positional parameter, after all variables have been rendered, including the ${DEFAULT-VALUE} and ${COMPLETION-CANDIDATES} variables.
description() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional text lines to use as the description of the help message, displayed between the synopsis and the options list.
description(String...) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the optional text lines to use as the description of the help message, displayed between the synopsis and the options list.
descriptionHeading(Object...) - Method in class picocli.CommandLine.Help
Returns the text displayed before the description text; an empty string if there is no description, otherwise the result of String.format(descriptionHeading, params).
descriptionHeading() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional heading preceding the description section.
descriptionHeading(String) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the heading preceding the description section.
descriptionKey() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the description key of this arg spec, used to get the description from a resource bundle.
detailedSynopsis(Comparator<CommandLine.Model.OptionSpec>, boolean) - Method in class picocli.CommandLine.Help
detailedSynopsis(int, Comparator<CommandLine.Model.OptionSpec>, boolean) - Method in class picocli.CommandLine.Help
Generates a detailed synopsis message showing all options and parameters.
DuplicateNameException(String) - Constructor for exception picocli.CommandLine.DuplicateNameException
 
DuplicateOptionAnnotationsException(String) - Constructor for exception picocli.CommandLine.DuplicateOptionAnnotationsException
 

E

echo() - Method in class picocli.CommandLine.Model.ArgSpec
Returns whether the user input is echoed to the console or not for an interactive option or positional parameter when asking for user input.
empty(CommandLine.Model.Messages) - Static method in class picocli.CommandLine.Model.Messages
Returns true if the specified Messages is null, has a null ResourceBundle, or has a null parent Messages.
enabled() - Method in enum picocli.CommandLine.Help.Ansi
Returns true if ANSI escape codes should be emitted, false otherwise.
END_OF_OPTIONS_OPTION - Variable in class picocli.CommandLine.Help
 
endOfOptionsDelimiter() - Method in class picocli.CommandLine.Model.ParserSpec
 
endOfOptionsDelimiter(String) - Method in class picocli.CommandLine.Model.ParserSpec
 
endOfOptionsList() - Method in class picocli.CommandLine.Help
Returns the section of the usage help message that lists the -- End of Options delimiter and its description.
equals(Object) - Method in class picocli.CommandLine.Help.Ansi.Text
 
equals(Object) - Method in class picocli.CommandLine.Help.ColorScheme
 
equals(Object) - Method in class picocli.CommandLine.Help.Column
 
equals(Object) - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
equals(Object) - Method in class picocli.CommandLine.Model.OptionSpec
 
equals(Object) - Method in class picocli.CommandLine.Model.PositionalParamSpec
 
equals(Object) - Method in class picocli.CommandLine.Range
 
equalsImpl(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.Model.ArgSpec
 
err() - Method in class picocli.CommandLine.AbstractHandler
Deprecated.
Returns the stream to print diagnostic messages to.
errors(CommandLine.Help.Ansi.IStyle...) - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Adds the specified styles to the registered styles for errors in this color scheme builder and returns this builder.
errors() - Method in class picocli.CommandLine.ParseResult
If CommandLine.Model.ParserSpec.collectErrors is true, returns the list of exceptions that were encountered during parsing, otherwise, returns an empty list.
errorStyles() - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Returns the registered styles for errors in this color scheme builder.
errorStyles() - Method in class picocli.CommandLine.Help.ColorScheme
Returns the registered styles for errors in this color scheme.
errorText(String) - Method in class picocli.CommandLine.Help.ColorScheme
Returns a Text with all error styles applied to the specified error string.
exclusive() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns whether this is a mutually exclusive group; true by default.
exclusive(boolean) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets whether this is a mutually exclusive group; true by default.
exclusive() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns whether this is a mutually exclusive group; true by default.
execute(CommandLine.ParseResult) - Method in class picocli.CommandLine.AbstractParseResultHandler
Deprecated.
 
execute(String...) - Method in class picocli.CommandLine
Convenience method to allow command line application authors to avoid some boilerplate code in their application.
execute(CommandLine.ParseResult) - Method in interface picocli.CommandLine.IExecutionStrategy
"Executes" the user input and returns an exit code.
execute(CommandLine.ParseResult) - Method in class picocli.CommandLine.RunAll
"Executes" the user input and returns an exit code.
execute(CommandLine.ParseResult) - Method in class picocli.CommandLine.RunFirst
"Executes" the user input and returns an exit code.
execute(CommandLine.ParseResult) - Method in class picocli.CommandLine.RunLast
"Executes" the user input and returns an exit code.
executeHelpRequest(CommandLine.ParseResult) - Static method in class picocli.CommandLine
Helper method that may be useful when processing the ParseResult that results from successfully parsing command line arguments.
ExecutionException(CommandLine, String) - Constructor for exception picocli.CommandLine.ExecutionException
 
ExecutionException(CommandLine, String, Throwable) - Constructor for exception picocli.CommandLine.ExecutionException
 
exit(int) - Method in class picocli.CommandLine.AbstractHandler
Deprecated.
Calls System.exit(int) with the specified exit code.
EXIT_CODE_COMMAND_SCRIPT_EXISTS - Static variable in class picocli.AutoComplete
Exit code of this application when the specified command script exists (2).
EXIT_CODE_COMPLETION_SCRIPT_EXISTS - Static variable in class picocli.AutoComplete
Exit code of this application when the specified completion script exists (3).
EXIT_CODE_EXECUTION_ERROR - Static variable in class picocli.AutoComplete
Exit code of this application when an exception was encountered during operation (4).
EXIT_CODE_INVALID_INPUT - Static variable in class picocli.AutoComplete
Exit code of this application when the specified command line arguments are invalid (1).
EXIT_CODE_SUCCESS - Static variable in class picocli.AutoComplete
Normal exit code of this application (0).
exitCode() - Method in class picocli.CommandLine.AbstractHandler
Deprecated.
Returns the exit code to use as the termination status, or null (the default) if the handler should not call System.exit(int) after processing completes.
exitCodeList() - Method in class picocli.CommandLine.Help
Returns a 2-column list with exit codes and their description.
exitCodeList() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns an unmodifiable map with values to be displayed in the exit codes section: keys are exit codes, values are descriptions.
exitCodeList(Map<String, String>) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the values to be displayed in the exit codes section: keys are exit codes, values are descriptions.
exitCodeListHeading(Object...) - Method in class picocli.CommandLine.Help
Returns the text displayed before the exit code list text; the result of String.format(exitCodeHeading, params).
exitCodeListHeading() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional heading preceding the exit codes section, may contain "%n" line separators.
exitCodeListHeading(String) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the optional heading preceding the exit codes section, may contain "%n" line separators.
exitCodeOnExecutionException() - Method in class picocli.CommandLine.Model.CommandSpec
Returns exit code signifying that an exception occurred when invoking the Runnable, Callable or Method user object of a command.
exitCodeOnExecutionException(int) - Method in class picocli.CommandLine.Model.CommandSpec
Sets exit code signifying that an exception occurred when invoking the Runnable, Callable or Method user object of a command.
exitCodeOnInvalidInput() - Method in class picocli.CommandLine.Model.CommandSpec
Returns exit code for command line usage error.
exitCodeOnInvalidInput(int) - Method in class picocli.CommandLine.Model.CommandSpec
Sets exit code for command line usage error.
exitCodeOnSuccess() - Method in class picocli.CommandLine.Model.CommandSpec
Returns exit code for successful termination.
exitCodeOnSuccess(int) - Method in class picocli.CommandLine.Model.CommandSpec
Sets exit code for successful termination.
exitCodeOnUsageHelp() - Method in class picocli.CommandLine.Model.CommandSpec
Returns exit code for successful termination after printing usage help on user request.
exitCodeOnUsageHelp(int) - Method in class picocli.CommandLine.Model.CommandSpec
Sets exit code for successful termination after printing usage help on user request.
exitCodeOnVersionHelp() - Method in class picocli.CommandLine.Model.CommandSpec
Returns exit code for successful termination after printing version help on user request.
exitCodeOnVersionHelp(int) - Method in class picocli.CommandLine.Model.CommandSpec
Sets exit code for successful termination after printing version help on user request.
expandAtFiles() - Method in class picocli.CommandLine.Model.ParserSpec
 
expandAtFiles(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
expandedArgs(Collection<String>) - Method in class picocli.CommandLine.ParseResult.Builder
Sets the specified command line arguments after @-files were expanded; these are the arguments that were actually parsed.
expandedArgs() - Method in class picocli.CommandLine.ParseResult
Returns the command line arguments after @-files were expanded; these are the arguments that were actually parsed.
extractExitCodeGenerators(CommandLine.ParseResult) - Method in class picocli.CommandLine.AbstractParseResultHandler
Deprecated.
 
extractExitCodeGenerators(CommandLine.ParseResult) - Method in class picocli.CommandLine.RunAll
 
extractExitCodeGenerators(CommandLine.ParseResult) - Method in class picocli.CommandLine.RunFirst
 
extractExitCodeGenerators(CommandLine.ParseResult) - Method in class picocli.CommandLine.RunLast
 

F

fallbackValue() - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Returns the fallback value for this option: the value that is assigned for options with an optional parameter if the option was specified on the command line without parameter.
fallbackValue(String) - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Sets the fallback value for this option: the value that is assigned for options with an optional parameter if the option was specified on the command line without parameter, and returns this builder.
fallbackValue() - Method in class picocli.CommandLine.Model.OptionSpec
Returns the fallback value for this option: the value that is assigned for options with an optional parameter (for example, arity = "0..1") if the option was specified on the command line without parameter.
fg(String) - Static method in enum picocli.CommandLine.Help.Ansi.Style
Parses the specified style markup and returns the associated style.
findMatches(CommandLine.Model.ArgGroupSpec) - Method in class picocli.CommandLine.ParseResult
Returns the matches for the specified argument group.
findOption(char) - Method in class picocli.CommandLine.Model.CommandSpec
Returns the option with the specified short name, or null if no option with that name is defined for this command.
findOption(String) - Method in class picocli.CommandLine.Model.CommandSpec
Returns the option with the specified name, or null if no option with that name is defined for this command.
footer(Object...) - Method in class picocli.CommandLine.Help
Returns command footer text as a string.
footer() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional footer text lines displayed at the bottom of the help message.
footer(String...) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the optional footer text lines displayed at the bottom of the help message.
footerHeading(Object...) - Method in class picocli.CommandLine.Help
Returns the text displayed before the footer text; the result of String.format(footerHeading, params).
footerHeading() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional heading preceding the footer section.
footerHeading(String) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the optional heading preceding the footer section.
forAnnotatedObject(Object) - Static method in class picocli.CommandLine.Model.CommandSpec
Creates and returns a new CommandSpec initialized from the specified associated user object.
forAnnotatedObject(Object, CommandLine.IFactory) - Static method in class picocli.CommandLine.Model.CommandSpec
Creates and returns a new CommandSpec initialized from the specified associated user object.
forAnnotatedObjectLenient(Object) - Static method in class picocli.CommandLine.Model.CommandSpec
Creates and returns a new CommandSpec initialized from the specified associated user object.
forAnnotatedObjectLenient(Object, CommandLine.IFactory) - Static method in class picocli.CommandLine.Model.CommandSpec
Creates and returns a new CommandSpec initialized from the specified associated user object.
forColumns(CommandLine.Help.Ansi, CommandLine.Help.Column...) - Static method in class picocli.CommandLine.Help.TextTable
forColumns(CommandLine.Help.ColorScheme, CommandLine.Help.Column...) - Static method in class picocli.CommandLine.Help.TextTable
Constructs a TextTable with the specified columns.
forColumnWidths(CommandLine.Help.Ansi, int...) - Static method in class picocli.CommandLine.Help.TextTable
forColumnWidths(CommandLine.Help.ColorScheme, int...) - Static method in class picocli.CommandLine.Help.TextTable
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.
forDefaultColumns(CommandLine.Help.Ansi, int) - Static method in class picocli.CommandLine.Help.TextTable
forDefaultColumns(CommandLine.Help.Ansi, int, int) - Static method in class picocli.CommandLine.Help.TextTable
forDefaultColumns(CommandLine.Help.ColorScheme, int, int) - Static method in class picocli.CommandLine.Help.TextTable
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)
forStringArrayConsumer(CommandLine.Model.ISetter) - Static method in class picocli.CommandLine.Model.UnmatchedArgsBinding
Creates a UnmatchedArgsBinding for a setter that consumes String[] objects.
forStringCollectionSupplier(CommandLine.Model.IGetter) - Static method in class picocli.CommandLine.Model.UnmatchedArgsBinding
Creates a UnmatchedArgsBinding for a getter that produces a Collection<String> that the unmatched arguments can be added to.
fullSynopsis() - Method in class picocli.CommandLine.Help
Returns the full usage synopsis of this command.

G

GenerateCompletion() - Constructor for class picocli.AutoComplete.GenerateCompletion
 
get() - Method in interface picocli.CommandLine.Model.IGetter
Returns the current value of the binding.
getActualGenericTypeArguments() - Method in interface picocli.CommandLine.Model.ITypeInfo
Returns the names of the type arguments if this is a generic type.
getAdditionalDescriptionKeys() - Method in class picocli.CommandLine.Model.ArgSpec
Subclasses should override to return a collection of additional description keys that may be used to find description text for this option or positional parameter in the resource bundle.
getAdditionalDescriptionKeys() - Method in class picocli.CommandLine.Model.OptionSpec
Returns the additional lookup keys for finding description lines in the resource bundle for this option.
getAdditionalDescriptionKeys() - Method in class picocli.CommandLine.Model.PositionalParamSpec
Returns the additional lookup keys for finding description lines in the resource bundle for this positional parameter.
getAnnotation(Class<T>) - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
getAnnotation(Class<T>) - Method in class picocli.CommandLine.Model.MethodParam
 
getArgSpec() - Method in exception picocli.CommandLine.ParameterException
Returns the ArgSpec object for the (sub)command whose input could not be parsed.
getAtFileCommentChar() - Method in class picocli.CommandLine
Returns the character that starts a single-line comment or null if all content of argument files should be interpreted as arguments (without comments).
getAuxiliaryTypeInfos() - Method in interface picocli.CommandLine.Model.ITypeInfo
Returns type information of components or elements of a multivalue type.
getAuxiliaryTypes() - Method in interface picocli.CommandLine.Model.ITypeInfo
Returns the component class of an array, or the parameter type of a generic Collection, or the parameter types of the key and the value of a generic Map.
getCJKAdjustedLength() - Method in class picocli.CommandLine.Help.Ansi.Text
Returns the number of columns this Text will occupy on the console, adjusted for wide CJK characters.
getCJKAdjustedLength(int, int) - Method in class picocli.CommandLine.Help.Ansi.Text
Returns the number of columns that the specified portion of this Text will occupy on the console, adjusted for wide CJK characters.
getClassName() - Method in interface picocli.CommandLine.Model.ITypeInfo
 
getClassSimpleName() - Method in interface picocli.CommandLine.Model.ITypeInfo
 
getColorScheme() - Method in class picocli.CommandLine
Returns the color scheme to use when printing help.
getCommand() - Method in class picocli.CommandLine
Returns the annotated user object that this CommandLine instance was constructed with.
getCommandLine() - Method in exception picocli.CommandLine.ExecutionException
Returns the CommandLine object for the (sub)command that could not be invoked.
getCommandLine() - Method in exception picocli.CommandLine.ParameterException
Returns the CommandLine object for the (sub)command whose input could not be parsed.
getCommandMethods(Class<?>, String) - Static method in class picocli.CommandLine
Helper to get methods of a class annotated with @Command via reflection, optionally filtered by method name (not @Command.name).
getCommandName() - Method in class picocli.CommandLine
Returns the command name (also called program name) displayed in the usage help synopsis.
getCommandSpec() - Method in class picocli.CommandLine
Returns the CommandSpec model that this CommandLine was constructed with.
getDeclaredAnnotations() - Method in class picocli.CommandLine.Model.MethodParam
 
getDeclaringExecutable() - Method in class picocli.CommandLine.Model.MethodParam
 
getDefaultValueProvider() - Method in class picocli.CommandLine
Returns the default value provider for the command, or null if none has been set.
getEndOfOptionsDelimiter() - Method in class picocli.CommandLine
Returns the end-of-options delimiter that signals that the remaining command line arguments should be treated as positional parameters.
getEnumConstantNames() - Method in interface picocli.CommandLine.Model.ITypeInfo
 
getErr() - Method in class picocli.CommandLine
Returns the writer to use when printing diagnostic (error) messages during command execution.
getExecutionExceptionHandler() - Method in class picocli.CommandLine
Returns the handler for dealing with exceptions that occurred in the Callable, Runnable or Method user object of a command when the command was executed.
getExecutionResult() - Method in class picocli.CommandLine
Returns the result of calling the user object Callable or invoking the user object Method after parsing the user input, or null if this command has not been executed or if this CommandLine is for a subcommand that was not specified by the end user on the command line.
getExecutionStrategy() - Method in class picocli.CommandLine
Returns the execution strategy used by the execute method to invoke the business logic on the user objects of this command and/or the user-specified subcommand(s).
getExitCode(Throwable) - Method in interface picocli.CommandLine.IExitCodeExceptionMapper
Returns the exit code that should be returned from the execute method.
getExitCode() - Method in interface picocli.CommandLine.IExitCodeGenerator
Returns the exit code that should be returned from the execute method.
getExitCodeExceptionMapper() - Method in class picocli.CommandLine
Returns the mapper that was set by the application to map from exceptions to exit codes, for use by the execute method.
getExtension(Class<T>) - Method in interface picocli.CommandLine.Model.IExtensible
Returns an instance of the specified class, or null if this extension is not supported.
getFactory() - Method in class picocli.CommandLine
Returns the factory that this CommandLine was constructed with.
getGroupMatches() - Method in class picocli.CommandLine.ParseResult
Returns the top-level container for the ArgGroupSpec match or matches found.
getHelp() - Method in class picocli.CommandLine
Returns a new Help object created by the IHelpFactory with the CommandSpec and ColorScheme of this command.
getHelpFactory() - Method in class picocli.CommandLine
Returns the IHelpFactory that is used to construct the usage help message.
getHelpSectionKeys() - Method in class picocli.CommandLine
Returns the section keys in the order that the usage help message should render the sections.
getHelpSectionMap() - Method in class picocli.CommandLine
Returns the map of section keys and renderers used to construct the usage help message.
getLevel() - Method in class picocli.CommandLine.Tracer
Returns the trace level that needs to be matched or exceeded for internal tracing statements to be printed.
getMethodParamPosition() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
getMissing() - Method in exception picocli.CommandLine.MissingParameterException
 
getMixinName() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
getMixins() - Method in class picocli.CommandLine
Returns a map of user objects whose options and positional parameters were added to ("mixed in" with) this command.
getName() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
getName() - Method in class picocli.CommandLine.Model.MethodParam
 
getNegatableOptionTransformer() - Method in class picocli.CommandLine
Returns the INegatableOptionTransformer used to create the negative form of negatable options.
getOut() - Method in class picocli.CommandLine
Returns the writer used when printing user-requested usage help or version help during command execution.
getOverwritten() - Method in exception picocli.CommandLine.OverwrittenOptionException
Returns the CommandLine.Model.ArgSpec for the option which was being overwritten.
getParameterExceptionHandler() - Method in class picocli.CommandLine
Returns the handler for dealing with invalid user input when the command is executed.
getParameterizedType() - Method in class picocli.CommandLine.Model.MethodParam
 
getParent() - Method in class picocli.CommandLine
Returns the command that this is a subcommand of, or null if this is a top-level command.
getParseResult() - Method in class picocli.CommandLine
 
getResourceBundle() - Method in class picocli.CommandLine
Returns the ResourceBundle of this command or null if no resource bundle is set.
getScope() - Method in interface picocli.CommandLine.Model.IScoped
Get the CommandLine.Model.IScope instance.
getSeparator() - Method in class picocli.CommandLine
Returns the String that separates option names from option values when parsing command line options.
getString(String, String) - Method in class picocli.CommandLine.Model.Messages
Returns the String value found in the resource bundle for the specified key, or the specified default value if not found.
getStringArray(String, String[]) - Method in class picocli.CommandLine.Model.Messages
Returns the String array value found in the resource bundle for the specified key, or the specified default value if not found.
getStyledChars(int, int, CommandLine.Help.Ansi.Text, int) - Method in class picocli.CommandLine.Help.Ansi.Text
Copies the specified substring of this Text into the specified destination, preserving the markup.
getSubcommands() - Method in class picocli.CommandLine
Returns a map with the subcommands registered on this instance.
getSuggestions() - Method in exception picocli.CommandLine.UnmatchedArgumentException
Returns suggested solutions if such solutions exist, otherwise returns an empty list.
getter() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the CommandLine.Model.IGetter that is responsible for supplying the value of the annotated program element associated with this group.
getter(CommandLine.Model.IGetter) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets the CommandLine.Model.IGetter that is responsible for getting the value of the annotated program element associated with this group, and returns this builder.
getter() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the CommandLine.Model.IGetter that is responsible for supplying the value of the annotated program element associated with this group.
getter() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the CommandLine.Model.IGetter that is responsible for supplying the value of this argument.
getter() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
getter() - Method in class picocli.CommandLine.Model.UnmatchedArgsBinding
Returns the getter responsible for producing a Collection that the unmatched arguments can be added to.
getToString() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
getType() - Method in interface picocli.CommandLine.Model.ITypeInfo
Returns the class that the option or parameter value should be converted to when matched on the command line.
getType() - Method in class picocli.CommandLine.Model.MethodParam
 
getTypeInfo() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
getUnmatched() - Method in exception picocli.CommandLine.UnmatchedArgumentException
Returns the unmatched command line arguments.
getUnmatchedArguments() - Method in class picocli.CommandLine
Returns the list of unmatched command line arguments, if any.
getUsageHelpLongOptionsMaxWidth() - Method in class picocli.CommandLine
Returns the maximum usage help long options column max width to the specified value.
getUsageHelpWidth() - Method in class picocli.CommandLine
Returns the maximum width of the usage help message.
getUsageMessage() - Method in class picocli.CommandLine
Similar to CommandLine.usage(PrintStream), but returns the usage help message as a String instead of printing it to the PrintStream.
getUsageMessage(CommandLine.Help.Ansi) - Method in class picocli.CommandLine
Similar to CommandLine.usage(PrintStream, Help.Ansi), but returns the usage help message as a String instead of printing it to the PrintStream.
getUsageMessage(CommandLine.Help.ColorScheme) - Method in class picocli.CommandLine
Similar to CommandLine.usage(PrintStream, Help.ColorScheme), but returns the usage help message as a String instead of printing it to the PrintStream.
getValue() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the current value of this argument.
getValue() - Method in exception picocli.CommandLine.ParameterException
Returns the String value for the (sub)command whose input could not be parsed.
getVersion() - Method in interface picocli.CommandLine.IVersionProvider
Returns version information for a command.
group() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the groups this option or positional parameter belongs to, or null if this option is not part of a group.
group() - Method in class picocli.CommandLine.ParseResult.GroupMatch
Returns the ArgGroupSpec of the container GroupMatchContainer of this match.
group() - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
Returns the ArgGroupSpec whose matches are captured in this GroupMatchContainer.

H

handle(CommandLine.ParseResult) - Method in class picocli.CommandLine.AbstractParseResultHandler
Deprecated.
Processes the specified ParseResult and returns the result as a list of objects.
handle(CommandLine.ParseResult) - Method in class picocli.CommandLine.RunAll
Executes the top-level command and all subcommands as Runnable or Callable.
handle(CommandLine.ParseResult) - Method in class picocli.CommandLine.RunFirst
Executes the top-level Runnable or Callable subcommand.
handle(CommandLine.ParseResult) - Method in class picocli.CommandLine.RunLast
Executes the most specific Runnable or Callable subcommand.
handleException(CommandLine.ParameterException, PrintStream, CommandLine.Help.Ansi, String...) - Method in class picocli.CommandLine.DefaultExceptionHandler
Deprecated.
 
handleException(CommandLine.ParameterException, PrintStream, CommandLine.Help.Ansi, String...) - Method in interface picocli.CommandLine.IExceptionHandler
Deprecated.
Handles a ParameterException that occurred while parsing the command line arguments and optionally returns a list of results.
handleExecutionException(CommandLine.ExecutionException, CommandLine.ParseResult) - Method in class picocli.CommandLine.DefaultExceptionHandler
Deprecated.
This implementation always simply rethrows the specified exception.
handleExecutionException(CommandLine.ExecutionException, CommandLine.ParseResult) - Method in interface picocli.CommandLine.IExceptionHandler2
Deprecated.
Handles a ExecutionException that occurred while executing the Runnable or Callable command and optionally returns a list of results.
handleExecutionException(Exception, CommandLine, CommandLine.ParseResult) - Method in interface picocli.CommandLine.IExecutionExceptionHandler
Handles an Exception that occurred while executing the Runnable or Callable command and returns an exit code suitable for returning from CommandLine.execute(String...).
handleParseException(CommandLine.ParameterException, String[]) - Method in class picocli.CommandLine.DefaultExceptionHandler
Deprecated.
Prints the message of the specified exception, followed by the usage message for the command or subcommand whose input was invalid, to the stream returned by CommandLine.AbstractHandler.err().
handleParseException(CommandLine.ParameterException, String[]) - Method in interface picocli.CommandLine.IExceptionHandler2
Deprecated.
Handles a ParameterException that occurred while parsing the command line arguments and optionally returns a list of results.
handleParseException(CommandLine.ParameterException, String[]) - Method in interface picocli.CommandLine.IParameterExceptionHandler
Handles a ParameterException that occurred while parsing the command line arguments and returns an exit code suitable for returning from CommandLine.execute(String...).
handleParseResult(CommandLine.ParseResult) - Method in class picocli.CommandLine.AbstractParseResultHandler
Deprecated.
Prints help if requested, and otherwise calls CommandLine.AbstractParseResultHandler.handle(CommandLine.ParseResult).
handleParseResult(List<CommandLine>, PrintStream, CommandLine.Help.Ansi) - Method in interface picocli.CommandLine.IParseResultHandler
Deprecated.
Processes a List of CommandLine objects resulting from successfully parsing the command line arguments and optionally returns a list of results.
handleParseResult(CommandLine.ParseResult) - Method in interface picocli.CommandLine.IParseResultHandler2
Deprecated.
Processes the ParseResult object resulting from successfully parsing the command line arguments and returns a return value.
handleParseResult(List<CommandLine>, PrintStream, CommandLine.Help.Ansi) - Method in class picocli.CommandLine.RunAll
Prints help if requested, and otherwise executes the top-level command and all subcommands as Runnable, Callable or Method.
handleParseResult(List<CommandLine>, PrintStream, CommandLine.Help.Ansi) - Method in class picocli.CommandLine.RunFirst
Prints help if requested, and otherwise executes the top-level Runnable or Callable command.
handleParseResult(List<CommandLine>, PrintStream, CommandLine.Help.Ansi) - Method in class picocli.CommandLine.RunLast
Prints help if requested, and otherwise executes the most specific Runnable or Callable subcommand.
hasAtFileParameter() - Method in class picocli.CommandLine.Help
Returns true if the usage help should show the at file parameter in the parameter list, otherwise false.
hasExitCode() - Method in class picocli.CommandLine.AbstractHandler
Deprecated.
Returns true if an exit code was set with CommandLine.AbstractHandler.andExit(int), or false (the default) if the handler should not call System.exit(int) after processing completes.
hashCode() - Method in class picocli.CommandLine.Help.Ansi.Text
 
hashCode() - Method in class picocli.CommandLine.Help.ColorScheme
 
hashCode() - Method in class picocli.CommandLine.Help.Column
 
hashCode() - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
hashCode() - Method in class picocli.CommandLine.Model.OptionSpec
 
hashCode() - Method in class picocli.CommandLine.Model.PositionalParamSpec
 
hashCode() - Method in class picocli.CommandLine.Range
 
hashCodeImpl() - Method in class picocli.CommandLine.Model.ArgSpec
 
hasInitialValue() - Method in class picocli.CommandLine.Model.ArgSpec
Determines whether the option or positional parameter will be reset to the CommandLine.Model.ArgSpec.initialValue() before parsing new input.
hasInitialValue() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
hasMatchedOption(char) - Method in class picocli.CommandLine.ParseResult
Returns whether an option whose aliases include the specified short name was matched on the command line.
hasMatchedOption(String) - Method in class picocli.CommandLine.ParseResult
Returns whether an option whose aliases include the specified name was matched on the command line.
hasMatchedOption(CommandLine.Model.OptionSpec) - Method in class picocli.CommandLine.ParseResult
Returns whether the specified option was matched on the command line.
hasMatchedPositional(int) - Method in class picocli.CommandLine.ParseResult
Returns whether a positional parameter was matched at the specified position.
hasMatchedPositional(CommandLine.Model.PositionalParamSpec) - Method in class picocli.CommandLine.ParseResult
Returns whether the specified positional parameter was matched on the command line.
hasSubcommand() - Method in class picocli.CommandLine.ParseResult
Returns true if a subcommand was matched on the command line, false otherwise.
header(Object...) - Method in class picocli.CommandLine.Help
Returns the command header text as a string.
header() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional header lines displayed at the top of the help message.
header(String...) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the optional header lines displayed at the top of the help message.
headerHeading(Object...) - Method in class picocli.CommandLine.Help
Returns the text displayed before the header text; the result of String.format(headerHeading, params).
headerHeading() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional heading preceding the header section.
headerHeading(String) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the heading preceding the header section.
heading() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the heading of this group, used when generating the usage documentation.
heading(String) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets the heading of this group (may be null), used when generating the usage documentation.
heading() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the heading of this group (may be null), used when generating the usage documentation.
headingKey() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the heading key of this group, used to get the heading from a resource bundle.
headingKey(String) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets the heading key of this group, used to get the heading from a resource bundle.
headingKey() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the heading key of this group (may be null), used to get the heading from a resource bundle.
Help(Object) - Constructor for class picocli.CommandLine.Help
Constructs a new Help instance with a default color scheme, initialized from annotations on the specified class and superclasses.
Help(Object, CommandLine.Help.Ansi) - Constructor for class picocli.CommandLine.Help
Constructs a new Help instance with a default color scheme, initialized from annotations on the specified class and superclasses.
Help(Object, CommandLine.Help.ColorScheme) - Constructor for class picocli.CommandLine.Help
Deprecated.
use picocli.CommandLine.Help#Help(picocli.CommandLine.Model.CommandSpec, picocli.CommandLine.Help.ColorScheme)
Help(CommandLine.Model.CommandSpec, CommandLine.Help.ColorScheme) - Constructor for class picocli.CommandLine.Help
Constructs a new Help instance with the specified color scheme, initialized from annotations on the specified class and superclasses.
help() - Method in class picocli.CommandLine.Model.OptionSpec.Builder
help(boolean) - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Sets whether this option disables validation of the other arguments, and returns this builder.
help() - Method in class picocli.CommandLine.Model.OptionSpec
HelpCommand() - Constructor for class picocli.CommandLine.HelpCommand
 
helpCommand() - Method in class picocli.CommandLine.Model.CommandSpec
Returns whether this subcommand is a help command, and required options and positional parameters of the parent command should not be validated.
helpCommand(boolean) - Method in class picocli.CommandLine.Model.CommandSpec
Sets whether this is a help command and required parameter checking should be suspended.
helpFactory() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the IHelpFactory that is used to construct the usage help message.
helpFactory(CommandLine.IHelpFactory) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets a new IHelpFactory to customize the usage help message.
hidden() - Method in class picocli.CommandLine.Model.ArgSpec
Returns whether this option should be excluded from the usage message.
hidden() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns whether this command should be hidden from the usage help message of the parent command.
hidden(boolean) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Set the hidden flag on this command to control whether to show or hide it in the help usage text of the parent command.
hideParamSyntax() - Method in class picocli.CommandLine.Model.ArgSpec
Returns whether usage syntax decorations around the paramLabel should be suppressed.

I

indent - Variable in class picocli.CommandLine.Help.Column
Indent (number of empty spaces at the start of the column preceding the text value)
indentWrappedLines - Variable in class picocli.CommandLine.Help.TextTable
By default, indent wrapped lines by 2 spaces.
index() - Method in class picocli.CommandLine.Model.PositionalParamSpec.Builder
Returns an index or range specifying which of the command line arguments should be assigned to this positional parameter.
index(String) - Method in class picocli.CommandLine.Model.PositionalParamSpec.Builder
Sets the index or range specifying which of the command line arguments should be assigned to this positional parameter, and returns this builder.
index(CommandLine.Range) - Method in class picocli.CommandLine.Model.PositionalParamSpec.Builder
Sets the index or range specifying which of the command line arguments should be assigned to this positional parameter, and returns this builder.
index() - Method in class picocli.CommandLine.Model.PositionalParamSpec
Returns an index or range specifying which of the command line arguments should be assigned to this positional parameter.
info(String, Object...) - Method in class picocli.CommandLine.Tracer
Prints the specified message if the current trace level is INFO or higher.
inherited() - Method in class picocli.CommandLine.Model.ArgSpec
Returns whether this option is inherited from a parent command.
inherited() - Method in class picocli.CommandLine.Model.CommandSpec
Returns whether this command is inherited from a parent command.
init(CommandLine, CommandLine.Help.Ansi, PrintStream, PrintStream) - Method in class picocli.CommandLine.HelpCommand
Deprecated.
init(CommandLine, CommandLine.Help.ColorScheme, PrintWriter, PrintWriter) - Method in class picocli.CommandLine.HelpCommand
Initializes this object with the information needed to implement a help command that provides usage help for other commands.
init(CommandLine, CommandLine.Help.Ansi, PrintStream, PrintStream) - Method in interface picocli.CommandLine.IHelpCommandInitializable
Deprecated.
init(CommandLine, CommandLine.Help.ColorScheme, PrintWriter, PrintWriter) - Method in interface picocli.CommandLine.IHelpCommandInitializable2
Initializes this object with the information needed to implement a help command that provides usage help for other commands.
InitializationException(String) - Constructor for exception picocli.CommandLine.InitializationException
 
InitializationException(String, Exception) - Constructor for exception picocli.CommandLine.InitializationException
 
initialValue() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the initial value of this option or positional parameter: the value that, if CommandLine.Model.ArgSpec.hasInitialValue() is true, the option will be reset to before parsing (regardless of whether a default value exists), to clear values that would otherwise remain from parsing previous input.
insertSynopsisCommandName(int, CommandLine.Help.Ansi.Text) - Method in class picocli.CommandLine.Help
Returns the detailed synopsis text by inserting the command name before the specified text with options and positional parameters details.
interactive() - Method in class picocli.CommandLine.Model.ArgSpec
Returns whether this option will prompt the user to enter a value on the command line.
internalShowDefaultValue(boolean) - Method in class picocli.CommandLine.Model.ArgSpec
Returns whether the default for this option or positional parameter should be shown, potentially overriding the specified global setting.
internalShowDefaultValue(boolean) - Method in class picocli.CommandLine.Model.OptionSpec
 
interpolateVariables() - Method in class picocli.CommandLine.Model.CommandSpec
Returns whether variables should be interpolated in String values.
interpolateVariables(Boolean) - Method in class picocli.CommandLine.Model.CommandSpec
Sets whether variables should be interpolated in String values.
invoke(String, Class<?>, String...) - Static method in class picocli.CommandLine
invoke(String, Class<?>, PrintStream, String...) - Static method in class picocli.CommandLine
invoke(String, Class<?>, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
invoke(String, Class<?>, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
isAbbreviatedOptionsAllowed() - Method in class picocli.CommandLine
Returns whether abbreviation of option names should be allowed when matching options.
isAbbreviatedSubcommandsAllowed() - Method in class picocli.CommandLine
Returns whether abbreviation of subcommands should be allowed when matching subcommands.
isAccessible() - Method in class picocli.CommandLine.Model.MethodParam
 
isAddMethodSubcommands() - Method in class picocli.CommandLine.Model.CommandSpec
Returns whether method commands should be added as subcommands.
isAdjustLineBreaksForWideCJKCharacters() - Method in class picocli.CommandLine.Help.TextTable
 
isAdjustLineBreaksForWideCJKCharacters() - Method in class picocli.CommandLine
Returns whether line breaks should take wide Chinese, Japanese and Korean characters into account for line-breaking purposes.
isAllowOptionsAsOptionParameters() - Method in class picocli.CommandLine
Returns whether options can have parameter values that match the name of an option in this command, or whether such values should be rejected with a missing parameter exception.
isAllowSubcommandsAsOptionParameters() - Method in class picocli.CommandLine
Returns whether options can have parameter values that match subcommand names or aliases, or whether such values should be rejected with a missing parameter exception.
isAnnotationPresent(Class<? extends Annotation>) - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isArgGroup() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isArgSpec() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isArray() - Method in interface picocli.CommandLine.Model.ITypeInfo
Returns true if this type is an array multi-value type.
isBoolean() - Method in interface picocli.CommandLine.Model.ITypeInfo
Returns true if CommandLine.Model.ITypeInfo.getType() is boolean or java.lang.Boolean.
isCaseInsensitiveEnumValuesAllowed() - Method in class picocli.CommandLine
Returns whether the parser should ignore case when converting arguments to enum values.
isCollection() - Method in interface picocli.CommandLine.Model.ITypeInfo
 
isDebug() - Method in class picocli.CommandLine.Tracer
Returns whether the current trace level is DEBUG (the highest).
isEmpty() - Method in class picocli.CommandLine.ParseResult.GroupMatch
Returns true if this match has no matched arguments and no matched subgroups.
isEnabled(CommandLine.TraceLevel) - Method in enum picocli.CommandLine.TraceLevel
Returns whether messages at the specified other trace level would be printed for the current trace level.
isEnum() - Method in interface picocli.CommandLine.Model.ITypeInfo
Returns true if CommandLine.Model.ITypeInfo.getType() is an enum.
isExpandAtFiles() - Method in class picocli.CommandLine
Returns whether arguments starting with '@' should be treated as the path to an argument file and its contents should be expanded into separate arguments for each line in the specified file.
isInfo() - Method in class picocli.CommandLine.Tracer
Returns whether the current trace level is INFO or higher.
isInteractive() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isInterpolateVariables() - Method in class picocli.CommandLine
Returns whether variables should be interpolated in String values.
isMap() - Method in interface picocli.CommandLine.Model.ITypeInfo
 
isMethodParameter() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isMixin() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isMultiValue() - Method in class picocli.CommandLine.Model.ArgSpec
Returns true if this argument's CommandLine.Model.ArgSpec.type() is an array, a Collection or a Map, false otherwise.
isMultiValue() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isMultiValue() - Method in interface picocli.CommandLine.Model.ITypeInfo
Returns true if CommandLine.Model.ITypeInfo.getType() is an array, map or collection.
isOff() - Method in class picocli.CommandLine.Tracer
Returns whether the current trace level is OFF (the lowest).
isOption() - Method in class picocli.CommandLine.Model.ArgSpec
Returns true if this argument is a named option, false otherwise.
isOption() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isOption() - Method in class picocli.CommandLine.Model.OptionSpec
 
isOption() - Method in class picocli.CommandLine.Model.PositionalParamSpec
 
isOptional() - Method in interface picocli.CommandLine.Model.ITypeInfo
Returns true if CommandLine.Model.ITypeInfo.getType() is java.util.Optional
isOptionsCaseInsensitive() - Method in class picocli.CommandLine
Returns whether upper case and lower case should be ignored when matching option names.
isOverwrittenOptionsAllowed() - Method in class picocli.CommandLine
Returns whether options for single-value fields can be specified multiple times on the command line.
isParameter() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isParentCommand() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isPositional() - Method in class picocli.CommandLine.Model.ArgSpec
Returns true if this argument is a positional parameter, false otherwise.
isPositional() - Method in class picocli.CommandLine.Model.OptionSpec
 
isPositional() - Method in class picocli.CommandLine.Model.PositionalParamSpec
 
isPosixClusteredShortOptionsAllowed() - Method in class picocli.CommandLine
Returns whether the parser accepts clustered short options.
isRelative() - Method in class picocli.CommandLine.Range
Returns true if this Range contains a relative index like "1+", or false if this Range does not contain any relative indices.
isSpec() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isSplitQuotedStrings() - Method in class picocli.CommandLine
Deprecated.
Most applications should not change the default. The rare application that does need to split parameter values without respecting quotes should use CommandLine.Model.ParserSpec.splitQuotedStrings(boolean).
isStopAtPositional() - Method in class picocli.CommandLine
Returns whether the parser interprets the first positional parameter as "end of options" so the remaining arguments are all treated as positional parameters.
isStopAtUnmatched() - Method in class picocli.CommandLine
Returns whether the parser should stop interpreting options and positional parameters as soon as it encounters an unmatched option.
isSubcommandsCaseInsensitive() - Method in class picocli.CommandLine
Returns whether upper case and lower case should be ignored when matching subcommands.
isSubgroupOf(CommandLine.Model.ArgGroupSpec) - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns true if this group is a subgroup (or a nested sub-subgroup, to any level of depth) of the specified group, false otherwise.
isToggleBooleanFlags() - Method in class picocli.CommandLine
Returns whether the value of boolean flag options should be "toggled" when the option is matched.
isTrimQuotes() - Method in class picocli.CommandLine
Returns whether the parser should trim quotes from command line arguments.
isUnknownOption() - Method in exception picocli.CommandLine.UnmatchedArgumentException
Returns true if the first unmatched command line arguments resembles an option, false otherwise.
isUnmatched() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isUnmatchedArgumentsAllowed() - Method in class picocli.CommandLine
Returns whether the end user may specify arguments on the command line that are not matched to any option or parameter fields.
isUnmatchedOptionsAllowedAsOptionParameters() - Method in class picocli.CommandLine
Returns whether options can have parameter values that resemble an option, or whether such values should be rejected as unknown options.
isUnmatchedOptionsArePositionalParams() - Method in class picocli.CommandLine
Returns whether arguments on the command line that resemble an option should be treated as positional parameters.
isUnresolved() - Method in class picocli.CommandLine.Range
Returns true if this range contains a relative index like "1+", or variables that have not been expanded yet, false if this Range does not contain any variables or relative indices.
isUnspecified() - Method in class picocli.CommandLine.Range
Returns true if this Range is a default value, false if the user specified this value.
isUsageHelpAutoWidth() - Method in class picocli.CommandLine
Returns whether picocli should attempt to detect the terminal size and adjust the usage help message width to take the full terminal width.
isUsageHelpRequested() - Method in class picocli.CommandLine
Returns true if an option annotated with CommandLine.Option.usageHelp() was specified on the command line.
isUsageHelpRequested() - Method in class picocli.CommandLine.ParseResult
Returns true if one of the options that was matched on the command line is a usageHelp option.
isUseSimplifiedAtFiles() - Method in class picocli.CommandLine
Returns whether to use a simplified argument file format that is compatible with JCommander.
isValueGettable() - Method in class picocli.CommandLine.Model.ArgSpec
Check whether the CommandLine.Model.ArgSpec.getValue() method is able to get an actual value from the current CommandLine.Model.ArgSpec.getter().
isVariable - Variable in class picocli.CommandLine.Range
Deprecated.
isVariable() - Method in class picocli.CommandLine.Range
Returns true if this range has no fixed upper bound.
isVersionHelpRequested() - Method in class picocli.CommandLine
Returns true if an option annotated with CommandLine.Option.versionHelp() was specified on the command line.
isVersionHelpRequested() - Method in class picocli.CommandLine.ParseResult
Returns true if one of the options that was matched on the command line is a versionHelp option.
isWarn() - Method in class picocli.CommandLine.Tracer
Returns whether the current trace level is WARN or higher.

J

join(CommandLine.Help.Ansi, int, String[], StringBuilder, Object...) - Static method in class picocli.CommandLine.Help
join(CommandLine.Help.Ansi, int, boolean, String[], StringBuilder, Object...) - Static method in class picocli.CommandLine.Help
Formats each of the specified values and appends it to the specified StringBuilder.

K

keyValuesMap(String...) - Static method in class picocli.CommandLine.Model.UsageMessageSpec
Creates and returns a Map that contains an entry for each specified String that is in "key:value" format.

L

Layout(CommandLine.Help.ColorScheme, int) - Constructor for class picocli.CommandLine.Help.Layout
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, CommandLine.Help.TextTable) - Constructor for class picocli.CommandLine.Help.Layout
Constructs a Layout with the specified color scheme, the specified TextTable, the default option renderer, and the default parameter renderer.
Layout(CommandLine.Help.ColorScheme, CommandLine.Help.TextTable, CommandLine.Help.IOptionRenderer, CommandLine.Help.IParameterRenderer) - Constructor for class picocli.CommandLine.Help.Layout
Constructs a Layout with the specified color scheme, the specified TextTable, the specified option renderer and the specified parameter renderer.
layout(CommandLine.Model.ArgSpec, CommandLine.Help.Ansi.Text[][]) - Method in class picocli.CommandLine.Help.Layout
Copies the specified text values into the correct cells in the CommandLine.Help.TextTable.
limitSplit() - Method in class picocli.CommandLine.Model.ParserSpec
Returns true if arguments should be split first before any further processing and the number of parts resulting from the split is limited to the max arity of the argument.
limitSplit(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
Sets whether arguments should be split first before any further processing.
longestName() - Method in class picocli.CommandLine.Model.OptionSpec
Returns the longest option name.
longOptionsMaxWidth(int) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the maximum usage help long options column max width to the specified value.
longOptionsMaxWidth() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the maximum usage help long options column max width to the specified value.

M

main(String...) - Static method in class picocli.AutoComplete
Generates a bash completion script for the specified command class.
makeNegative(String, CommandLine.Model.CommandSpec) - Method in interface picocli.CommandLine.INegatableOptionTransformer
Returns the negative form of the specified option name for the parser to recognize when parsing command line arguments.
makeNegative(String, CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.RegexTransformer
Returns the negative form of the specified option name for the parser to recognize when parsing command line arguments.
makeSynopsis(String, CommandLine.Model.CommandSpec) - Method in interface picocli.CommandLine.INegatableOptionTransformer
Returns the documentation string to show in the synopsis and usage help message for the specified option.
makeSynopsis(String, CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.RegexTransformer
Returns the documentation string to show in the synopsis and usage help message for the specified option.
makeSynopsisFromParts(int, CommandLine.Help.Ansi.Text, CommandLine.Help.Ansi.Text, CommandLine.Help.Ansi.Text, CommandLine.Help.Ansi.Text, CommandLine.Help.Ansi.Text) - Method in class picocli.CommandLine.Help
Concatenates the command name and the specified synopsis parts and returns a fully rendered synopsis String.
mapFallbackValue() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the fallback value for this Map option or positional parameter: the value that is put into the Map when only the key is specified for the option or positional parameter, like -Dkey instead of -Dkey=value.
matchedArgs() - Method in class picocli.CommandLine.ParseResult
Returns a list of matched options and positional parameters, in order they were matched on the command line.
matchedOption(char) - Method in class picocli.CommandLine.ParseResult
Returns the option with the specified short name, or null if no option with that name was matched on the command line.
matchedOption(String) - Method in class picocli.CommandLine.ParseResult
Returns the option with the specified name, or null if no option with that name was matched on the command line.
matchedOptions() - Method in class picocli.CommandLine.ParseResult
Returns a list of matched options, in order they were matched on the command line.
matchedOptionsSet() - Method in class picocli.CommandLine.ParseResult
Returns a set of matched options.
matchedOptionValue(char, T) - Method in class picocli.CommandLine.ParseResult
Returns the command line argument value of the option with the specified name, converted to the type of the option, or the specified default value if no option with the specified name was matched.
matchedOptionValue(String, T) - Method in class picocli.CommandLine.ParseResult
Returns the command line argument value of the option with the specified name, converted to the type of the option, or the specified default value if no option with the specified name was matched.
matchedPositional(int) - Method in class picocli.CommandLine.ParseResult
Returns the first PositionalParamSpec that matched an argument at the specified position, or null if no positional parameters were matched at that position.
matchedPositionals(int) - Method in class picocli.CommandLine.ParseResult
Returns all PositionalParamSpec objects that matched an argument at the specified position, or an empty list if no positional parameters were matched at that position.
matchedPositionals() - Method in class picocli.CommandLine.ParseResult
Returns a list of matched positional parameters, in order they were matched on the command line.
matchedPositionalsSet() - Method in class picocli.CommandLine.ParseResult
Returns a set of matched positional parameters.
matchedPositionalValue(int, T) - Method in class picocli.CommandLine.ParseResult
Returns the command line argument value of the positional parameter at the specified position, converted to the type of the positional parameter, or the specified default value if no positional parameter was matched at that position.
matchedSubgroups() - Method in class picocli.CommandLine.ParseResult.GroupMatch
Returns matches for the subgroups, if any.
matchedValues(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.ParseResult.GroupMatch
Returns the values matched for the specified argument, converted to the type of the argument.
matches() - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
Returns the list of GroupMatch instances: ArgGroupSpecs with a multiplicity greater than one may be matched multiple times.
max - Variable in class picocli.CommandLine.Range
Deprecated.
max(int) - Method in class picocli.CommandLine.Range
Returns a new Range object with the max value replaced by the specified value.
max() - Method in class picocli.CommandLine.Range
Returns the upper bound of this range (inclusive), or Integer.MAX_VALUE if this range has no upper bound.
MaxValuesExceededException(CommandLine, String) - Constructor for exception picocli.CommandLine.MaxValuesExceededException
 
messages() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the Messages for this argument group specification, or null.
messages(CommandLine.Model.Messages) - Method in class picocli.CommandLine.Model.ArgGroupSpec
Sets the Messages for this ArgGroupSpec, and returns this ArgGroupSpec.
messages() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the Messages for this arg specification, or null.
messages(CommandLine.Model.Messages) - Method in class picocli.CommandLine.Model.ArgSpec
Sets the Messages for this ArgSpec, and returns this ArgSpec.
Messages(CommandLine.Model.CommandSpec, String) - Constructor for class picocli.CommandLine.Model.Messages
 
Messages(CommandLine.Model.CommandSpec, ResourceBundle) - Constructor for class picocli.CommandLine.Model.Messages
 
Messages(CommandLine.Model.CommandSpec, String, ResourceBundle) - Constructor for class picocli.CommandLine.Model.Messages
 
messages() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the Messages for this usage help message specification, or null.
messages(CommandLine.Model.Messages) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the Messages for this usageMessage specification, and returns this UsageMessageSpec.
MethodParam(Method, int) - Constructor for class picocli.CommandLine.Model.MethodParam
 
min - Variable in class picocli.CommandLine.Range
Deprecated.
min(int) - Method in class picocli.CommandLine.Range
Returns a new Range object with the min value replaced by the specified value.
min() - Method in class picocli.CommandLine.Range
Returns the lower bound of this range (inclusive).
MissingParameterException(CommandLine, CommandLine.Model.ArgSpec, String) - Constructor for exception picocli.CommandLine.MissingParameterException
 
MissingParameterException(CommandLine, Collection<CommandLine.Model.ArgSpec>, String) - Constructor for exception picocli.CommandLine.MissingParameterException
 
MissingTypeConverterException(CommandLine, String) - Constructor for exception picocli.CommandLine.MissingTypeConverterException
 
mixinAnnotatedElements() - Method in class picocli.CommandLine.Model.CommandSpec
Returns a map of the mixin names to mixin IAnnotatedElement objects for this command.
mixins() - Method in class picocli.CommandLine.Model.CommandSpec
Returns a map of the mixin names to mixin CommandSpec objects configured for this command.
mixinStandardHelpOptions() - Method in class picocli.CommandLine.Model.CommandSpec
Returns true if the standard help options have been mixed in with this command, false otherwise.
mixinStandardHelpOptions(boolean) - Method in class picocli.CommandLine.Model.CommandSpec
Sets whether the standard help options should be mixed in with this command.
modelTransformer() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the model transformer for this CommandSpec instance.
modelTransformer(CommandLine.IModelTransformer) - Method in class picocli.CommandLine.Model.CommandSpec
Sets the model transformer for this CommandSpec instance.
multiplicity() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the multiplicity of this group: how many occurrences it may have on the command line; "0..1" (optional) by default.
multiplicity(String) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets the multiplicity of this group: how many occurrences it may have on the command line; "0..1" (optional) by default.
multiplicity(CommandLine.Range) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets the multiplicity of this group: how many occurrences it may have on the command line; "0..1" (optional) by default.
multiplicity() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the multiplicity of this group: how many occurrences it may have on the command line; "0..1" (optional) by default.
MutuallyExclusiveArgsException(CommandLine, String) - Constructor for exception picocli.CommandLine.MutuallyExclusiveArgsException
 

N

name() - Method in class picocli.CommandLine.Model.CommandSpec
Returns name of this command.
name(String) - Method in class picocli.CommandLine.Model.CommandSpec
Sets the String to use as the program name in the synopsis line of the help message.
names() - Method in class picocli.CommandLine.Model.CommandSpec
Returns all names of this command, including CommandLine.Model.CommandSpec.name() and CommandLine.Model.CommandSpec.aliases().
names() - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Returns one or more option names.
names(String...) - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Replaces the option names with the specified values.
names() - Method in class picocli.CommandLine.Model.OptionSpec
Returns one or more option names.
negatable() - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Returns whether a negative version for this boolean option is automatically added.
negatable(boolean) - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Sets whether a negative version for this boolean option is automatically added, and returns this builder.
negatable() - Method in class picocli.CommandLine.Model.OptionSpec
Returns whether a negative version for this boolean option is automatically added.
negatableOptionTransformer() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the INegatableOptionTransformer used to create the negative form of negatable options.
negatableOptionTransformer(CommandLine.INegatableOptionTransformer) - Method in class picocli.CommandLine.Model.CommandSpec
Sets the INegatableOptionTransformer used to create the negative form of negatable options.
negatedOptionsMap() - Method in class picocli.CommandLine.Model.CommandSpec
Returns a map of the negated option names to option spec objects configured for this command.
NULL_VALUE - Static variable in annotation type picocli.CommandLine.Option
Special value that can be used in some annotation attributes to designate null.
NULL_VALUE - Static variable in annotation type picocli.CommandLine.Parameters
Special value that can be used in some annotation attributes to designate null.

O

off() - Method in interface picocli.CommandLine.Help.Ansi.IStyle
Returns the ANSI escape code for turning this style off.
off() - Method in enum picocli.CommandLine.Help.Ansi.Style
 
off(CommandLine.Help.Ansi.IStyle...) - Static method in enum picocli.CommandLine.Help.Ansi.Style
Returns the concatenated ANSI escape codes for turning all specified styles off.
OK - Static variable in class picocli.CommandLine.ExitCode
Return value from the execute and executeHelpRequest methods signifying successful termination.
on() - Method in interface picocli.CommandLine.Help.Ansi.IStyle
Returns the ANSI escape code for turning this style on.
on() - Method in enum picocli.CommandLine.Help.Ansi.Style
 
on(CommandLine.Help.Ansi.IStyle...) - Static method in enum picocli.CommandLine.Help.Ansi.Style
Returns the concatenated ANSI escape codes for turning all specified styles on.
optionArity(Field) - Static method in class picocli.CommandLine.Range
Returns a new Range based on the CommandLine.Option.arity() annotation on the specified field, or the field type's default arity if no arity was specified.
optionList() - Method in class picocli.CommandLine.Help
Returns a description of all options in this command, including any argument groups.
optionList(CommandLine.Help.Layout, Comparator<CommandLine.Model.OptionSpec>, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help
Sorts all Options with the specified comparator (if the comparator is non-null), then adds all non-hidden options to the specified TextTable and returns the result of TextTable.toString().
optionListExcludingGroups(List<CommandLine.Model.OptionSpec>) - Method in class picocli.CommandLine.Help
Returns a description of the specified list of options.
optionListExcludingGroups(List<CommandLine.Model.OptionSpec>, CommandLine.Help.Layout, Comparator<CommandLine.Model.OptionSpec>, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help
Sorts all Options with the specified comparator (if the comparator is non-null), then adds the specified options to the specified TextTable and returns the result of TextTable.toString().
optionListGroupSections() - Method in class picocli.CommandLine.Help
Returns a rendered section of the usage help message that contains the argument groups that have a non-null heading.
optionListHeading(Object...) - Method in class picocli.CommandLine.Help
Returns the text displayed before the option list; an empty string if there are no options, otherwise the result of String.format(optionListHeading, params).
optionListHeading() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional heading preceding the options list.
optionListHeading(String) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the heading preceding the options list.
optionParams(CommandLine.Help.Ansi.IStyle...) - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Adds the specified styles to the registered styles for option parameters in this color scheme builder and returns this builder.
optionParamStyles() - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Returns the registered styles for option parameters in this color scheme builder.
optionParamStyles() - Method in class picocli.CommandLine.Help.ColorScheme
Returns the registered styles for option parameters in this color scheme.
optionParamText(String) - Method in class picocli.CommandLine.Help.ColorScheme
Returns a Text with all optionParam styles applied to the specified optionParam string.
optionRenderer - Variable in class picocli.CommandLine.Help.Layout
 
optionRenderer() - Method in class picocli.CommandLine.Help.Layout
Returns the IOptionRenderer used to render options to Text before adding this text to the TextTable in this layout.
options(CommandLine.Help.Ansi.IStyle...) - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Adds the specified styles to the registered styles for options in this color scheme and returns this color scheme.
options() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the list of options configured for this group.
options() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the list of options configured for this command.
optionsCaseInsensitive() - Method in class picocli.CommandLine.Model.CommandSpec
Returns whether the options are case-insensitive.
optionsCaseInsensitive(boolean) - Method in class picocli.CommandLine.Model.CommandSpec
Sets the case-insensitivity of options.
optionSectionGroups() - Method in class picocli.CommandLine.Help
Returns the list of ArgGroupSpec instances in this command that have a non-null heading, most deeply nested argument groups first.
optionsMap() - Method in class picocli.CommandLine.Model.CommandSpec
Returns a map of the option names to option spec objects configured for this command.
optionStyles() - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Returns the registered styles for options in this color scheme builder.
optionStyles() - Method in class picocli.CommandLine.Help.ColorScheme
Returns the registered styles for options in this color scheme.
optionText(String) - Method in class picocli.CommandLine.Help.ColorScheme
Returns a Text with all option styles applied to the specified option string.
order() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the position in the options list in the usage help message at which this group should be shown.
order(int) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets the position in the options list in the usage help message at which this group should be shown, and returns this builder.
order() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the position in the options list in the usage help message at which this group should be shown.
order() - Method in interface picocli.CommandLine.Model.IOrdered
Returns the position in the options list in the usage help message at which this element should be shown.
order() - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Returns the position in the options list in the usage help message at which this option should be shown.
order(int) - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Sets the position in the options list in the usage help message at which this option should be shown, and returns this builder.
order() - Method in class picocli.CommandLine.Model.OptionSpec
Returns the position in the options list in the usage help message at which this option should be shown.
originalArgs(String[]) - Method in class picocli.CommandLine.ParseResult.Builder
Sets the specified original command line arguments that were passed to the CommandLine.parseArgs(String...) method, before @-file expansion.
originalArgs() - Method in class picocli.CommandLine.ParseResult
Returns the original command line arguments that were passed to the CommandLine.parseArgs(String...) method, before @-file expansion.
originallyRequired() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the original value of the option's required attribute, regardless of whether the option is used in an exclusive group or not.
originalStringValues() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the original command line arguments matched by this option or positional parameter spec.
originalValue() - Method in class picocli.CommandLine.Range
Returns the original String value that this range was constructed with.
out() - Method in class picocli.CommandLine.AbstractHandler
Deprecated.
Returns the stream to print command output to.
overflow - Variable in class picocli.CommandLine.Help.Column
Policy that determines how to handle values larger than the column width.
OverwrittenOptionException(CommandLine, CommandLine.Model.ArgSpec, String) - Constructor for exception picocli.CommandLine.OverwrittenOptionException
 
overwrittenOptionsAllowed() - Method in class picocli.CommandLine.Model.ParserSpec
 
overwrittenOptionsAllowed(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 

P

parameterArity(Field) - Static method in class picocli.CommandLine.Range
Returns a new Range based on the CommandLine.Parameters.arity() annotation on the specified field, or the field type's default arity if no arity was specified.
parameterConsumer() - Method in class picocli.CommandLine.Model.ArgSpec
Returns a custom IParameterConsumer to temporarily suspend picocli's parsing logic and process one or more command line arguments in a custom manner, or null.
ParameterException(CommandLine, String) - Constructor for exception picocli.CommandLine.ParameterException
Constructs a new ParameterException with the specified CommandLine and error message.
ParameterException(CommandLine, String, Throwable) - Constructor for exception picocli.CommandLine.ParameterException
Constructs a new ParameterException with the specified CommandLine and error message.
ParameterException(CommandLine, String, Throwable, CommandLine.Model.ArgSpec, String) - Constructor for exception picocli.CommandLine.ParameterException
Constructs a new ParameterException with the specified CommandLine and error message.
ParameterException(CommandLine, String, CommandLine.Model.ArgSpec, String) - Constructor for exception picocli.CommandLine.ParameterException
Constructs a new ParameterException with the specified CommandLine and error message.
parameterIndex(Field) - Static method in class picocli.CommandLine.Range
Returns a new Range based on the CommandLine.Parameters.index() annotation on the specified field.
ParameterIndexGapException(String) - Constructor for exception picocli.CommandLine.ParameterIndexGapException
 
parameterLabelRenderer() - Method in class picocli.CommandLine.Help
Option and positional parameter value label renderer used for the synopsis line(s) and the option list.
parameterList() - Method in class picocli.CommandLine.Help
Returns the rendered positional parameters section of the usage help message for all positional parameters in this command.
parameterList(List<CommandLine.Model.PositionalParamSpec>) - Method in class picocli.CommandLine.Help
Returns the rendered positional parameters section of the usage help message for the specified positional parameters.
parameterList(CommandLine.Help.Layout, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help
Returns the rendered section of the usage help message that lists all positional parameters in this command with their descriptions.
parameterList(List<CommandLine.Model.PositionalParamSpec>, CommandLine.Help.Layout, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help
Returns the rendered section of the usage help message that lists the specified parameters with their descriptions.
parameterListHeading(Object...) - Method in class picocli.CommandLine.Help
Returns the text displayed before the positional parameter list; an empty string if there are no positional parameters, otherwise the result of String.format(parameterListHeading, params).
parameterListHeading() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional heading preceding the parameter list.
parameterListHeading(String) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the optional heading preceding the parameter list.
parameterRenderer - Variable in class picocli.CommandLine.Help.Layout
 
parameterRenderer() - Method in class picocli.CommandLine.Help.Layout
Returns the IParameterRenderer used to render positional params to Text before adding this text to the TextTable in this layout.
parameters(CommandLine.Help.Ansi.IStyle...) - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Adds the specified styles to the registered styles for positional parameters in this color scheme builder and returns this builder.
parameterStyles() - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Returns the registered styles for positional parameters in this color scheme builder.
parameterStyles() - Method in class picocli.CommandLine.Help.ColorScheme
Returns the registered styles for positional parameters in this color scheme.
parameterText(String) - Method in class picocli.CommandLine.Help.ColorScheme
Returns a Text with all parameter styles applied to the specified parameter string.
paramLabel() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the name of the option or positional parameter used in the usage help message.
parent() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the parent command of this subcommand, or null if this is a top-level command.
parent(CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.Model.CommandSpec
Sets the parent command of this subcommand.
parent() - Method in class picocli.CommandLine.Model.Messages
 
parentCommandElements() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the list of program elements annotated with {@literal @}ParentCommand configured for this command.
parentGroup() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the parent group that this group is part of, or null if this group is not part of a composite.
parse(String) - Static method in enum picocli.CommandLine.Help.Ansi.Style
Parses the specified comma-separated sequence of style descriptors and returns the associated styles.
parse(String) - Method in class picocli.CommandLine.Help.ColorScheme
Converts the specified markup styles to an array of CommandLine.Help.Ansi.IStyle objects.
parse(String...) - Method in class picocli.CommandLine
Deprecated.
parseArgs(String...) - Method in class picocli.CommandLine
Expands any @-files in the specified command line arguments, then parses the arguments and returns a ParseResult with the options, positional parameters, and subcommands (if any) that were recognized and initialized during the parsing process.
parser() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the parser specification for this command.
parser(CommandLine.Model.ParserSpec) - Method in class picocli.CommandLine.Model.CommandSpec
Initializes the parser specification for this command from the specified settings and returns this commandSpec.
ParserSpec() - Constructor for class picocli.CommandLine.Model.ParserSpec
 
parseWithHandler(CommandLine.IParseResultHandler, PrintStream, String...) - Method in class picocli.CommandLine
parseWithHandler(CommandLine.IParseResultHandler2<R>, String[]) - Method in class picocli.CommandLine
parseWithHandlers(CommandLine.IParseResultHandler, PrintStream, CommandLine.Help.Ansi, CommandLine.IExceptionHandler, String...) - Method in class picocli.CommandLine
parseWithHandlers(CommandLine.IParseResultHandler2<R>, CommandLine.IExceptionHandler2<R>, String...) - Method in class picocli.CommandLine
picocli - package picocli
Provides classes and interfaces for the main picocli command line parsing and autocompletion functionality.
PicocliException(String) - Constructor for exception picocli.CommandLine.PicocliException
 
PicocliException(String, Throwable) - Constructor for exception picocli.CommandLine.PicocliException
 
plainString() - Method in class picocli.CommandLine.Help.Ansi.Text
Returns the plain text without any formatting.
populateCommand(T, String...) - Static method in class picocli.CommandLine
Convenience method that initializes the specified annotated object from the specified command line arguments.
populateSpec(Class<T>, String...) - Static method in class picocli.CommandLine
Convenience method that derives the command specification from the specified interface class, and returns an instance of the specified interface.
positionalParameters() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the list of positional parameters configured for this group.
positionalParameters() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the list of positional parameters configured for this command.
posixClusteredShortOptionsAllowed() - Method in class picocli.CommandLine.Model.ParserSpec
 
posixClusteredShortOptionsAllowed(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
posixOptionsMap() - Method in class picocli.CommandLine.Model.CommandSpec
Returns a map of the short (single character) option names to option spec objects configured for this command.
preprocess(Stack<String>, CommandLine.Model.CommandSpec, CommandLine.Model.ArgSpec, Map<String, Object>) - Method in interface picocli.CommandLine.IParameterPreprocessor
Called when either the command, option or positional parameter that has this preprocessor configured was recognized by the picocli parser.
preprocessor() - Method in class picocli.CommandLine.Model.ArgSpec
Returns a custom IParameterPreprocessor to either replace or complement picocli's parsing logic for the parameter(s) of this option or position.
preprocessor() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the preprocessor for this CommandSpec instance.
preprocessor(CommandLine.IParameterPreprocessor) - Method in class picocli.CommandLine.Model.CommandSpec
Sets the preprocessor for this CommandSpec instance.
printHelpIfRequested(List<CommandLine>, PrintStream, CommandLine.Help.Ansi) - Static method in class picocli.CommandLine
printHelpIfRequested(CommandLine.ParseResult) - Static method in class picocli.CommandLine
printHelpIfRequested(List<CommandLine>, PrintStream, PrintStream, CommandLine.Help.Ansi) - Static method in class picocli.CommandLine
printHelpIfRequested(List<CommandLine>, PrintStream, PrintStream, CommandLine.Help.ColorScheme) - Static method in class picocli.CommandLine
printSuggestions(CommandLine.ParameterException, PrintStream) - Static method in exception picocli.CommandLine.UnmatchedArgumentException
Returns true and prints suggested solutions to the specified stream if such solutions exist, otherwise returns false.
printSuggestions(CommandLine.ParameterException, PrintWriter) - Static method in exception picocli.CommandLine.UnmatchedArgumentException
Returns true and prints suggested solutions to the specified writer if such solutions exist, otherwise returns false.
printSuggestions(PrintStream) - Method in exception picocli.CommandLine.UnmatchedArgumentException
Returns true and prints suggested solutions to the specified stream if such solutions exist, otherwise returns false.
printSuggestions(PrintWriter) - Method in exception picocli.CommandLine.UnmatchedArgumentException
Returns true and prints suggested solutions to the specified stream if such solutions exist, otherwise returns false.
printVersionHelp(PrintStream) - Method in class picocli.CommandLine
Delegates to CommandLine.printVersionHelp(PrintStream, Help.Ansi) with the ANSI setting of the configured color scheme.
printVersionHelp(PrintStream, CommandLine.Help.Ansi) - Method in class picocli.CommandLine
Prints version information from the CommandLine.Command.version() annotation to the specified PrintStream.
printVersionHelp(PrintStream, CommandLine.Help.Ansi, Object...) - Method in class picocli.CommandLine
Prints version information from the CommandLine.Command.version() annotation to the specified PrintStream.
printVersionHelp(PrintWriter) - Method in class picocli.CommandLine
Delegates to CommandLine.printVersionHelp(PrintWriter, Help.Ansi, Object...) with the ANSI setting of the configured color scheme.
printVersionHelp(PrintWriter, CommandLine.Help.Ansi, Object...) - Method in class picocli.CommandLine
Prints version information from the CommandLine.Command.version() annotation to the specified PrintWriter.
prompt() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the text displayed to the end user for an interactive option or positional parameter when asking for user input.
PropertiesDefaultProvider() - Constructor for class picocli.CommandLine.PropertiesDefaultProvider
Default constructor, used when this default value provider is specified in the annotations:
PropertiesDefaultProvider(Properties) - Constructor for class picocli.CommandLine.PropertiesDefaultProvider
This constructor loads default values from the specified properties object.
PropertiesDefaultProvider(File) - Constructor for class picocli.CommandLine.PropertiesDefaultProvider
This constructor loads default values from the specified properties file.
putValue(int, int, CommandLine.Help.Ansi.Text) - Method in class picocli.CommandLine.Help.TextTable
Writes the specified value into the cell at the specified row and column and returns the last row and column written to.

Q

qualifiedName() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the String to use as the program name in the synopsis line of the help message: this command's name, preceded by the qualified name of the parent command, if any, separated by a space.
qualifiedName(String) - Method in class picocli.CommandLine.Model.CommandSpec
Returns this command's fully qualified name, which is its name, preceded by the qualified name of the parent command, if this command has a parent command.

R

Range(int, int, boolean, boolean, String) - Constructor for class picocli.CommandLine.Range
Constructs a new Range object with the specified parameters.
registerConverter(Class<K>, CommandLine.ITypeConverter<K>) - Method in class picocli.CommandLine
Registers the specified type converter for the specified class.
remove(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.Model.CommandSpec
(INCUBATING) Removes the specified option spec or positional parameter spec from the list of configured arguments to expect.
removePattern(String) - Method in class picocli.CommandLine.RegexTransformer.Builder
Removes the negative replacement and synopsis replacement for the specified regular expression.
removeSubcommand(String) - Method in class picocli.CommandLine.Model.CommandSpec
Removes the subcommand with the specified name or alias from this CommandSpec and returns the CommandLine instance that was associated with the specified name, or null of the specified name was not associated with a subcommand.
render(CommandLine.Model.OptionSpec, CommandLine.Help.IParamLabelRenderer, CommandLine.Help.ColorScheme) - Method in interface picocli.CommandLine.Help.IOptionRenderer
Returns a text representation of the specified option and its parameter(s) if any.
render(CommandLine.Model.PositionalParamSpec, CommandLine.Help.IParamLabelRenderer, CommandLine.Help.ColorScheme) - Method in interface picocli.CommandLine.Help.IParameterRenderer
Returns a text representation of the specified positional parameter.
render(CommandLine.Help) - Method in interface picocli.CommandLine.IHelpSectionRenderer
Renders a section of the usage help, like header heading, header, synopsis heading, synopsis, description heading, description, etc.
renderedDescription() - Method in class picocli.CommandLine.Model.ArgSpec
renderParameterLabel(CommandLine.Model.ArgSpec, CommandLine.Help.Ansi, List<CommandLine.Help.Ansi.IStyle>) - Method in interface picocli.CommandLine.Help.IParamLabelRenderer
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.
required() - Method in class picocli.CommandLine.Model.ArgSpec
Returns whether this is a required option or positional parameter without a default value.
requiredArgs() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the required options and positional parameters in this group; may be empty but not null.
requiredArgs() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the list of required options and positional parameters configured for this command.
requiredOptionMarker() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the character used to prefix required options in the options list.
requiredOptionMarker(char) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the character used to prefix required options in the options list.
resetOriginalStringValues() - Method in class picocli.CommandLine.Model.ArgSpec
Sets the originalStringValues to a new list instance.
resetStringValues() - Method in class picocli.CommandLine.Model.ArgSpec
Sets the stringValues to a new list instance.
resetStyle() - Method in class picocli.CommandLine.Help.ColorScheme
Returns the style that "resets" the style state to neutral.
resourceBundle() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the resource bundle for this command.
resourceBundle(ResourceBundle) - Method in class picocli.CommandLine.Model.CommandSpec
Initializes the resource bundle for this command: sets the UsageMessageSpec.messages to a Messages object created from this command spec and the specified bundle, and then sets the ArgSpec.messages of all options and positional parameters in this command to the same Messages instance.
resourceBundle(CommandLine.Model.Messages) - Static method in class picocli.CommandLine.Model.Messages
Returns the ResourceBundle of the specified Messages object or null if the specified Messages object is null.
resourceBundle() - Method in class picocli.CommandLine.Model.Messages
Returns the ResourceBundle of this object or null.
resourceBundleBaseName() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the resource bundle base name for this command.
resourceBundleBaseName(String) - Method in class picocli.CommandLine.Model.CommandSpec
Initializes the resource bundle for this command: sets the UsageMessageSpec.messages to a Messages object created from this command spec and the specified bundle, and then sets the ArgSpec.messages of all options and positional parameters in this command to the same Messages instance.
resourceBundleBaseName(CommandLine.Model.Messages) - Static method in class picocli.CommandLine.Model.Messages
Returns the ResourceBundle of the specified Messages object or null if the specified Messages object is null.
resourceBundleBaseName() - Method in class picocli.CommandLine.Model.Messages
Returns the base name of the ResourceBundle of this object or null.
returnResultOrExit(R) - Method in class picocli.CommandLine.AbstractHandler
Deprecated.
Convenience method for subclasses that returns the specified result object if no exit code was set, or otherwise, if an exit code was set, calls System.exit with the configured exit code to terminate the currently running Java virtual machine.
richStackTraceString(Throwable) - Method in class picocli.CommandLine.Help.ColorScheme
Returns a String with the error styles applied to the stack trace lines showing the throwable class name and error message (including "Caused by:..." lines), and the stack trace styles applied to the remaining stack trace of lines the specified Throwable.
root() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the root option or positional parameter (on the parent command), if this option or positional parameter was inherited; or null if it was not.
root() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the root command: the top-level command of the hierarchy, never null.
row - Variable in class picocli.CommandLine.Help.TextTable.Cell
Table row index (zero based).
rowCount() - Method in class picocli.CommandLine.Help.TextTable
Returns the current number of rows of this TextTable.
run() - Method in class picocli.AutoComplete.GenerateCompletion
 
run() - Method in class picocli.CommandLine.HelpCommand
Invokes usage for the specified command, or for the parent command.
run(R, String...) - Static method in class picocli.CommandLine
Deprecated.
run(R, PrintStream, String...) - Static method in class picocli.CommandLine
Deprecated.
run(R, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
Deprecated.
run(R, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
Deprecated.
run(Class<R>, CommandLine.IFactory, String...) - Static method in class picocli.CommandLine
Deprecated.
run(Class<R>, CommandLine.IFactory, PrintStream, String...) - Static method in class picocli.CommandLine
Deprecated.
run(Class<R>, CommandLine.IFactory, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
Deprecated.
run(Class<R>, CommandLine.IFactory, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
Deprecated.
RunAll() - Constructor for class picocli.CommandLine.RunAll
 
RunFirst() - Constructor for class picocli.CommandLine.RunFirst
 
RunLast() - Constructor for class picocli.CommandLine.RunLast
 

S

scope() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the CommandLine.Model.IScope that determines where the setter sets the value (or the getter gets the value) of the annotated program element associated with this group.
scope(CommandLine.Model.IScope) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets the CommandLine.Model.IScope that targets where the setter sets the value of the annotated program element associated with this group, and returns this builder.
scope() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the CommandLine.Model.IScope that determines where the setter sets the value (or the getter gets the value) of the annotated program element associated with this group.
scope() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the binding CommandLine.Model.IScope that determines on which object to set the value (or from which object to get the value) of this argument.
scope() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
scopeType() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the scope of this argument; is it local, or inherited (it applies to this command as well as all sub- and sub-subcommands).
scopeType() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the scope of this argument; is it local, or inherited (it applies to this command as well as all sub- and sub-subcommands).
scopeType(CommandLine.ScopeType) - Method in class picocli.CommandLine.Model.CommandSpec
Sets the scope of where this argument applies: only this command, or also all sub (and sub-sub) commands, and returns this builder.
SECTION_KEY_AT_FILE_PARAMETER - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the @-file parameter list section.
SECTION_KEY_COMMAND_LIST - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Subcommand List section.
SECTION_KEY_COMMAND_LIST_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Subcommand List Heading section.
SECTION_KEY_DESCRIPTION - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Description section.
SECTION_KEY_DESCRIPTION_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Description Heading section.
SECTION_KEY_END_OF_OPTIONS - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the -- End of Options list section.
SECTION_KEY_EXIT_CODE_LIST - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Exit Code List section.
SECTION_KEY_EXIT_CODE_LIST_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Exit Code List Heading section.
SECTION_KEY_FOOTER - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Footer section.
SECTION_KEY_FOOTER_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Footer Heading section.
SECTION_KEY_HEADER - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Header section.
SECTION_KEY_HEADER_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Header Heading section.
SECTION_KEY_OPTION_LIST - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Option List section.
SECTION_KEY_OPTION_LIST_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Option List Heading section.
SECTION_KEY_PARAMETER_LIST - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Parameter List section.
SECTION_KEY_PARAMETER_LIST_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Parameter List Heading section.
SECTION_KEY_SYNOPSIS - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Synopsis section.
SECTION_KEY_SYNOPSIS_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Synopsis Heading section.
sectionKeys() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the section keys in the order that the usage help message should render the sections.
sectionKeys(List<String>) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the section keys in the order that the usage help message should render the sections.
sectionMap() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the map of section keys and renderers used to construct the usage help message.
sectionMap(Map<String, CommandLine.IHelpSectionRenderer>) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the map of section keys and renderers used to construct the usage help message to a copy of the specified map.
self() - Method in class picocli.CommandLine.AbstractHandler
Deprecated.
Returns this to allow method chaining when calling the setters for a fluent API.
self() - Method in class picocli.CommandLine.DefaultExceptionHandler
Deprecated.
 
self() - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Returns this builder.
self() - Method in class picocli.CommandLine.Model.PositionalParamSpec.Builder
Returns this builder.
self() - Method in class picocli.CommandLine.RunAll
 
self() - Method in class picocli.CommandLine.RunFirst
 
self() - Method in class picocli.CommandLine.RunLast
 
separator() - Method in interface picocli.CommandLine.Help.IParamLabelRenderer
Returns the separator between option name and param label.
separator() - Method in class picocli.CommandLine.Model.ParserSpec
Returns the String to use as the separator between options and option parameters.
separator(String) - Method in class picocli.CommandLine.Model.ParserSpec
Sets the String to use as the separator between options and option parameters.
set(T) - Method in interface picocli.CommandLine.Model.ISetter
Sets the new value of the option or positional parameter.
setAbbreviatedOptionsAllowed(boolean) - Method in class picocli.CommandLine
Sets whether abbreviated option names should be matched.
setAbbreviatedSubcommandsAllowed(boolean) - Method in class picocli.CommandLine
Sets whether abbreviated subcommands should be matched.
setAccessible(boolean) - Method in class picocli.CommandLine.Model.MethodParam
 
setAddMethodSubcommands(Boolean) - Method in class picocli.CommandLine.Model.CommandSpec
Sets whether method commands should be added as subcommands.
setAdjustLineBreaksForWideCJKCharacters(boolean) - Method in class picocli.CommandLine.Help.TextTable
 
setAdjustLineBreaksForWideCJKCharacters(boolean) - Method in class picocli.CommandLine
Sets whether line breaks should take wide Chinese, Japanese and Korean characters into account, and returns this UsageMessageSpec.
setAllowOptionsAsOptionParameters(boolean) - Method in class picocli.CommandLine
Sets whether options can have parameter values that match the name of an option in this command, or whether such values should be rejected with a missing parameter exception.
setAllowSubcommandsAsOptionParameters(boolean) - Method in class picocli.CommandLine
Sets whether options can have parameter values that match subcommand names or aliases, or whether such values should be rejected with a missing parameter exception.
setAtFileCommentChar(Character) - Method in class picocli.CommandLine
Sets the character that starts a single-line comment or null if all content of argument files should be interpreted as arguments (without comments).
setCaseInsensitiveEnumValuesAllowed(boolean) - Method in class picocli.CommandLine
Sets whether the parser should ignore case when converting arguments to enum values.
setColorScheme(CommandLine.Help.ColorScheme) - Method in class picocli.CommandLine
Sets the color scheme to use when printing help.
setCommandName(String) - Method in class picocli.CommandLine
Sets the command name (also called program name) displayed in the usage help synopsis to the specified value.
setDefaultValueProvider(CommandLine.IDefaultValueProvider) - Method in class picocli.CommandLine
Sets a default value provider for the command and sub-commands
setEndOfOptionsDelimiter(String) - Method in class picocli.CommandLine
Sets the end-of-options delimiter that signals that the remaining command line arguments should be treated as positional parameters.
setErr(PrintWriter) - Method in class picocli.CommandLine
Sets the writer to use when printing diagnostic (error) messages during command execution.
setExecutionExceptionHandler(CommandLine.IExecutionExceptionHandler) - Method in class picocli.CommandLine
Sets a custom handler for dealing with exceptions that occurred in the Callable, Runnable or Method user object of a command when the command was executed via the execute method.
setExecutionResult(Object) - Method in class picocli.CommandLine
Sets the result of calling the business logic on the command's user object.
setExecutionStrategy(CommandLine.IExecutionStrategy) - Method in class picocli.CommandLine
Sets the execution strategy that the execute method should use to invoke the business logic on the user objects of this command and/or the user-specified subcommand(s).
setExitCodeExceptionMapper(CommandLine.IExitCodeExceptionMapper) - Method in class picocli.CommandLine
Sets the mapper used by the execute method to map exceptions to exit codes.
setExpandAtFiles(boolean) - Method in class picocli.CommandLine
Sets whether arguments starting with '@' should be treated as the path to an argument file and its contents should be expanded into separate arguments for each line in the specified file.
setHelpFactory(CommandLine.IHelpFactory) - Method in class picocli.CommandLine
Sets a new IHelpFactory to customize the usage help message.
setHelpSectionKeys(List<String>) - Method in class picocli.CommandLine
Sets the section keys in the order that the usage help message should render the sections.
setHelpSectionMap(Map<String, CommandLine.IHelpSectionRenderer>) - Method in class picocli.CommandLine
Sets the map of section keys and renderers used to construct the usage help message.
setInterpolateVariables(boolean) - Method in class picocli.CommandLine
Sets whether variables should be interpolated in String values.
setLevel(CommandLine.TraceLevel) - Method in class picocli.CommandLine.Tracer
Sets the trace level that needs to be matched or exceeded for internal tracing statements to be printed.
setLoadBundles(boolean) - Static method in class picocli.CommandLine.Model.Messages
During annotation processing, resource bundles may not be available on the classpath and thereby cause failures.
setNegatableOptionTransformer(CommandLine.INegatableOptionTransformer) - Method in class picocli.CommandLine
Sets the INegatableOptionTransformer used to create the negative form of negatable options.
setOptionsCaseInsensitive(boolean) - Method in class picocli.CommandLine
Sets whether upper case and lower case should be ignored when matching option names.
setOut(PrintWriter) - Method in class picocli.CommandLine
Sets the writer to use when printing user-requested usage help or version help during command execution.
setOverwrittenOptionsAllowed(boolean) - Method in class picocli.CommandLine
Sets whether options for single-value fields can be specified multiple times on the command line without a CommandLine.OverwrittenOptionException being thrown.
setParameterExceptionHandler(CommandLine.IParameterExceptionHandler) - Method in class picocli.CommandLine
Sets the handler for dealing with invalid user input when the command is executed.
setPosixClusteredShortOptionsAllowed(boolean) - Method in class picocli.CommandLine
Sets whether short options like -x -v -f SomeFile can be clustered together like -xvfSomeFile.
setResourceBundle(ResourceBundle) - Method in class picocli.CommandLine
Sets the ResourceBundle containing usage help message strings.
setSeparator(String) - Method in class picocli.CommandLine
Sets the String the parser uses to separate option names from option values to the specified value.
setSplitQuotedStrings(boolean) - Method in class picocli.CommandLine
Deprecated.
Most applications should not change the default. The rare application that does need to split parameter values without respecting quotes should use CommandLine.Model.ParserSpec.splitQuotedStrings(boolean).
setStopAtPositional(boolean) - Method in class picocli.CommandLine
Sets whether the parser interprets the first positional parameter as "end of options" so the remaining arguments are all treated as positional parameters.
setStopAtUnmatched(boolean) - Method in class picocli.CommandLine
Sets whether the parser should stop interpreting options and positional parameters as soon as it encounters an unmatched option.
setSubcommandsCaseInsensitive(boolean) - Method in class picocli.CommandLine
Sets whether upper case and lower case should be ignored when matching subcommands.
setter() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the CommandLine.Model.ISetter that is responsible for modifying the value of the annotated program element associated with this group.
setter(CommandLine.Model.ISetter) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets the CommandLine.Model.ISetter that is responsible for modifying the value of the annotated program element associated with this group, and returns this builder.
setter() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the CommandLine.Model.ISetter that is responsible for modifying the value of the annotated program element associated with this group.
setter() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the CommandLine.Model.ISetter that is responsible for modifying the value of this argument.
setter() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
setter() - Method in class picocli.CommandLine.Model.UnmatchedArgsBinding
Returns the setter responsible for consuming the unmatched arguments.
setToggleBooleanFlags(boolean) - Method in class picocli.CommandLine
Sets whether the value of boolean flag options should be "toggled" when the option is matched.
setTrimQuotes(boolean) - Method in class picocli.CommandLine
Sets whether the parser should trim quotes from command line arguments before processing them.
setUnmatchedArgumentsAllowed(boolean) - Method in class picocli.CommandLine
Sets whether the end user may specify unmatched arguments on the command line without a CommandLine.UnmatchedArgumentException being thrown.
setUnmatchedOptionsAllowedAsOptionParameters(boolean) - Method in class picocli.CommandLine
Sets whether options can have parameter values that resemble an option, or whether such values should be rejected as unknown options.
setUnmatchedOptionsArePositionalParams(boolean) - Method in class picocli.CommandLine
Sets whether arguments on the command line that resemble an option should be treated as positional parameters.
setUsageHelpAutoWidth(boolean) - Method in class picocli.CommandLine
Sets whether picocli should attempt to detect the terminal size and adjust the usage help message width to take the full terminal width.
setUsageHelpLongOptionsMaxWidth(int) - Method in class picocli.CommandLine
Returns the maximum usage help long options column max width to the specified value.
setUsageHelpWidth(int) - Method in class picocli.CommandLine
Sets the maximum width of the usage help message.
setUseSimplifiedAtFiles(boolean) - Method in class picocli.CommandLine
Sets whether to use a simplified argument file format that is compatible with JCommander.
setValue(T) - Method in class picocli.CommandLine.Model.ArgSpec
Sets the value of this argument to the specified value and returns the previous value.
setValue(T, CommandLine) - Method in class picocli.CommandLine.Model.ArgSpec
Deprecated.
use CommandLine.Model.ArgSpec.setValue(Object) instead. This was a design mistake.
shortestFirst() - Static method in class picocli.CommandLine.Help
Sorts short strings before longer strings.
shortestName() - Method in class picocli.CommandLine.Model.OptionSpec
Returns the shortest option name.
showAtFileInUsageHelp() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets whether to show a [@<filename>...] entry in the synopsis and parameter list of the usage help message.
showAtFileInUsageHelp(boolean) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets whether to show a [@<filename>...] entry in the synopsis and parameter list of the usage help message.
showDefaultValue() - Method in class picocli.CommandLine.Model.ArgSpec
Returns whether this option or positional parameter's default value should be shown in the usage help.
showDefaultValues() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns whether the options list in the usage help message should show default values for all non-boolean options.
showDefaultValues(boolean) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets whether the options list in the usage help message should show default values for all non-boolean options.
showEndOfOptionsDelimiterInUsageHelp() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets whether to show a [--] (End of Options) entry in the synopsis and options list of the usage help message.
showEndOfOptionsDelimiterInUsageHelp(boolean) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets whether to show a [--] (End of Options) entry in the synopsis and options list of the usage help message.
SOFTWARE - Static variable in class picocli.CommandLine.ExitCode
Return value from the execute method signifying internal software error: an exception occurred when invoking the Runnable, Callable or Method user object of a command.
sortOptions() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns whether the options list in the usage help message should be sorted alphabetically.
sortOptions(boolean) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets whether the options list in the usage help message should be sorted alphabetically.
sortSynopsis() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns whether the options in the synopsis should be sorted alphabetically.
sortSynopsis(boolean) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets whether the options in the synopsis should be sorted alphabetically.
specElements() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the list of program elements annotated with {@literal @}Spec configured for this group.
specElements() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the list of program elements annotated with {@literal @}Spec configured for this group.
specElements() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the list of program elements annotated with {@literal @}Spec configured for this command.
splitLines() - Method in class picocli.CommandLine.Help.Ansi.Text
 
splitQuotedStrings() - Method in class picocli.CommandLine.Model.ParserSpec
 
splitQuotedStrings(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
splitRegex() - Method in class picocli.CommandLine.Model.ArgSpec
Returns a regular expression to split option parameter values or "" if the value should not be split.
splitRegexSynopsisLabel() - Method in class picocli.CommandLine.Model.ArgSpec
Returns a regular expression to split option parameter for usage information.
stackTraces(CommandLine.Help.Ansi.IStyle...) - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Adds the specified styles to the registered styles for stack traces in this color scheme builder and returns this builder.
stackTraceStyles() - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Returns the registered styles for stack traces in this color scheme builder.
stackTraceStyles() - Method in class picocli.CommandLine.Help.ColorScheme
Returns the registered styles for stack traces in this color scheme.
stackTraceText(String) - Method in class picocli.CommandLine.Help.ColorScheme
Returns a Text with all stackTrace styles applied to all lines in the specified stackTrace string.
stackTraceText(Throwable) - Method in class picocli.CommandLine.Help.ColorScheme
Returns a Text with all stackTrace styles applied to all lines in the stack trace of the specified Throwable.
stopAtPositional() - Method in class picocli.CommandLine.Model.ParserSpec
 
stopAtPositional(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
stopAtUnmatched() - Method in class picocli.CommandLine.Model.ParserSpec
 
stopAtUnmatched(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
string(String) - Method in enum picocli.CommandLine.Help.Ansi
Returns a String where any markup like @|bg(red),white,underline some text|@ is converted to ANSI escape codes if this Ansi is ON, or suppressed if this Ansi is OFF.
string(String) - Method in class picocli.CommandLine.Help.ColorScheme
Returns a String where any markup like @|bg(red),white,underline some text|@ is converted to the styles defined in this ColorScheme (if its Ansi mode is ON), or to the plain text without the markup (if this ColorScheme's Ansi mode is OFF).
stringValues() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the untyped command line arguments matched by this option or positional parameter spec.
subcommand(CommandLine.ParseResult) - Method in class picocli.CommandLine.ParseResult.Builder
Sets the specified ParseResult for a subcommand that was matched on the command line.
subcommand() - Method in class picocli.CommandLine.ParseResult
Returns the ParseResult for the last subcommand of this command that was matched on the command line, or null if no subcommand was matched.
subcommands() - Method in class picocli.CommandLine.Help
Returns the map of non-hidden subcommand Help instances for this command Help.
subcommands() - Method in class picocli.CommandLine.Model.CommandSpec
Returns a read-only view of the subcommand map.
subcommands() - Method in class picocli.CommandLine.ParseResult
Returns a list with the ParseResult objects for each subcommand of this command that was matched on the command line or an empty list if no subcommands were matched.
subcommandsCaseInsensitive() - Method in class picocli.CommandLine.Model.CommandSpec
Returns whether the subcommands are case-insensitive.
subcommandsCaseInsensitive(boolean) - Method in class picocli.CommandLine.Model.CommandSpec
Sets the case-insensitivity of subcommands.
subcommandsRepeatable() - Method in class picocli.CommandLine.Model.CommandSpec
Returns whether the subcommands of this command are repeatable, that is, whether such subcommands can occur multiple times and may be followed by sibling commands instead of just child commands.
subcommandsRepeatable(boolean) - Method in class picocli.CommandLine.Model.CommandSpec
Sets whether the subcommands of this command are repeatable, that is, whether such subcommands can occur multiple times and may be followed by sibling commands instead of just child commands.
subgroups() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the list of subgroups that this group is composed of.
subgroups() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Return the subgroups that this group is composed of; may be empty but not null.
substring(int) - Method in class picocli.CommandLine.Help.Ansi.Text
Returns a new Text instance that is a substring of this Text.
substring(int, int) - Method in class picocli.CommandLine.Help.Ansi.Text
Returns a new Text instance that is a substring of this Text.
synopsis() - Method in class picocli.CommandLine.Help
Deprecated.
synopsis(int) - Method in class picocli.CommandLine.Help
Returns a synopsis for the command, reserving the specified space for the synopsis heading.
synopsis() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the synopsis of this group.
synopsisAutoIndentThreshold() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the fraction of the usage help CommandLine.Model.UsageMessageSpec.width() that is the threshold up to which the 2nd line and subsequent lines of a multi-line synopsis should be aligned to the end of the command name.
synopsisAutoIndentThreshold(double) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the fraction of the usage help CommandLine.Model.UsageMessageSpec.width() that is the threshold up to which the 2nd line and subsequent lines of a multi-line synopsis should be aligned to the end of the command name.
synopsisHeading(Object...) - Method in class picocli.CommandLine.Help
Returns the text displayed before the synopsis text; the result of String.format(synopsisHeading, params).
synopsisHeading() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional heading preceding the synopsis.
synopsisHeading(String) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the optional heading preceding the synopsis.
synopsisHeadingLength() - Method in class picocli.CommandLine.Help
Returns the number of characters the synopsis heading will take on the same line as the synopsis.
synopsisIndent() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the indentation to use on the 2nd line and subsequent lines of a multi-line synopsis when the length of the synopsis heading and the fully qualified command name exceed the CommandLine.Model.UsageMessageSpec.width() times the CommandLine.Model.UsageMessageSpec.synopsisAutoIndentThreshold(), -1 by default.
synopsisIndent(int) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the indentation to use on the 2nd line and subsequent lines of a multi-line synopsis when the length of the synopsis heading and the fully qualified command name exceed the CommandLine.Model.UsageMessageSpec.synopsisAutoIndentThreshold() fraction of the CommandLine.Model.UsageMessageSpec.width(), -1 by default.
synopsisSubcommandLabel() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the String representing the subcommands in the synopsis.
synopsisSubcommandLabel(String) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the String representing the subcommands in the synopsis.
synopsisText(CommandLine.Help.ColorScheme, Set<CommandLine.Model.ArgSpec>) - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the synopsis of this group.

T

table - Variable in class picocli.CommandLine.Help.Layout
 
text(String) - Method in enum picocli.CommandLine.Help.Ansi
Returns a new Text object for this Ansi mode, encapsulating the specified string which may contain markup like @|bg(red),white,underline some text|@.
Text(int) - Constructor for class picocli.CommandLine.Help.Ansi.Text
Constructs a Text with the specified max length (for use in a TextTable Column).
Text(int, CommandLine.Help.ColorScheme) - Constructor for class picocli.CommandLine.Help.Ansi.Text
Constructs a Text with the specified max length (for use in a TextTable Column).
Text(CommandLine.Help.Ansi.Text) - Constructor for class picocli.CommandLine.Help.Ansi.Text
Copy constructor.
Text(String) - Constructor for class picocli.CommandLine.Help.Ansi.Text
Constructs a Text with the specified String, which may contain markup like @|bg(red),white,underline some text|@.
Text(String, CommandLine.Help.ColorScheme) - Constructor for class picocli.CommandLine.Help.Ansi.Text
Constructs a Text with the specified String (which may contain markup), and ColorScheme.
text(String) - Method in class picocli.CommandLine.Help.ColorScheme
Returns a new Text object for this ColorScheme, encapsulating the specified string which may contain markup like @|bg(red),white,underline some text|@.
textAt(int, int) - Method in class picocli.CommandLine.Help.TextTable
Returns the Text slot at the specified row and column to write a text value into.
textTable() - Method in class picocli.CommandLine.Help.Layout
Returns the TextTable used in this layout.
TextTable(CommandLine.Help.Ansi, CommandLine.Help.Column[]) - Constructor for class picocli.CommandLine.Help.TextTable
Deprecated.
use picocli.CommandLine.Help.TextTable#TextTable(picocli.CommandLine.Help.ColorScheme, picocli.CommandLine.Help.Column[]) instead
TextTable(CommandLine.Help.ColorScheme, CommandLine.Help.Column[]) - Constructor for class picocli.CommandLine.Help.TextTable
 
throwOrExit(CommandLine.ExecutionException) - Method in class picocli.CommandLine.AbstractHandler
Deprecated.
Convenience method for subclasses that throws the specified ExecutionException if no exit code was set, or otherwise, if an exit code was set, prints the stacktrace of the specified exception to the diagnostic error stream and calls System.exit with the configured exit code to terminate the currently running Java virtual machine.
toBuilder() - Method in class picocli.CommandLine.Model.OptionSpec
Returns a new Builder initialized with the attributes from this OptionSpec.
toBuilder() - Method in class picocli.CommandLine.Model.PositionalParamSpec
Returns a new Builder initialized with the attributes from this PositionalParamSpec.
toggleBooleanFlags() - Method in class picocli.CommandLine.Model.ParserSpec
 
toggleBooleanFlags(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
toString() - Method in class picocli.CommandLine.Help.Ansi.Text
Returns a String representation of the text with ANSI escape codes embedded, unless ANSI is CommandLine.Help.Ansi.enabled() not enabled}, in which case the plain text is returned.
toString() - Method in class picocli.CommandLine.Help.ColorScheme
 
toString() - Method in class picocli.CommandLine.Help.Column
 
toString() - Method in class picocli.CommandLine.Help.Layout
Returns the section of the usage help message accumulated in the TextTable owned by this layout.
toString(StringBuilder) - Method in class picocli.CommandLine.Help.TextTable
Copies the text representation that we built up from the options into the specified StringBuilder.
toString() - Method in class picocli.CommandLine.Help.TextTable
 
toString() - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
toString - Variable in class picocli.CommandLine.Model.ArgSpec
 
toString() - Method in class picocli.CommandLine.Model.ArgSpec
Returns a string respresentation of this option or positional parameter.
toString() - Method in class picocli.CommandLine.Model.CommandSpec
Returns a string representation of this command, used in error messages and trace messages.
toString() - Method in class picocli.CommandLine.Model.MethodParam
 
toString() - Method in class picocli.CommandLine.Model.ParserSpec
 
toString() - Method in class picocli.CommandLine.ParseResult.GroupMatch
 
toString() - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
toString() - Method in class picocli.CommandLine.PropertiesDefaultProvider
 
toString() - Method in class picocli.CommandLine.Range
 
toString() - Method in class picocli.CommandLine.RegexTransformer
 
toString() - Method in class picocli.CommandLine.Tracer
 
tracer() - Static method in class picocli.CommandLine
Returns the Tracer used internally for printing internal debug statements.
transform(CommandLine.Model.CommandSpec) - Method in interface picocli.CommandLine.IModelTransformer
Given an original CommandSpec, return the object that should be used instead.
trimQuotes() - Method in class picocli.CommandLine.Model.ParserSpec
 
trimQuotes(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
type() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the type to convert the option or positional parameter to before setting the value.
TypeConversionException(String) - Constructor for exception picocli.CommandLine.TypeConversionException
Constructs a TypeConversionException.
typedValues() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the typed command line arguments matched by this option or positional parameter spec.
typeInfo() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the type info for the annotated program element associated with this group.
typeInfo(CommandLine.Model.ITypeInfo) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets the type info for the annotated program element associated with this group, and returns this builder.
typeInfo() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the type info for the annotated program element associated with this group.
typeInfo - Variable in class picocli.CommandLine.Model.ArgSpec
 
typeInfo() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the ITypeInfo that can be used both at compile time (by annotation processors) and at runtime.

U

unmatched() - Method in class picocli.CommandLine.ParseResult
Returns a list of command line arguments that did not match any options or positional parameters.
unmatchedArgsBindings() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the list of UnmatchedArgumentsBindings configured for this command; each UnmatchedArgsBinding captures the arguments that could not be matched to any options or positional parameters.
UnmatchedArgumentException(CommandLine, String) - Constructor for exception picocli.CommandLine.UnmatchedArgumentException
 
UnmatchedArgumentException(CommandLine, Stack<String>) - Constructor for exception picocli.CommandLine.UnmatchedArgumentException
 
UnmatchedArgumentException(CommandLine, List<String>) - Constructor for exception picocli.CommandLine.UnmatchedArgumentException
 
UnmatchedArgumentException(CommandLine, List<String>, String) - Constructor for exception picocli.CommandLine.UnmatchedArgumentException
 
unmatchedArgumentsAllowed() - Method in class picocli.CommandLine.Model.ParserSpec
 
unmatchedArgumentsAllowed(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
unmatchedOptionsAllowedAsOptionParameters() - Method in class picocli.CommandLine.Model.ParserSpec
 
unmatchedOptionsAllowedAsOptionParameters(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
unmatchedOptionsArePositionalParams() - Method in class picocli.CommandLine.Model.ParserSpec
 
unmatchedOptionsArePositionalParams(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
unspecified(boolean) - Method in class picocli.CommandLine.Range
Returns a new Range object with the isUnspecified value replaced by the specified value.
updateArgGroupAttributes(CommandLine.ArgGroup) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Updates this builder from the specified annotation values.
updateCommandAttributes(CommandLine.Command, CommandLine.IFactory) - Method in class picocli.CommandLine.Model.CommandSpec
Updates the following attributes from the specified @Command annotation: aliases, parser separator, command name, version, help command, version provider, default provider and usage message spec.
USAGE - Static variable in class picocli.CommandLine.ExitCode
Return value from the execute method signifying command line usage error: user input for the command was incorrect, e.g., the wrong number of arguments, a bad flag, a bad syntax in a parameter, or whatever.
usage(Object, PrintStream) - Static method in class picocli.CommandLine
Equivalent to new CommandLine(command).usage(out).
usage(Object, PrintStream, CommandLine.Help.Ansi) - Static method in class picocli.CommandLine
Equivalent to new CommandLine(command).usage(out, ansi).
usage(Object, PrintStream, CommandLine.Help.ColorScheme) - Static method in class picocli.CommandLine
Equivalent to new CommandLine(command).usage(out, colorScheme).
usage(PrintStream) - Method in class picocli.CommandLine
usage(PrintWriter) - Method in class picocli.CommandLine
usage(PrintStream, CommandLine.Help.Ansi) - Method in class picocli.CommandLine
usage(PrintWriter, CommandLine.Help.Ansi) - Method in class picocli.CommandLine
Similar to CommandLine.usage(PrintStream, Help.Ansi) but with the specified PrintWriter instead of a PrintStream.
usage(PrintStream, CommandLine.Help.ColorScheme) - Method in class picocli.CommandLine
Prints a usage help message for the annotated command class to the specified PrintStream.
usage(PrintWriter, CommandLine.Help.ColorScheme) - Method in class picocli.CommandLine
Similar to CommandLine.usage(PrintStream, Help.ColorScheme), but with the specified PrintWriter instead of a PrintStream.
usageHelp() - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Returns whether this option allows the user to request usage help.
usageHelp(boolean) - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Sets whether this option allows the user to request usage help, and returns this builder.
usageHelp() - Method in class picocli.CommandLine.Model.OptionSpec
Returns whether this option allows the user to request usage help.
usageMessage() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the usage help message specification for this command.
usageMessage(CommandLine.Model.UsageMessageSpec) - Method in class picocli.CommandLine.Model.CommandSpec
Initializes the usageMessage specification for this command from the specified settings and returns this commandSpec.
UsageMessageSpec() - Constructor for class picocli.CommandLine.Model.UsageMessageSpec
 
useAnsi(CommandLine.Help.Ansi) - Method in class picocli.CommandLine.AbstractHandler
UseDefaultConverter() - Constructor for class picocli.CommandLine.UseDefaultConverter
 
useErr(PrintStream) - Method in class picocli.CommandLine.AbstractHandler
useOut(PrintStream) - Method in class picocli.CommandLine.AbstractHandler
userObject() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the user object associated with this option or positional parameters.
userObject() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the user object associated with this command.
userObject() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
useSimplifiedAtFiles() - Method in class picocli.CommandLine.Model.ParserSpec
 
useSimplifiedAtFiles(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 

V

validate() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns whether picocli should validate the rules of this group: for a mutually exclusive group this means that no more than one arguments in the group is specified on the command line; for a co-occurring group this means that all arguments in the group are specified on the command line.
validate(boolean) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets whether picocli should validate the rules of this group: for a mutually exclusive group this means that no more than one arguments in the group is specified on the command line; for a co-occurring group this means that all arguments in the group are specified on the command line.
validate() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns whether picocli should validate the rules of this group: for a mutually exclusive group this means that no more than one arguments in the group is specified on the command line; for a co-occurring group this means that all arguments in the group are specified on the command line.
valueIsDefaultValue - Variable in class picocli.CommandLine.Model.ArgSpec
 
valueOf(String) - Static method in enum picocli.CommandLine.Help.Ansi.Style
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum picocli.CommandLine.Help.Ansi
Returns the enum constant of this type with the specified name.
valueOf(boolean) - Static method in enum picocli.CommandLine.Help.Ansi
Returns Ansi.ON if the specified enabled flag is true, Ansi.OFF otherwise.
valueOf(String) - Static method in enum picocli.CommandLine.Help.Column.Overflow
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum picocli.CommandLine.Help.Visibility
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in class picocli.CommandLine.Range
Leniently parses the specified String as a Range value and return the result.
valueOf(String) - Static method in enum picocli.CommandLine.ScopeType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum picocli.CommandLine.Spec.Target
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum picocli.CommandLine.TraceLevel
Returns the enum constant of this type with the specified name.
values() - Static method in enum picocli.CommandLine.Help.Ansi.Style
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum picocli.CommandLine.Help.Ansi
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum picocli.CommandLine.Help.Column.Overflow
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum picocli.CommandLine.Help.Visibility
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum picocli.CommandLine.ScopeType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum picocli.CommandLine.Spec.Target
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum picocli.CommandLine.TraceLevel
Returns an array containing the constants of this enum type, in the order they are declared.
version() - Method in class picocli.CommandLine.Model.CommandSpec
Returns version information for this command, to print to the console when the user specifies an option to request version help.
version(String...) - Method in class picocli.CommandLine.Model.CommandSpec
Sets version information literals for this command, to print to the console when the user specifies an option to request version help.
VERSION - Static variable in class picocli.CommandLine
This is picocli version "4.7.6".
versionHelp() - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Returns whether this option allows the user to request version information.
versionHelp(boolean) - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Sets whether this option allows the user to request version information, and returns this builder.
versionHelp() - Method in class picocli.CommandLine.Model.OptionSpec
Returns whether this option allows the user to request version information.
versionProvider() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the version provider for this command, to generate the CommandLine.Model.CommandSpec.version() strings.
versionProvider(CommandLine.IVersionProvider) - Method in class picocli.CommandLine.Model.CommandSpec
Sets version provider for this command, to generate the CommandLine.Model.CommandSpec.version() strings.

W

warn(String, Object...) - Method in class picocli.CommandLine.Tracer
Prints the specified message if the current trace level is WARN or higher.
width - Variable in class picocli.CommandLine.Help.Column
Column width in characters
width(int) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the maximum usage help message width to the specified value.
width() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the maximum usage help message width.
withToString(String) - Method in class picocli.CommandLine.Model.CommandSpec
Sets the string representation of this command, used in error messages and trace messages.
wrapWithoutInspection(Object) - Static method in class picocli.CommandLine.Model.CommandSpec
Creates and returns a new CommandSpec with the specified associated user object.
wrapWithoutInspection(Object, CommandLine.IFactory) - Static method in class picocli.CommandLine.Model.CommandSpec
Creates and returns a new CommandSpec with the specified associated user object.
A B C D E F G H I J K L M N O P Q R S T U V W 
Skip navigation links