Index (picocli 3.6.0 API)

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

A

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
AbstractParseResultHandler() - Constructor for class picocli.CommandLine.AbstractParseResultHandler
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.
addAllSubcommands(Map<String, CommandLine>) - Method in class picocli.CommandLine.Help: Registers all specified subcommands with this Help.
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.
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) - 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: Calls CommandLine.Help.Layout.addOption(CommandLine.Model.OptionSpec, CommandLine.Help.IParamLabelRenderer) for all non-hidden Options in the list.
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: Calls CommandLine.Help.Layout.addPositionalParameter(CommandLine.Model.PositionalParamSpec, CommandLine.Help.IParamLabelRenderer) for all non-hidden Parameters in the list.
addRowValues(String...) - Method in class picocli.CommandLine.Help.TextTable: Delegates to CommandLine.Help.TextTable.addRowValues(CommandLine.Help.Ansi.Text...).
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.
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: Deprecated.
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.
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.
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.
andExit(int) - Method in class picocli.CommandLine.AbstractHandler: Indicates that the handler should call System.exit(int) after processing completes and sets the exit code to use as the termination status.
ansi() - Method in class picocli.CommandLine.AbstractHandler: Returns the ANSI style to use.
ansi() - Method in class picocli.CommandLine.Help: Returns whether ANSI escape codes are enabled or not.
ansi() - Method in class picocli.CommandLine.Help.ColorScheme
append(String) - Method in class picocli.CommandLine.Help.Ansi.Text: Deprecated.
use CommandLine.Help.Ansi.Text.concat(String) instead
append(CommandLine.Help.Ansi.Text) - Method in class picocli.CommandLine.Help.Ansi.Text: Deprecated.
use #concat(Text) instead
apply(String, List<CommandLine.Help.Ansi.IStyle>) - Method in enum picocli.CommandLine.Help.Ansi: 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: Replaces colors and styles in this scheme with ones specified in system properties, and returns this scheme.
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.
atFileCommentChar() - Method in class picocli.CommandLine.Model.ParserSpec
atFileCommentChar(Character) - Method in class picocli.CommandLine.Model.ParserSpec
AutoComplete - Class in picocli: Stand-alone tool that generates bash auto-complete scripts for picocli-based command line applications.
auxiliaryTypes() - Method in class picocli.CommandLine.Model.ArgSpec: Returns auxiliary type information used when the CommandLine.Model.ArgSpec.type() is a generic Collection, Map or an abstract class.

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.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.
builder(String, String...) - Static method in class picocli.CommandLine.Model.OptionSpec
builder(String[]) - Static method in class picocli.CommandLine.Model.OptionSpec
builder() - 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.

C

