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

C

calcLongOptionColumnWidth(List<CommandLine.Model.OptionSpec>, List<CommandLine.Model.PositionalParamSpec>, CommandLine.Help.ColorScheme) - Method in class picocli.CommandLine.Help

Returns the width of the long options column in the usage help message.

call() - Method in class picocli.codegen.docgen.manpage.ManPageGenerator

Invokes ManPageGenerator.generateManPage(Config, CommandLine.Model.CommandSpec...) to generate man pages for all non-hidden commands in the hierarchy from the top-level command down.

call() - Method in class picocli.groovy.PicocliBaseScript2

The script body.

call() - Method in class picocli.shell.jline3.PicocliCommands.ClearScreen

call(C, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine

Deprecated.

use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead

call(C, PrintStream, String...) - Static method in class picocli.CommandLine

Deprecated.

use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead

call(C, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine

Deprecated.

use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead

call(C, String...) - Static method in class picocli.CommandLine

Deprecated.

use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead

call(Class<C>, CommandLine.IFactory, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine

Deprecated.

use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead

call(Class<C>, CommandLine.IFactory, PrintStream, String...) - Static method in class picocli.CommandLine

Deprecated.

use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead

call(Class<C>, CommandLine.IFactory, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine

Deprecated.

use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead

call(Class<C>, CommandLine.IFactory, String...) - Static method in class picocli.CommandLine

Deprecated.

use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead

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

clearExecutionResults() - Method in class picocli.CommandLine

Clears the execution result of a previous invocation from this CommandLine and all subcommands.

clone() - Method in class picocli.CommandLine.Help.Ansi.Text

closeSilently(Closeable) - Static method in class picocli.codegen.util.Util

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 - Variable in class picocli.CommandLine.Help.Layout

colorScheme() - Method in class picocli.CommandLine.AbstractHandler

Deprecated.

Returns the ColorScheme to use.

colorScheme() - Method in class picocli.CommandLine.Help

Returns the ColorScheme model that this Help was constructed with.

colorScheme() - Method in class picocli.CommandLine.Help.Layout

Returns the ColorScheme used to create Text objects in this layout.

column - Variable in class picocli.CommandLine.Help.TextTable.Cell

Table column index (zero based).

Column(int, int, CommandLine.Help.Column.Overflow) - Constructor for class picocli.CommandLine.Help.Column

columns() - Method in class picocli.CommandLine.Help.TextTable

The column definitions of this table.

columnValues - Variable in class picocli.CommandLine.Help.TextTable

The char[] slots of the TextTable to copy text values into.

command() - Method in class picocli.CommandLine.Model.ArgSpec

Returns the command this option or positional parameter belongs to.

COMMAND_LINE - Static variable in class picocli.groovy.PicocliBaseScript

Deprecated.

Name of the property that holds the CommandLine instance for this script ("commandLine").

COMMAND_LINE - Static variable in class picocli.groovy.PicocliBaseScript2

Name of the property that holds the CommandLine instance for this script ("commandLine").

commandAliases() - Method in class picocli.shell.jline3.PicocliCommands

commandDescription(String) - Method in class picocli.shell.jline3.PicocliCommands

commandDescription(List<String>) - Method in class picocli.shell.jline3.PicocliCommands

commandInfo(String) - Method in class picocli.shell.jline3.PicocliCommands

commandLine - Variable in exception picocli.CommandLine.ParameterException

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 - Class in picocli

CommandLine interpreter that uses reflection to initialize an annotated user object with values obtained from the command line arguments.

CommandLine(Object) - Constructor for class picocli.CommandLine

Constructs a new CommandLine interpreter with the specified object (which may be an annotated user object or a CommandSpec) and a default factory.

CommandLine(Object, CommandLine.IFactory) - Constructor for class picocli.CommandLine

Constructs a new CommandLine interpreter with the specified object (which may be an annotated user object or a CommandSpec) and object factory.

CommandLine.AbstractHandler<R,T extends CommandLine.AbstractHandler<R,T>> - Class in picocli

Deprecated.

see CommandLine.execute(String...)

CommandLine.AbstractParseResultHandler<R> - Class in picocli

Deprecated.

see CommandLine.execute(String...), CommandLine.getExecutionStrategy(), CommandLine.getParameterExceptionHandler(), CommandLine.getExecutionExceptionHandler()

CommandLine.ArgGroup - Annotation Type in picocli

A Command may define one or more ArgGroups: a group of options, positional parameters or a mixture of the two.

CommandLine.Command - Annotation Type in picocli

Annotate your class with @Command when you want more control over the format of the generated help message.

CommandLine.DefaultExceptionHandler<R> - Class in picocli

Deprecated.

see CommandLine.execute(String...), CommandLine.getParameterExceptionHandler() and CommandLine.getExecutionExceptionHandler()

CommandLine.DuplicateNameException - Exception in picocli

Exception indicating that multiple named elements have incorrectly used the same name.

CommandLine.DuplicateOptionAnnotationsException - Exception in picocli

Exception indicating that multiple fields have been annotated with the same Option name.

CommandLine.ExecutionException - Exception in picocli

Exception indicating a problem while invoking a command or subcommand.

CommandLine.ExitCode - Class in picocli

Defines some exit codes used by picocli as default return values from the execute and executeHelpRequest methods.

CommandLine.Help - Class in picocli

A collection of methods and inner classes that provide fine-grained control over the contents and layout of the usage help message to display to end users when help is requested or invalid input values were specified.

CommandLine.Help.Ansi - Enum in picocli

Provides methods and inner classes to support using ANSI escape codes in usage help messages.

CommandLine.Help.Ansi.IStyle - Interface in picocli

Defines the interface for an ANSI escape sequence.

CommandLine.Help.Ansi.Style - Enum in picocli

A set of pre-defined ANSI escape code styles and colors, and a set of convenience methods for parsing text with embedded markup style names, as well as convenience methods for converting styles to strings with embedded escape codes.

CommandLine.Help.Ansi.Text - Class in picocli

Encapsulates rich text with styles and colors.

CommandLine.Help.ColorScheme - Class in picocli

All usage help message are generated with a color scheme that assigns certain styles and colors to common parts of a usage message: the command name, options, positional parameters and option parameters.

CommandLine.Help.ColorScheme.Builder - Class in picocli

Builder class to create ColorScheme instances.

CommandLine.Help.Column - Class in picocli

Columns define the width, indent (leading number of spaces in a column before the value) and Overflow policy of a column in a TextTable.

CommandLine.Help.Column.Overflow - Enum in picocli

Policy for handling text that is longer than the column width: span multiple columns, wrap to the next row, or simply truncate the portion that doesn't fit.

CommandLine.Help.IOptionRenderer - Interface in picocli

When customizing online help for Option details, a custom IOptionRenderer can be used to create textual representation of an Option in a tabular format: one or more rows, each containing one or more columns.

CommandLine.Help.IParameterRenderer - Interface in picocli

When customizing online help for positional parameters details, a custom IParameterRenderer can be used to create textual representation of a Parameters field in a tabular format: one or more rows, each containing one or more columns.

CommandLine.Help.IParamLabelRenderer - Interface in picocli

When customizing online usage help for an option parameter or a positional parameter, a custom IParamLabelRenderer can be used to render the parameter name or label to a String.

CommandLine.Help.Layout - Class in picocli

Use a Layout to format usage help text for options and parameters in tabular format.

CommandLine.Help.TextTable - Class in picocli

Responsible for spacing out CommandLine.Help.Ansi.Text values according to the CommandLine.Help.Column definitions the table was created with.

CommandLine.Help.TextTable.Cell - Class in picocli

Helper class to index positions in a Help.TextTable.

CommandLine.Help.Visibility - Enum in picocli

Controls the visibility of certain aspects of the usage help message.

CommandLine.HelpCommand - Class in picocli

Help command that can be installed as a subcommand on all application commands.

CommandLine.IDefaultValueProvider - Interface in picocli

Provides default value for a command.

CommandLine.IExceptionHandler - Interface in picocli

Deprecated.

see CommandLine.execute(String...), CommandLine.IParameterExceptionHandler and CommandLine.IExecutionExceptionHandler

CommandLine.IExceptionHandler2<R> - Interface in picocli

Deprecated.

see CommandLine.execute(String...), CommandLine.IParameterExceptionHandler and CommandLine.IExecutionExceptionHandler

CommandLine.IExecutionExceptionHandler - Interface in picocli

Classes implementing this interface know how to handle Exceptions that occurred while executing the Runnable, Callable or Method user object of the command.

CommandLine.IExecutionStrategy - Interface in picocli

Implementations are responsible for "executing" the user input and returning an exit code.

CommandLine.IExitCodeExceptionMapper - Interface in picocli

Interface that provides the appropriate exit code that will be returned from the execute method for an exception that occurred during parsing or while invoking the command's Runnable, Callable, or Method.

CommandLine.IExitCodeGenerator - Interface in picocli

@Command-annotated classes can implement this interface to specify an exit code that will be returned from the execute method when the command is successfully invoked.

CommandLine.IFactory - Interface in picocli

Factory for instantiating classes that are registered declaratively with annotation attributes, like CommandLine.Command.subcommands(), CommandLine.Option.converter(), CommandLine.Parameters.converter() and CommandLine.Command.versionProvider().

CommandLine.IHelpCommandInitializable - Interface in picocli

Deprecated.

use CommandLine.IHelpCommandInitializable2 instead

CommandLine.IHelpCommandInitializable2 - Interface in picocli

Help commands that provide usage help for other commands can implement this interface to be initialized with the information they need.

CommandLine.IHelpFactory - Interface in picocli

Creates the CommandLine.Help instance used to render the usage help message.

CommandLine.IHelpSectionRenderer - Interface in picocli

Renders a section of the usage help message.

CommandLine.IModelTransformer - Interface in picocli

Provides a way to modify how the command model is built.

CommandLine.INegatableOptionTransformer - Interface in picocli

Determines the option name transformation of negatable boolean options.

CommandLine.InitializationException - Exception in picocli

Exception indicating a problem during CommandLine initialization.

CommandLine.IParameterConsumer - Interface in picocli

Options or positional parameters can be assigned a IParameterConsumer that implements custom logic to process the parameters for this option or this position.

CommandLine.IParameterExceptionHandler - Interface in picocli

Classes implementing this interface know how to handle ParameterExceptions (usually from invalid user input).

CommandLine.IParameterPreprocessor - Interface in picocli

Options, positional parameters and commands can be assigned a IParameterPreprocessor that implements custom logic to preprocess the parameters for this option, position or command.

CommandLine.IParseResultHandler - Interface in picocli

Deprecated.

Use CommandLine.IExecutionStrategy instead.

CommandLine.IParseResultHandler2<R> - Interface in picocli

Deprecated.

use CommandLine.IExecutionStrategy instead, see CommandLine.execute(String...)

CommandLine.ITypeConverter<K> - Interface in picocli

When parsing command line arguments and initializing fields annotated with @Option or @Parameters, String values can be converted to any type for which a ITypeConverter is registered.

CommandLine.IVersionProvider - Interface in picocli

Provides version information for a command.

CommandLine.MaxValuesExceededException - Exception in picocli

Exception indicating that more values were specified for an option or parameter than its arity allows.

CommandLine.MissingParameterException - Exception in picocli

Exception indicating that a required parameter was not specified.

CommandLine.MissingTypeConverterException - Exception in picocli

Exception indicating that an annotated field had a type for which no CommandLine.ITypeConverter was registered.

CommandLine.Mixin - Annotation Type in picocli

Fields annotated with @Mixin are "expanded" into the current command: @Option and @Parameters in the mixin class are added to the options and positional parameters of this command.

CommandLine.Model - Class in picocli

This class provides a namespace for classes and interfaces that model concepts and attributes of command line interfaces in picocli.

CommandLine.Model.ArgGroupSpec - Class in picocli

The ArgGroupSpec class models a group of arguments (options, positional parameters or a mixture of the two).

CommandLine.Model.ArgGroupSpec.Builder - Class in picocli

Builder responsible for creating valid ArgGroupSpec objects.

CommandLine.Model.ArgSpec - Class in picocli

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.IAnnotatedElement - Interface in picocli

Internal interface to allow annotation processors to construct a command model at compile time.

CommandLine.Model.IExtensible - Interface in picocli

Interface to allow extending the capabilities of other interface without Java 8 default methods.

CommandLine.Model.IGetter - Interface in picocli

Customizable getter for obtaining the current value of an option or positional parameter.

CommandLine.Model.IOrdered - Interface in picocli

Interface for sorting options and groups together.

CommandLine.Model.IScope - Interface in picocli

The scope of a getter/setter binding is the context where the current value should be gotten from or set to.

CommandLine.Model.IScoped - Interface in picocli

This interface provides access to an CommandLine.Model.IScope instance.

CommandLine.Model.ISetter - Interface in picocli

Customizable setter for modifying the value of an option or positional parameter.

CommandLine.Model.ITypeInfo - Interface in picocli

Encapculates type information for an option or parameter to make this information available both at runtime and at compile time (when Class values are not available).

CommandLine.Model.Messages - Class in picocli

Utility class for getting resource bundle strings.

CommandLine.Model.MethodParam - Class in picocli

Command method parameter, similar to java.lang.reflect.Parameter (not available before Java 8).

CommandLine.Model.OptionSpec - Class in picocli

The OptionSpec class models aspects of a named option of a command, including whether it is required or optional, the option parameters supported (or required) by the option, and attributes for the usage help message describing the option.

CommandLine.Model.OptionSpec.Builder - Class in picocli

Builder responsible for creating valid OptionSpec objects.

CommandLine.Model.ParserSpec - Class in picocli

Models parser configuration specification.

CommandLine.Model.PositionalParamSpec - Class in picocli

The PositionalParamSpec class models aspects of a positional parameter of a command, including whether it is required or optional, and attributes for the usage help message describing the positional parameter.

CommandLine.Model.PositionalParamSpec.Builder - Class in picocli

Builder responsible for creating valid PositionalParamSpec objects.

CommandLine.Model.UnmatchedArgsBinding - Class in picocli

This class allows applications to specify a custom binding that will be invoked for unmatched arguments.

CommandLine.Model.UsageMessageSpec - Class in picocli

Models the usage help message specification and can be used to customize the usage help message.

CommandLine.MutuallyExclusiveArgsException - Exception in picocli

Exception indicating that the user input included multiple arguments from a mutually exclusive group.

CommandLine.Option - Annotation Type in picocli

Annotate fields in your class with @Option and picocli will initialize these fields when matching arguments are specified on the command line.

CommandLine.OverwrittenOptionException - Exception in picocli

Exception indicating that an option for a single-value option field has been specified multiple times on the command line.

CommandLine.ParameterException - Exception in picocli

Exception indicating something went wrong while parsing command line options.

CommandLine.ParameterIndexGapException - Exception in picocli

Exception indicating that there was a gap in the indices of the fields annotated with CommandLine.Parameters.

CommandLine.Parameters - Annotation Type in picocli

Fields annotated with @Parameters will be initialized with positional parameters.

CommandLine.ParentCommand - Annotation Type in picocli

Fields annotated with @ParentCommand will be initialized with the parent command of the current subcommand.

CommandLine.ParseResult - Class in picocli

Encapsulates the result of parsing an array of command line arguments.

CommandLine.ParseResult.Builder - Class in picocli

Builds immutable ParseResult instances.

CommandLine.ParseResult.GroupMatch - Class in picocli

A group's multiplicity specifies how many matches of a group may appear on the command line.

CommandLine.ParseResult.GroupMatchContainer - Class in picocli

Provides information about an CommandLine.ArgGroup that was matched on the command line.

CommandLine.PicocliException - Exception in picocli

Base class of all exceptions thrown by picocli.CommandLine.

CommandLine.PropertiesDefaultProvider - Class in picocli

IDefaultValueProvider implementation that loads default values for command line options and positional parameters from a properties file or Properties object.

CommandLine.Range - Class in picocli

Describes the number of parameters required and accepted by an option or a positional parameter.

CommandLine.RegexTransformer - Class in picocli

A regular expression-based option name transformation for negatable options.

CommandLine.RegexTransformer.Builder - Class in picocli

Builder for creating RegexTransformer objects.

CommandLine.RunAll - Class in picocli

Command line execution strategy that prints help if requested, and otherwise executes the top-level command and all subcommands as Runnable, Callable or Method.

CommandLine.RunFirst - Class in picocli

Command line execution strategy that prints help if requested, and otherwise executes the top-level Runnable or Callable command.

CommandLine.RunLast - Class in picocli

Command line execution strategy that prints help if requested, and otherwise executes the most specific Runnable or Callable subcommand.

CommandLine.ScopeType - Enum in picocli

Specifies the scope of the element.

CommandLine.Spec - Annotation Type in picocli

Fields annotated with @Spec will be initialized with the CommandSpec for the command the field is part of.

CommandLine.Spec.Target - Enum in picocli

Identifies what kind of CommandSpec should be injected.

CommandLine.TraceLevel - Enum in picocli

Enumerates over the trace level values for filtering which internal debug statements should be printed.

CommandLine.Tracer - Class in picocli

Utility class for printing internal debug statements.

CommandLine.TypeConversionException - Exception in picocli

Exception thrown by CommandLine.ITypeConverter implementations to indicate a String could not be converted.

CommandLine.Unmatched - Annotation Type in picocli

Fields annotated with @Unmatched will be initialized with the list of unmatched command line arguments, if any.

CommandLine.UnmatchedArgumentException - Exception in picocli

Exception indicating that a command line argument could not be mapped to any of the fields annotated with CommandLine.Option or CommandLine.Parameters.

CommandLine.UseDefaultConverter - Class in picocli

Converter that can be used to signal to picocli that it should use the default converter.

commandList() - Method in class picocli.CommandLine.Help

Returns a 2-column list with the command names and first line of their header or (if absent) description of the commands returned by CommandLine.Help.subcommands().

commandList(Map<String, CommandLine.Help>) - Method in class picocli.CommandLine.Help

Returns a 2-column list with the command names and first line of their header or (if absent) description of the specified command map.

commandListHeading() - Method in annotation type picocli.CommandLine.Command

Set the heading preceding the subcommands list.

commandListHeading() - Method in class picocli.CommandLine.Model.UsageMessageSpec

Returns the optional heading preceding the subcommand list.

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(String) - Method in class picocli.CommandLine.Model.UsageMessageSpec

Sets the optional heading preceding the subcommand list.

commandNames() - Method in class picocli.shell.jline3.PicocliCommands

commandNamesText(String) - Method in class picocli.CommandLine.Help

Returns a Text object containing the command name and all aliases, separated with the specified separator.

commands(CommandLine.Help.Ansi.IStyle...) - Method in class picocli.CommandLine.Help.ColorScheme.Builder

Adds the specified styles to the registered styles for commands in this color scheme builder and returns this builder.

commandSpec() - Method in class picocli.CommandLine.Help

Returns the CommandSpec model that this Help was constructed with.

commandSpec() - Method in class picocli.CommandLine.Model.Messages

Returns the CommandSpec of this object, never null.

commandSpec() - Method in class picocli.CommandLine.ParseResult

Returns the CommandSpec for the matched command.

commandStyles() - Method in class picocli.CommandLine.Help.ColorScheme.Builder

Returns the registered styles for commands in this color scheme builder.

commandStyles() - Method in class picocli.CommandLine.Help.ColorScheme

Returns the registered styles for commands in this color scheme.

commandText(String) - Method in class picocli.CommandLine.Help.ColorScheme

Returns a Text with all command styles applied to the specified command string.

compareTo(CommandLine.Range) - Method in class picocli.CommandLine.Range

compileCompleters() - Method in class picocli.shell.jline3.PicocliCommands

complete(String, int, List<CharSequence>) - Method in class picocli.shell.jline2.PicocliJLineCompleter

Populates the specified list with completion candidates for the specified buffer based on the command specification that this shell was constructed with.

complete(LineReader, ParsedLine, List<Candidate>) - Method in class picocli.shell.jline3.PicocliJLineCompleter

Populates candidates with a list of possible completions for the command line.

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.

completionCandidates() - Method in annotation type picocli.CommandLine.Option

Use this attribute to specify an Iterable<String> class that generates completion candidates for this option.

completionCandidates() - Method in annotation type picocli.CommandLine.Parameters

Use this attribute to specify an Iterable<String> class that generates completion candidates for this positional parameter.

concat(String) - Method in class picocli.CommandLine.Help.Ansi.Text

Returns a copy of this Text instance with the specified text concatenated to the end.

concat(CommandLine.Help.Ansi.Text) - Method in class picocli.CommandLine.Help.Ansi.Text

Returns a copy of this Text instance with the specified text concatenated to the end.

consumeParameters(Stack<String>, CommandLine.Model.ArgSpec, CommandLine.Model.CommandSpec) - Method in interface picocli.CommandLine.IParameterConsumer

Consumes as many of the specified command line arguments as needed by popping them off the specified Stack.

container() - Method in class picocli.CommandLine.ParseResult.GroupMatch

Returns the container GroupMatchContainer of this match.

contains(int) - Method in class picocli.CommandLine.Range

Returns true if this Range includes the specified value, false otherwise.

convert(String) - Method in interface picocli.CommandLine.ITypeConverter

Converts the specified command line argument value to some domain object.

convert(String) - Method in class picocli.CommandLine.UseDefaultConverter

Always throws UnsupportedOperationException.

converter() - Method in annotation type picocli.CommandLine.Option

Optionally specify one or more CommandLine.ITypeConverter classes to use to convert the command line argument into a strongly typed value (or key-value pair for map fields).

converter() - Method in annotation type picocli.CommandLine.Parameters

Optionally specify one or more CommandLine.ITypeConverter classes to use to convert the command line argument into a strongly typed value (or key-value pair for map fields).

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() - Static method in class picocli.CommandLine.Model.CommandSpec

Creates and returns a new CommandSpec without any associated user object.

create(Class<K>) - Method in interface picocli.CommandLine.IFactory

Returns an instance of the specified class.

create(Class<K>) - Method in class picocli.shell.jline3.PicocliCommands.PicocliCommandsFactory

create(Class<K>) - Method in class picocli.spring.PicocliSpringFactory

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

createCaseInsensitive() - Static method in class picocli.CommandLine.RegexTransformer

Returns the RegexTransformer for case-insensitive negatable options.

createCommandLine() - Method in class picocli.groovy.PicocliBaseScript

Deprecated.

Create and returns a new CommandLine instance.

createCommandLine() - Method in class picocli.groovy.PicocliBaseScript2

Create and returns a new CommandLine instance.

createDefault() - Static method in class picocli.CommandLine.RegexTransformer

Returns the RegexTransformer used by default for negatable options.

createDefaultLayout() - Method in class picocli.CommandLine.Help

Returns a Layout instance configured with the user preferences captured in this Help instance.

createDefaultLayout(List<CommandLine.Model.OptionSpec>, List<CommandLine.Model.PositionalParamSpec>, CommandLine.Help.ColorScheme) - Method in class picocli.CommandLine.Help

Returns a Layout instance configured with the user preferences captured in this Help instance.

createDefaultOptionRenderer() - Method in class picocli.CommandLine.Help

Returns a new default OptionRenderer which converts Options to five columns of text to match the default TextTable column layout.

createDefaultOptionSort() - Method in class picocli.CommandLine.Help

Returns a comparator for sorting options, or null, depending on the settings for this command.

createDefaultParameterRenderer() - Method in class picocli.CommandLine.Help

Returns a new default ParameterRenderer which converts positional parameters to four columns of text to match the default TextTable column layout.

createDefaultParamLabelRenderer() - Method in class picocli.CommandLine.Help

Returns a new default param label renderer that separates option parameters from their option name with the specified separator string, and, unless CommandLine.Model.ArgSpec.hideParamSyntax() is true, surrounds optional parameters with '[' and ']' characters and uses ellipses ("...") to indicate that any number of a parameter are allowed.

createDetailedSynopsisCommandText() - Method in class picocli.CommandLine.Help

Returns a Text object containing a partial detailed synopsis showing only the subcommands, starting with a " " space.

createDetailedSynopsisEndOfOptionsText() - Method in class picocli.CommandLine.Help

Returns a Text object containing a partial detailed synopsis showing only the end of options delimiter (if enabled), starting with a " " space.

createDetailedSynopsisGroupsText(Set<CommandLine.Model.ArgSpec>) - Method in class picocli.CommandLine.Help

Returns a Text object containing a partial detailed synopsis showing only the options and positional parameters in the specified validating groups, starting with a " " space.

createDetailedSynopsisOptionsText(Collection<CommandLine.Model.ArgSpec>, Comparator<CommandLine.Model.OptionSpec>, boolean) - Method in class picocli.CommandLine.Help

Returns a Text object containing a partial detailed synopsis showing only the options, starting with a " " space.

createDetailedSynopsisOptionsText(Collection<CommandLine.Model.ArgSpec>, List<CommandLine.Model.OptionSpec>, Comparator<CommandLine.Model.OptionSpec>, boolean) - Method in class picocli.CommandLine.Help

Returns a Text object containing a partial detailed synopsis showing only the specified options, starting with a " " space.

createDetailedSynopsisPositionalsText(Collection<CommandLine.Model.ArgSpec>) - Method in class picocli.CommandLine.Help

Returns a Text object containing a partial detailed synopsis showing only the positional parameters, starting with a " " space.

createHeading(String, Object...) - Method in class picocli.CommandLine.Help

Returns a String that can be used as a help section heading.

createLabelRenderer(CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.Model.ArgGroupSpec

createMinimalOptionRenderer() - Static method in class picocli.CommandLine.Help

Returns a new minimal OptionRenderer which converts Options to a single row with two columns of text: an option name and a description.

createMinimalParameterRenderer() - Static method in class picocli.CommandLine.Help

Returns a new minimal ParameterRenderer which converts positional parameters to a single row with two columns of text: an option name and a description.

createMinimalParamLabelRenderer() - Static method in class picocli.CommandLine.Help

Returns a value renderer that returns the paramLabel if defined or the field name otherwise.

createShortOptionArityAndNameComparator() - Static method in class picocli.CommandLine.Help

Sorts OptionSpecs by their option max arity first, by min arity next, and by option name last.

createShortOptionNameComparator() - Static method in class picocli.CommandLine.Help

Sorts OptionSpecs by their option name in case-insensitive alphabetic order.

createTextTable(Map<?, ?>) - Method in class picocli.CommandLine.Help

Returns a 2-column TextTable containing data from the specified map: the keys are put in the left column and the map values are in the right column.

CSI - Static variable in interface picocli.CommandLine.Help.Ansi.IStyle

The Control Sequence Introducer (CSI) escape sequence "\u001b[".

customMarkupMap() - Method in class picocli.CommandLine.Help.ColorScheme.Builder

Returns the custom mapping from markup names (the names of the CommandLine.Help.Ansi.Style enum constants, like bold, italic, fg_blue, bg_green, etc) to CommandLine.Help.Ansi.IStyle objects in this color scheme.

customMarkupMap() - Method in class picocli.CommandLine.Help.ColorScheme

Returns the custom mapping from markup names (the names of the CommandLine.Help.Ansi.Style enum constants, like bold, italic, fg_blue, bg_green, etc) to CommandLine.Help.Ansi.IStyle objects in this color scheme.

customMarkupMap(Map<String, CommandLine.Help.Ansi.IStyle>) - Method in class picocli.CommandLine.Help.ColorScheme.Builder

Sets the custom mapping from markup names (the names of the CommandLine.Help.Ansi.Style enum constants, like bold, italic, fg_blue, bg_green, etc) to CommandLine.Help.Ansi.IStyle objects in this color scheme.

customSynopsis() - Method in annotation type picocli.CommandLine.Command

Specify one or more custom synopsis lines to display instead of an auto-generated synopsis.

customSynopsis() - Method in class picocli.CommandLine.Model.UsageMessageSpec

Returns the optional custom synopsis lines to use instead of the auto-generated synopsis.

customSynopsis(Object...) - Method in class picocli.CommandLine.Help

Returns command custom synopsis as a string.

customSynopsis(String...) - Method in class picocli.CommandLine.Model.UsageMessageSpec

Sets the optional custom synopsis lines to use instead of the auto-generated synopsis.

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