- 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
-
- addError(CommandLine.PicocliException) - Method in class picocli.CommandLine.ParseResult.Builder
-
- addMethodSubcommands() - Method in class picocli.CommandLine.Model.CommandSpec
-
Reflects on the class of the
user object and registers any command methods
(class methods annotated with
@Command) as subcommands.
- addMethodSubcommands(CommandLine.IFactory) - Method in class picocli.CommandLine.Model.CommandSpec
-
Reflects on the class of the
user object and registers any command methods
(class methods annotated with
@Command) as subcommands.
- addMixin(String, Object) - Method in class picocli.CommandLine
-
Adds the options and positional parameters in the specified mixin to this command.
- addMixin(String, CommandLine.Model.CommandSpec) - 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
-
- 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
-
- 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
-
- addPositionalParameters(List<CommandLine.Model.PositionalParamSpec>, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help.Layout
-
- addRowValues(String...) - Method in class picocli.CommandLine.Help.TextTable
-
- 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.Help
-
Returns the list of aliases for the command in this Help.
- aliases() - Method in class picocli.CommandLine.Model.CommandSpec
-
Returns the alias command names of this subcommand.
- aliases(String...) - Method in class picocli.CommandLine.Model.CommandSpec
-
Sets the alternative names by which this subcommand is recognized on the command line.
- 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
-
- append(CommandLine.Help.Ansi.Text) - Method in class picocli.CommandLine.Help.Ansi.Text
-
- apply(String, List<CommandLine.Help.Ansi.IStyle>) - Method in enum picocli.CommandLine.Help.Ansi
-
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
-
- call(C, String...) - Static method in class picocli.CommandLine
-
- call(C, PrintStream, String...) - Static method in class picocli.CommandLine
-
- call(C, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
-
- call(C, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
-
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
-
- call(Class<C>, CommandLine.IFactory, PrintStream, String...) - Static method in class picocli.CommandLine
-
- call(Class<C>, CommandLine.IFactory, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
-
- call(Class<C>, CommandLine.IFactory, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
-
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
-
- 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
-
- 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
-
- 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
-
- CommandLine.Help.TextTable.Cell - Class in picocli
-
Helper class to index positions in a Help.TextTable.
- CommandLine.Help.Visibility - Enum in picocli
-
Controls the visibility of certain aspects of the usage help message.
- CommandLine.HelpCommand - Class in picocli
-
Help command that can be installed as a subcommand on all application commands.
- CommandLine.IDefaultValueProvider - Interface in picocli
-
Provides default value for a command.
- CommandLine.IExceptionHandler - Interface in picocli
-
- CommandLine.IExceptionHandler2<R> - Interface in picocli
-
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
-
- 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.IHelpFactory - Interface in picocli
-
- CommandLine.IHelpSectionRenderer - Interface in picocli
-
Renders a section of the usage help message.
- CommandLine.InitializationException - Exception in picocli
-
Exception indicating a problem during CommandLine initialization.
- CommandLine.IParseResultHandler - Interface in picocli
-
- 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
-
- 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
-
- 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 and can be used to customize the usage help message.
- 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
-
- 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
-
- 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
-
- 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.
- commandNamesText(String) - Method in class picocli.CommandLine.Help
-
Returns a Text object containing the command name and all aliases, separated with the specified separator.
- commands(CommandLine.Help.Ansi.IStyle...) - Method in class picocli.CommandLine.Help.ColorScheme
-
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.Help
-
Returns the CommandSpec model that this Help was constructed with.
- commandSpec() - Method in class picocli.CommandLine.Model.Messages
-
Returns the CommandSpec of this object, never null.
- commandSpec() - Method in class picocli.CommandLine.ParseResult
-
Returns the CommandSpec for the matched command.
- commandStyles - 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(CommandLine.Model.CommandSpec, CommandLine.Help.ColorScheme) - Method in interface picocli.CommandLine.IHelpFactory
-
Returns a Help instance to assist in rendering the usage help message
- create() - Static method in class picocli.CommandLine.Model.CommandSpec
-
Creates and returns a new CommandSpec without any associated user object.
- 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
-
- createDefaultParamLabelRenderer() - Method in class picocli.CommandLine.Help
-
Returns a new default param label renderer that separates option parameters from their option name
with the specified separator string, and, unless
CommandLine.Model.ArgSpec.hideParamSyntax() is true,
surrounds optional parameters with
'[' and
']'
characters and uses ellipses ("...") to indicate that any number of a parameter are allowed.
- createDetailedSynopsisCommandText() - Method in class picocli.CommandLine.Help
-
Returns a Text object containing a partial detailed synopsis showing only the subcommands, starting with a " " space.
- createDetailedSynopsisOptionsText(Comparator<CommandLine.Model.OptionSpec>, boolean) - Method in class picocli.CommandLine.Help
-
Returns a Text object containing a partial detailed synopsis showing only the options, starting with a " " space.
- createDetailedSynopsisPositionalsText() - Method in class picocli.CommandLine.Help
-
Returns a Text object containing a partial detailed synopsis showing only the positional parameters, starting with a " " space.
- 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
-
- 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.
- 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.
- 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.
- getHelpFactory() - Method in class picocli.CommandLine
-
Returns the IHelpFactory that is used to construct the usage help message.
- getHelpSectionKeys() - Method in class picocli.CommandLine
-
Returns the section keys in the order that the usage help message should render the sections.
- getHelpSectionMap() - Method in class picocli.CommandLine
-
Returns the map of section keys and renderers used to construct the usage help message.
- 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.
- getOverwritten() - Method in exception picocli.CommandLine.OverwrittenOptionException
-
- 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
-
- 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
-
- getUsageMessage(CommandLine.Help.Ansi) - Method in class picocli.CommandLine
-
- getUsageMessage(CommandLine.Help.ColorScheme) - Method in class picocli.CommandLine
-
- 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.
- 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
-
- handleParameterException(CommandLine.ParameterException, String[]) - Method in class picocli.groovy.PicocliBaseScript
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- help(boolean) - Method in class picocli.CommandLine.Model.OptionSpec.Builder
-
Sets whether this option disables validation of the other arguments, and returns this builder.
- help() - Method in class picocli.CommandLine.Model.OptionSpec
-
- HelpCommand() - Constructor for class picocli.CommandLine.HelpCommand
-
- helpCommand() - Method in class picocli.CommandLine.Model.CommandSpec
-
Returns whether this subcommand is a help command, and required options and positional
parameters of the parent command should not be validated.
- helpCommand(boolean) - Method in class picocli.CommandLine.Model.CommandSpec
-
Sets whether this is a help command and required parameter checking should be suspended.
- helpFactory() - Method in class picocli.CommandLine.Model.UsageMessageSpec
-
Returns the IHelpFactory that is used to construct the usage help message.
- helpFactory(CommandLine.IHelpFactory) - Method in class picocli.CommandLine.Model.UsageMessageSpec
-
Sets a new IHelpFactory to customize the usage help message.
- hidden() - Method in class picocli.CommandLine.Model.ArgSpec
-
Returns whether this option should be excluded from the usage message.
- hidden() - Method in class picocli.CommandLine.Model.UsageMessageSpec
-
Returns whether this command should be hidden from the usage help message of the parent command.
- hidden(boolean) - Method in class picocli.CommandLine.Model.UsageMessageSpec
-
Set the hidden flag on this command to control whether to show or hide it in the help usage text of the parent command.
- hideParamSyntax() - Method in class picocli.CommandLine.Model.ArgSpec
-
Returns whether usage syntax decorations around the
paramLabel should be suppressed.
- 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.
- insertSynopsisCommandName(int, CommandLine.Help.Ansi.Text) - Method in class picocli.CommandLine.Help
-
Returns the detailed synopsis text by inserting the command name before the specified text with options and positional parameters details.
- interactive() - Method in class picocli.CommandLine.Model.ArgSpec
-
Returns whether this option will prompt the user to enter a value on the command line.
- internalShowDefaultValue(boolean) - Method in class picocli.CommandLine.Model.ArgSpec
-
Returns whether the default for this option or positional parameter should be shown, potentially overriding the specified global setting.
- internalShowDefaultValue(boolean) - Method in class picocli.CommandLine.Model.OptionSpec
-
- invoke(String, Class<?>, String...) - Static method in class picocli.CommandLine
-
- invoke(String, Class<?>, PrintStream, String...) - Static method in class picocli.CommandLine
-
- invoke(String, Class<?>, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
-
- invoke(String, Class<?>, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
-
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
-
- 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.
- isSplitQuotedStrings() - Method in class picocli.CommandLine
-
Returns whether the parser is allowed to split quoted Strings or not.
- 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.
- isTrimQuotes() - Method in class picocli.CommandLine
-
Returns whether the parser should trim quotes from command line arguments before processing them.
- 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
-
- isUsageHelpRequested() - Method in class picocli.CommandLine.ParseResult
-
Returns
true if one of the options that was matched on the command line is a
usageHelp option.
- isUseSimplifiedAtFiles() - Method in class picocli.CommandLine
-
Returns whether to use a simplified argument file format that is compatible with JCommander.
- isVariable - Variable in class picocli.CommandLine.Range
-
- isVersionHelpRequested() - Method in class picocli.CommandLine
-
- 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.
- 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
-
- 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
-
- parseWithHandler(CommandLine.IParseResultHandler, PrintStream, String...) - Method in class picocli.CommandLine
-
- parseWithHandler(CommandLine.IParseResultHandler2<R>, String[]) - Method in class picocli.CommandLine
-
- parseWithHandlers(CommandLine.IParseResultHandler, PrintStream, CommandLine.Help.Ansi, CommandLine.IExceptionHandler, String...) - Method in class picocli.CommandLine
-
- parseWithHandlers(CommandLine.IParseResultHandler2<R>, CommandLine.IExceptionHandler2<R>, String...) - Method in class picocli.CommandLine
-
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
-
- 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
-
- 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
-
- printHelpIfRequested(CommandLine.ParseResult) - Static method in class picocli.CommandLine
-
- 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
-
- printVersionHelp(PrintStream, CommandLine.Help.Ansi) - Method in class picocli.CommandLine
-
- printVersionHelp(PrintStream, CommandLine.Help.Ansi, Object...) - Method in class picocli.CommandLine
-
- 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.
- SECTION_KEY_COMMAND_LIST - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
-
- SECTION_KEY_COMMAND_LIST_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
-
- SECTION_KEY_DESCRIPTION - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
-
- SECTION_KEY_DESCRIPTION_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
-
- SECTION_KEY_FOOTER - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
-
- SECTION_KEY_FOOTER_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
-
- SECTION_KEY_HEADER - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
-
- SECTION_KEY_HEADER_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
-
- SECTION_KEY_OPTION_LIST - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
-
- SECTION_KEY_OPTION_LIST_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
-
- SECTION_KEY_PARAMETER_LIST - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
-
- SECTION_KEY_PARAMETER_LIST_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
-
- SECTION_KEY_SYNOPSIS - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
-
- SECTION_KEY_SYNOPSIS_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
-
- sectionKeys() - Method in class picocli.CommandLine.Model.UsageMessageSpec
-
Returns the section keys in the order that the usage help message should render the sections.
- sectionKeys(List<String>) - Method in class picocli.CommandLine.Model.UsageMessageSpec
-
Sets the section keys in the order that the usage help message should render the sections.
- sectionMap() - Method in class picocli.CommandLine.Model.UsageMessageSpec
-
Returns the map of section keys and renderers used to construct the usage help message.
- sectionMap(Map<String, CommandLine.IHelpSectionRenderer>) - Method in class picocli.CommandLine.Model.UsageMessageSpec
-
Sets the map of section keys and renderers used to construct the usage help message to a copy of the specified map.
- self() - Method in class picocli.CommandLine.AbstractHandler
-
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.
- setHelpFactory(CommandLine.IHelpFactory) - Method in class picocli.CommandLine
-
Sets a new IHelpFactory to customize the usage help message.
- setHelpSectionKeys(List<String>) - Method in class picocli.CommandLine
-
Sets the section keys in the order that the usage help message should render the sections.
- setHelpSectionMap(Map<String, CommandLine.IHelpSectionRenderer>) - Method in class picocli.CommandLine
-
Sets the map of section keys and renderers used to construct the usage help message.
- setOverwrittenOptionsAllowed(boolean) - Method in class picocli.CommandLine
-
- setPosixClusteredShortOptionsAllowed(boolean) - Method in class picocli.CommandLine
-
Sets whether short options like -x -v -f SomeFile can be clustered together like -xvfSomeFile.
- setResourceBundle(ResourceBundle) - Method in class picocli.CommandLine
-
Sets the ResourceBundle containing usage help message strings.
- setSeparator(String) - Method in class picocli.CommandLine
-
Sets the String the parser uses to separate option names from option values to the specified value.
- setSplitQuotedStrings(boolean) - Method in class picocli.CommandLine
-
Sets whether the parser is allowed to split quoted Strings.
- 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
-
- setter() - Method in class picocli.CommandLine.Model.UnmatchedArgsBinding
-
Returns the setter responsible for consuming the unmatched arguments.
- setToggleBooleanFlags(boolean) - Method in class picocli.CommandLine
-
Sets whether the value of boolean flag options should be "toggled" when the option is matched.
- setTrimQuotes(boolean) - Method in class picocli.CommandLine
-
Sets whether the parser should trim quotes from command line arguments before processing them.
- setUnmatchedArgumentsAllowed(boolean) - Method in class picocli.CommandLine
-
- 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.
- setUseSimplifiedAtFiles(boolean) - Method in class picocli.CommandLine
-
Sets whether to use a simplified argument file format that is compatible with JCommander.
- setValue(T) - Method in class picocli.CommandLine.Model.ArgSpec
-
Sets the value of this argument to the specified value and returns the previous value.
- setValue(T, CommandLine) - Method in class picocli.CommandLine.Model.ArgSpec
-
- 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
-
- splitQuotedStrings() - Method in class picocli.CommandLine.Model.ParserSpec
-
- splitQuotedStrings(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
-
- splitRegex() - Method in class picocli.CommandLine.Model.ArgSpec
-
Returns a regular expression to split option parameter values or "" if the value should not be split.
- 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.Help
-
Returns the map of subcommand Help instances for this command Help.
- 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
-
- 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.