call(C, String...) - Static method in class picocli.CommandLine: Delegates to CommandLine.call(Callable, PrintStream, PrintStream, Help.Ansi, String...) with System.out for requested usage help messages, System.err for diagnostic error messages, and CommandLine.Help.Ansi.AUTO.
call(C, PrintStream, String...) - Static method in class picocli.CommandLine: Delegates to CommandLine.call(Callable, PrintStream, PrintStream, Help.Ansi, String...) with System.err for diagnostic error messages and CommandLine.Help.Ansi.AUTO.
call(C, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine: Delegates to CommandLine.call(Callable, PrintStream, PrintStream, Help.Ansi, String...) with System.err for diagnostic error messages.
call(C, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine: Convenience method to allow command line application authors to avoid some boilerplate code in their application.
call(Class<C>, CommandLine.IFactory, String...) - Static method in class picocli.CommandLine: Delegates to CommandLine.call(Class, IFactory, PrintStream, PrintStream, Help.Ansi, String...) with System.out for requested usage help messages, System.err for diagnostic error messages, and CommandLine.Help.Ansi.AUTO.
call(Class<C>, CommandLine.IFactory, PrintStream, String...) - Static method in class picocli.CommandLine: Delegates to CommandLine.call(Class, IFactory, PrintStream, PrintStream, Help.Ansi, String...) with System.err for diagnostic error messages, and CommandLine.Help.Ansi.AUTO.
call(Class<C>, CommandLine.IFactory, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine: Delegates to CommandLine.call(Class, IFactory, PrintStream, PrintStream, Help.Ansi, String...) with System.err for diagnostic error messages.
call(Class<C>, CommandLine.IFactory, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine: Convenience method to allow command line application authors to avoid some boilerplate code in their application.
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: Deprecated.
use CommandLine.Help.TextTable.textAt(int, int) instead
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.Help: Returns the ColorScheme model that this Help was constructed with.
ColorScheme() - Constructor for class picocli.CommandLine.Help.ColorScheme: Constructs a new empty ColorScheme with CommandLine.Help.Ansi.AUTO.
ColorScheme(CommandLine.Help.Ansi) - Constructor for class picocli.CommandLine.Help.ColorScheme: Constructs a new empty ColorScheme with the specified Ansi enabled mode.
colorScheme - Variable in class picocli.CommandLine.Help.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_LINE - Static variable in class picocli.groovy.PicocliBaseScript: Name of the property that holds the CommandLine instance for this script ("commandLine").
CommandLine - Class in picocli: CommandLine interpreter that uses reflection to initialize an annotated domain 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 subcommand 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.AbstractHandler<R,T extends CommandLine.AbstractHandler<R,T>> - Class in picocli: Abstract superclass for CommandLine.IParseResultHandler2 and CommandLine.IExceptionHandler2 implementations.
CommandLine.AbstractParseResultHandler<R> - Class in picocli: Command line parse result handler that returns a value.
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: Default exception handler that handles invalid user input by printing the exception message, followed by the usage message for the command or subcommand whose input was invalid.
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.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.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: Deprecated.
Use CommandLine.IExceptionHandler2 instead.
CommandLine.IExceptionHandler2<R> - Interface in picocli: Classes implementing this interface know how to handle ParameterExceptions (usually from invalid user input) and ExecutionExceptions that occurred while executing the Runnable or Callable command.
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: Help commands that provide usage help for other commands can implement this interface to be initialized with the information they need.
CommandLine.InitializationException - Exception in picocli: Exception indicating a problem during CommandLine initialization.
CommandLine.IParseResultHandler - Interface in picocli: Deprecated.
Use CommandLine.IParseResultHandler2 instead.
CommandLine.IParseResultHandler2<R> - Interface in picocli: Represents a function that can process the ParseResult object resulting from successfully parsing the command line arguments.
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.ArgSpec - Class in picocli: Models the shared attributes of CommandLine.Model.OptionSpec and CommandLine.Model.PositionalParamSpec.
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.IGetter - Interface in picocli: Customizable getter for obtaining the current value of an option or positional parameter.
CommandLine.Model.ISetter - Interface in picocli: Customizable setter for modifying the value of an option or positional parameter.
CommandLine.Model.Messages - Class in picocli: Utility class for getting resource bundle strings.
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.
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.PicocliException - Exception in picocli: Base class of all exceptions thrown by picocli.CommandLine.
CommandLine.Range - Class in picocli: Describes the number of parameters required and accepted by an option or a positional parameter.
CommandLine.RunAll - Class in picocli: Command line parse result handler that prints help if requested, and otherwise executes the top-level command and all subcommands as Runnable or Callable.
CommandLine.RunFirst - Class in picocli: Command line parse result handler that prints help if requested, and otherwise executes the top-level Runnable or Callable command.
CommandLine.RunLast - Class in picocli: Command line parse result handler that prints help if requested, and otherwise executes the most specific Runnable or Callable subcommand.
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.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.
commandList() - Method in class picocli.CommandLine.Help: Returns a 2-column list with command names and the first line of their header or (if absent) description.
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.
commands(CommandLine.Help.Ansi.IStyle...) - Method in class picocli.CommandLine.Help.ColorScheme: Adds the specified styles to the registered styles for commands in this color scheme and returns this color scheme.
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 - Variable in class picocli.CommandLine.Help.ColorScheme
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.
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.
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() - Static method in class picocli.CommandLine.Model.CommandSpec: Creates and returns a new CommandSpec without any associated user object.
createCommandLine() - Method in class picocli.groovy.PicocliBaseScript: Create and returns a new CommandLine instance.
createDefaultLayout() - 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.
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.
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.
CSI - Static variable in interface picocli.CommandLine.Help.Ansi.IStyle: The Control Sequence Introducer (CSI) escape sequence "\u001b[".
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

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_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 options this is 0 for booleans and 1 for other types, for parameters booleans have arity 0, arrays or Collections have arity "0..*", and other types have arity 1.
defaultArity(Class<?>) - Static method in class picocli.CommandLine.Range: Deprecated.
use CommandLine.Range.defaultArity(Field) instead
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
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 of this option or positional parameter, before splitting and type conversion.
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 displayed in the description.
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 template of this option, before variables are rendered.
description() - Method in class picocli.CommandLine.Model.OptionSpec: Returns the description template of this option, before variables are rendered.
description() - Method in class picocli.CommandLine.Model.PositionalParamSpec: Returns the description template of this positional parameter, before variables are rendered.
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: Deprecated.
use CommandLine.Help.detailedSynopsis(int, Comparator, boolean) instead.
detailedSynopsis(int, Comparator<CommandLine.Model.OptionSpec>, boolean) - Method in class picocli.CommandLine.Help: Generates a detailed synopsis message showing all options and parameters.
DuplicateOptionAnnotationsException(String) - Constructor for exception picocli.CommandLine.DuplicateOptionAnnotationsException

E

empty(CommandLine.Model.Messages) - Static method in class picocli.CommandLine.Model.Messages: Returns true if the specified Messages is null or has a null ResourceBundle.
enabled() - Method in enum picocli.CommandLine.Help.Ansi: Returns true if ANSI escape codes should be emitted, false otherwise.
endOfOptionsDelimiter() - Method in class picocli.CommandLine.Model.ParserSpec
endOfOptionsDelimiter(String) - Method in class picocli.CommandLine.Model.ParserSpec
equals(Object) - Method in class picocli.CommandLine.Help.Ansi.Text
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: Returns the stream to print diagnostic messages to.
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.
ExecutionException(CommandLine, String) - Constructor for exception picocli.CommandLine.ExecutionException
ExecutionException(CommandLine, String, Exception) - Constructor for exception picocli.CommandLine.ExecutionException
exitCode() - Method in class picocli.CommandLine.AbstractHandler: 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.
expandAtFiles() - Method in class picocli.CommandLine.Model.ParserSpec
expandAtFiles(boolean) - Method in class picocli.CommandLine.Model.ParserSpec

F

fg(String) - Static method in enum picocli.CommandLine.Help.Ansi.Style: Parses the specified style markup and returns the associated style.
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: Constructs a TextTable with the specified columns.
forColumnWidths(CommandLine.Help.Ansi, 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: 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)
forDefaultColumns(CommandLine.Help.Ansi, 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.

G

get() - Method in interface picocli.CommandLine.Model.IGetter: Returns the current value of the binding.
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).
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.
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.
getMissing() - Method in exception picocli.CommandLine.MissingParameterException
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.
getOrCreateCommandLine() - Method in class picocli.groovy.PicocliBaseScript: Return the CommandLine for this script.
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.
getScriptArguments() - Method in class picocli.groovy.PicocliBaseScript: Return the script arguments as an array of strings.
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.ArgSpec: Returns the CommandLine.Model.IGetter that is responsible for supplying the value of this argument.
getter() - Method in class picocli.CommandLine.Model.UnmatchedArgsBinding: Returns the getter responsible for producing a Collection that the unmatched arguments can be added to.
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.
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.

H

handle(CommandLine.ParseResult) - Method in class picocli.CommandLine.AbstractParseResultHandler: 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
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: This implementation always simply rethrows the specified exception.
handleExecutionException(CommandLine.ExecutionException, CommandLine.ParseResult) - Method in interface picocli.CommandLine.IExceptionHandler2: Handles a ExecutionException that occurred while executing the Runnable or Callable command and optionally returns a list of results.
handleExecutionException(CommandLine, String[], Exception) - Method in class picocli.groovy.PicocliBaseScript: If an Exception occurs during PicocliBaseScript.runRunnableSubcommand(List), or PicocliBaseScript.runScriptBody() then this gets called to report the problem.
handleParameterException(CommandLine.ParameterException, String[]) - Method in class picocli.groovy.PicocliBaseScript: If a ParameterException occurs during PicocliBaseScript.parseScriptArguments(CommandLine, String[]) then this method gets called to report the problem.
handleParseException(CommandLine.ParameterException, String[]) - Method in class picocli.CommandLine.DefaultExceptionHandler: 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: Handles a ParameterException that occurred while parsing the command line arguments and optionally returns a list of results.
handleParseResult(CommandLine.ParseResult) - Method in class picocli.CommandLine.AbstractParseResultHandler: 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: 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 or Callable.
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.
hasExitCode() - Method in class picocli.CommandLine.AbstractHandler: 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.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.
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.
Help(Object) - Constructor for class picocli.CommandLine.Help: Constructs a new Help instance with a default color scheme, initialized from annotatations 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 annotatations 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 annotatations on the specified class and superclasses.
help() - Method in class picocli.CommandLine.Model.OptionSpec.Builder: Deprecated.
Use CommandLine.Model.OptionSpec.Builder.usageHelp() and CommandLine.Model.OptionSpec.Builder.versionHelp() instead.
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: Deprecated.
Use CommandLine.Model.OptionSpec.usageHelp() and CommandLine.Model.OptionSpec.versionHelp() instead.
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.
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.
init(CommandLine, CommandLine.Help.Ansi, PrintStream, PrintStream) - 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: 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 this option or positional parameter.
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
invoke(String, Class<?>, String...) - Static method in class picocli.CommandLine: Delegates to CommandLine.invoke(String, Class, PrintStream, PrintStream, Help.Ansi, String...) with System.out for requested usage help messages, System.err for diagnostic error messages, and CommandLine.Help.Ansi.AUTO.
invoke(String, Class<?>, PrintStream, String...) - Static method in class picocli.CommandLine: Delegates to CommandLine.invoke(String, Class, PrintStream, PrintStream, Help.Ansi, String...) with the specified stream for requested usage help messages, System.err for diagnostic error messages, and CommandLine.Help.Ansi.AUTO.
invoke(String, Class<?>, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine: Delegates to CommandLine.invoke(String, Class, PrintStream, PrintStream, Help.Ansi, String...) with the specified stream for requested usage help messages, System.err for diagnostic error messages, and the specified Ansi mode.
invoke(String, Class<?>, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine: Convenience method to allow command line application authors to avoid some boilerplate code in their application.
isCaseInsensitiveEnumValuesAllowed() - Method in class picocli.CommandLine: Returns whether the parser should ignore case when converting arguments to enum values.
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.
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.
isOption() - Method in class picocli.CommandLine.Model.ArgSpec: Returns true if this argument is a named option, false otherwise.
isOption() - Method in class picocli.CommandLine.Model.OptionSpec
isOption() - Method in class picocli.CommandLine.Model.PositionalParamSpec
isOverwrittenOptionsAllowed() - Method in class picocli.CommandLine: Returns whether options for single-value fields can be specified multiple times on the command line.
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.
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.
isToggleBooleanFlags() - Method in class picocli.CommandLine: Returns whether the value of boolean flag options should be "toggled" when the option is matched.
isUnknownOption() - Method in exception picocli.CommandLine.UnmatchedArgumentException: Returns true if the first unmatched command line arguments resembles an option, false otherwise.
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.
isUnmatchedOptionsArePositionalParams() - Method in class picocli.CommandLine: Returns whether arguments on the command line that resemble an option should be treated as positional parameters.
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.
isVariable - Variable in class picocli.CommandLine.Range
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.

J

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

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.

M

main(String...) - Static method in class picocli.AutoComplete: Generates a bash completion script for the specified command class.
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 the order they were found on the command line.
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.
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.
max - Variable in class picocli.CommandLine.Range: Maximum accepted number of parameters for an option or positional parameter.
max(int) - Method in class picocli.CommandLine.Range: Returns a new Range object with the max value replaced by the specified value.
MaxValuesExceededException(CommandLine, String) - Constructor for exception picocli.CommandLine.MaxValuesExceededException
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, 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.
min - Variable in class picocli.CommandLine.Range: Required number of parameters for an option or positional parameter.
min(int) - Method in class picocli.CommandLine.Range: Returns a new Range object with the min value replaced by the specified value.
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
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.

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.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.

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.
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 the options supported by the application.
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().
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: Adds the specified styles to the registered styles for option parameters in this color scheme and returns this color scheme.
optionParamStyles - Variable in class picocli.CommandLine.Help.ColorScheme
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
options(CommandLine.Help.Ansi.IStyle...) - Method in class picocli.CommandLine.Help.ColorScheme: 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.CommandSpec: Returns the list of options configured for this command.
optionsMap() - Method in class picocli.CommandLine.Model.CommandSpec: Returns a map of the option names to option spec objects configured for this command.
optionStyles - Variable in class picocli.CommandLine.Help.ColorScheme
optionText(String) - Method in class picocli.CommandLine.Help.ColorScheme: Returns a Text with all option styles applied to the specified option string.
originalArgs(String[]) - Method in class picocli.CommandLine.ParseResult.Builder: Sets the specified command line arguments that were parsed.
originalArgs() - Method in class picocli.CommandLine.ParseResult: Returns the command line arguments that were parsed.
originalStringValues() - Method in class picocli.CommandLine.Model.ArgSpec: Returns the original command line arguments matched by this option or positional parameter spec.
out() - Method in class picocli.CommandLine.AbstractHandler: 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, 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.
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 section of the usage help message that lists the parameters with their descriptions.
parameterList(CommandLine.Help.Layout, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help: Returns the section of the usage help message that lists the 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
parameters(CommandLine.Help.Ansi.IStyle...) - Method in class picocli.CommandLine.Help.ColorScheme: Adds the specified styles to the registered styles for positional parameters in this color scheme and returns this color scheme.
parameterStyles - Variable in class picocli.CommandLine.Help.ColorScheme
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.
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: Parses the specified command line arguments and returns a list of CommandLine objects representing the top-level command and any subcommands (if any) that were recognized and initialized during the parsing process.
parseArgs(String...) - Method in class picocli.CommandLine: Parses the specified command line arguments and returns a list of 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
parseScriptArguments(CommandLine, String[]) - Method in class picocli.groovy.PicocliBaseScript: Returns the result of calling CommandLine.parse(String...) with the given arguments.
parseWithHandler(CommandLine.IParseResultHandler, PrintStream, String...) - Method in class picocli.CommandLine: Deprecated.
use CommandLine.parseWithHandler(IParseResultHandler2, String[]) instead
parseWithHandler(CommandLine.IParseResultHandler2<R>, String[]) - Method in class picocli.CommandLine: Returns the result of calling CommandLine.parseWithHandlers(IParseResultHandler2, IExceptionHandler2, String...) with a new CommandLine.DefaultExceptionHandler in addition to the specified parse result handler and the specified command line arguments.
parseWithHandlers(CommandLine.IParseResultHandler, PrintStream, CommandLine.Help.Ansi, CommandLine.IExceptionHandler, String...) - Method in class picocli.CommandLine: Deprecated.
use CommandLine.parseWithHandlers(IParseResultHandler2, IExceptionHandler2, String...) instead
parseWithHandlers(CommandLine.IParseResultHandler2<R>, CommandLine.IExceptionHandler2<R>, String...) - Method in class picocli.CommandLine: Tries to parse the specified command line arguments, and if successful, delegates the processing of the resulting ParseResult object to the specified handler.
picocli - package picocli: Provides classes and interfaces for the main picocli command line parsing and autocompletion functionality.
picocli.groovy - package picocli.groovy: Provides classes and annotations to give Groovy scripts convenient access to picocli functionality.
PicocliBaseScript - Class in picocli.groovy: Base script class that provides picocli declarative (annotation-based) command line argument processing for Groovy scripts.
PicocliBaseScript() - Constructor for class picocli.groovy.PicocliBaseScript
PicocliException(String) - Constructor for exception picocli.CommandLine.PicocliException
PicocliException(String, Throwable) - Constructor for exception picocli.CommandLine.PicocliException
PicocliScript - Annotation Type in picocli.groovy: Annotation to give Groovy scripts convenient access to picocli functionality.
PicocliScriptASTTransformation - Class in picocli.groovy: Ensures that Groovy scripts annotated with PicocliScript are transformed into a class that extends PicocliBaseScript.
PicocliScriptASTTransformation() - Constructor for class picocli.groovy.PicocliScriptASTTransformation
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.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.
printErrorMessage(String) - Method in class picocli.groovy.PicocliBaseScript: Error messages that arise from command line processing call this.
printHelpIfRequested(List<CommandLine>, PrintStream, CommandLine.Help.Ansi) - Static method in class picocli.CommandLine: Deprecated.
use CommandLine.printHelpIfRequested(List, PrintStream, PrintStream, Help.Ansi) instead
printHelpIfRequested(CommandLine.ParseResult) - Static method in class picocli.CommandLine: Delegates to CommandLine.printHelpIfRequested(List, PrintStream, PrintStream, Help.Ansi) with parseResult.asCommandLineList(), System.out, System.err, Help.Ansi.AUTO.
printHelpIfRequested(List<CommandLine>, PrintStream, PrintStream, CommandLine.Help.Ansi) - Static method in class picocli.CommandLine: Helper method that may be useful when processing the list of CommandLine objects that result from successfully parsing command line arguments.
printHelpIfRequested(List<CommandLine>, PrintStream, PrintStream, CommandLine.Help.ColorScheme) - Static method in class picocli.CommandLine: Helper method that may be useful when processing the list of CommandLine objects that result from successfully parsing command line arguments.
printHelpMessage(CommandLine) - Method in class picocli.groovy.PicocliBaseScript: If an @Option whose usageHelp attribute is annotated as true appears in the arguments.
printHelpMessage(CommandLine, PrintStream) - Method in class picocli.groovy.PicocliBaseScript: If an @Option whose usageHelp attribute is annotated as true appears in the arguments.
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(PrintStream) - 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 platform default.
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.
printVersionHelpMessage(CommandLine) - Method in class picocli.groovy.PicocliBaseScript: If an @Option whose versionHelp attribute is annotated as true appears in the arguments.
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.
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.
renderedDescription() - Method in class picocli.CommandLine.Model.ArgSpec: Returns the description of this option, after variables are rendered.
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.
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.
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.
returnResultOrExit(R) - Method in class picocli.CommandLine.AbstractHandler: 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.
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.CommandLine.HelpCommand: Invokes usage for the specified command, or for the parent command.
run(R, String...) - Static method in class picocli.CommandLine: Delegates to CommandLine.run(Runnable, PrintStream, PrintStream, Help.Ansi, String...) with System.out for requested usage help messages, System.err for diagnostic error messages, and CommandLine.Help.Ansi.AUTO.
run(R, PrintStream, String...) - Static method in class picocli.CommandLine: Delegates to CommandLine.run(Runnable, PrintStream, PrintStream, Help.Ansi, String...) with System.err for diagnostic error messages and CommandLine.Help.Ansi.AUTO.
run(R, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine: Delegates to CommandLine.run(Runnable, PrintStream, PrintStream, Help.Ansi, String...) with System.err for diagnostic error messages.
run(R, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine: Convenience method to allow command line application authors to avoid some boilerplate code in their application.
run(Class<R>, CommandLine.IFactory, String...) - Static method in class picocli.CommandLine: Delegates to CommandLine.run(Class, IFactory, PrintStream, PrintStream, Help.Ansi, String...) with System.out for requested usage help messages, System.err for diagnostic error messages, and CommandLine.Help.Ansi.AUTO.
run(Class<R>, CommandLine.IFactory, PrintStream, String...) - Static method in class picocli.CommandLine: Delegates to CommandLine.run(Class, IFactory, PrintStream, PrintStream, Help.Ansi, String...) with System.err for diagnostic error messages, and CommandLine.Help.Ansi.AUTO.
run(Class<R>, CommandLine.IFactory, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine: Delegates to CommandLine.run(Class, IFactory, PrintStream, PrintStream, Help.Ansi, String...) with System.err for diagnostic error messages.
run(Class<R>, CommandLine.IFactory, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine: Convenience method to allow command line application authors to avoid some boilerplate code in their application.
run() - Method in class picocli.groovy.PicocliBaseScript: Parses the command line and initializes @Field variables annotated with @Option or @Parameters before executing the script body.
RunAll() - Constructor for class picocli.CommandLine.RunAll
RunFirst() - Constructor for class picocli.CommandLine.RunFirst
RunLast() - Constructor for class picocli.CommandLine.RunLast
runRunnableSubcommand(List<CommandLine>) - Method in class picocli.groovy.PicocliBaseScript: If the most specific subcommand (the last CommandLine object in the list) implements Runnable or Callable, then run it.
runScriptBody() - Method in class picocli.groovy.PicocliBaseScript: The script body.

S

self() - Method in class picocli.CommandLine.AbstractHandler: Returns this to allow method chaining when calling the setters for a fluent API.
self() - Method in class picocli.CommandLine.DefaultExceptionHandler
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.
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.
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.
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.
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.
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.
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.
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 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.
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.
setUnmatchedOptionsArePositionalParams(boolean) - Method in class picocli.CommandLine: Sets whether arguments on the command line that resemble an option should be treated as positional parameters.
setUsageHelpWidth(int) - Method in class picocli.CommandLine: Sets the maximum width of the usage help message.
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: Sets the value of this argument to the specified value and returns the previous value.
shortestFirst() - Static method in class picocli.CommandLine.Help: Sorts short strings before longer strings.
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.
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.
splitLines() - Method in class picocli.CommandLine.Help.Ansi.Text
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.
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.
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 subcommand of this command that was matched on the command line, or null if no subcommand was matched.
subcommands() - Method in class picocli.CommandLine.Model.CommandSpec: Returns a read-only view of the subcommand map.
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.
use CommandLine.Help.synopsis(int) instead
synopsis(int) - Method in class picocli.CommandLine.Help: Returns a synopsis for the command, reserving the specified space for the synopsis heading.
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.

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(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|@.
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(CommandLine.Help.Ansi, CommandLine.Help.Column[]) - Constructor for class picocli.CommandLine.Help.TextTable
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.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 - 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.ParserSpec
toString() - Method in class picocli.CommandLine.Range
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
typedValues() - Method in class picocli.CommandLine.Model.ArgSpec: Returns the typed command line arguments matched by this option or positional parameter spec.

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
unmatchedArgumentsAllowed() - Method in class picocli.CommandLine.Model.ParserSpec
unmatchedArgumentsAllowed(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
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: Delegates to CommandLine.usage(PrintStream, Help.Ansi) with the platform default.
usage(PrintWriter) - Method in class picocli.CommandLine: Delegates to CommandLine.usage(PrintWriter, Help.Ansi) with the platform default.
usage(PrintStream, CommandLine.Help.Ansi) - Method in class picocli.CommandLine: Delegates to CommandLine.usage(PrintStream, Help.ColorScheme) with the default color scheme.
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: Sets the ANSI style to use.
useErr(PrintStream) - Method in class picocli.CommandLine.AbstractHandler: Sets the stream to print diagnostic messages to.
useOut(PrintStream) - Method in class picocli.CommandLine.AbstractHandler: Sets the stream to print command output to.
userObject() - Method in class picocli.CommandLine.Model.CommandSpec: Returns the user object associated with this command.

V

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 an Range value and return the result.
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.
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 "3.6.0".
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.
visit(ASTNode[], SourceUnit) - Method in class picocli.groovy.PicocliScriptASTTransformation

W

width - Variable in class picocli.CommandLine.Help.Column: Column width in characters
width() - Method in class picocli.CommandLine.Model.UsageMessageSpec: Returns the maximum usage help message width.
width(int) - Method in class picocli.CommandLine.Model.UsageMessageSpec: Sets the maximum usage help message width to the specified value.
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.

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