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

A

abbreviate(String) - Static method in class picocli.codegen.annotation.processing.TypedMember
 
abbreviate(String) - Static method in class picocli.CommandLine.Model.TypedMember
 
abbreviatedOptionsAllowed - Variable in class picocli.CommandLine.Model.ParserSpec
 
abbreviatedOptionsAllowed() - Method in class picocli.CommandLine.Model.ParserSpec
 
abbreviatedOptionsAllowed(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
abbreviatedSubcommandsAllowed - Variable in class picocli.CommandLine.Model.ParserSpec
 
abbreviatedSubcommandsAllowed() - Method in class picocli.CommandLine.Model.ParserSpec
 
abbreviatedSubcommandsAllowed(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
abbreviatedSynopsis() - Method in class picocli.CommandLine.Help
Generates a generic synopsis like <command name> [OPTIONS] [PARAM1 [PARAM2]...], omitting parts that don't apply to the command (e.g., does not show [OPTIONS] if the command has no options).
abbreviateSynopsis - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
abbreviateSynopsis() - Method in annotation type picocli.CommandLine.Command
Specify true to generate an abbreviated synopsis like "<main> [OPTIONS] [PARAMETERS...] [COMMAND]".
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.
AbbreviationMatcher() - Constructor for class picocli.CommandLine.AbbreviationMatcher
 
AbstractCommandSpecProcessor - Class in picocli.codegen.annotation.processing
Abstract annotation processor for @picocli.* annotations that produces a set of CommandLine.Model.CommandSpec objects built from the annotated source code.
AbstractCommandSpecProcessor() - Constructor for class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
AbstractCommandSpecProcessor.Context - Class in picocli.codegen.annotation.processing
 
AbstractCommandSpecProcessor.Graph - Class in picocli.codegen.annotation.processing
Helper class for topologically sorting ArgGroups.
AbstractCommandSpecProcessor.NullFactory - Class in picocli.codegen.annotation.processing
 
AbstractCompositeGeneratorProcessor - Class in picocli.codegen.aot.graalvm.processor
Base class for writing annotation processors that do something with CommandSpec models.
AbstractCompositeGeneratorProcessor() - Constructor for class picocli.codegen.aot.graalvm.processor.AbstractCompositeGeneratorProcessor
 
AbstractGenerator - Class in picocli.codegen.aot.graalvm.processor
 
AbstractGenerator(ProcessingEnvironment, String, String) - Constructor for class picocli.codegen.aot.graalvm.processor.AbstractGenerator
 
AbstractHandler() - Constructor for class picocli.CommandLine.AbstractHandler
Deprecated.
 
AbstractParseResultHandler() - Constructor for class picocli.CommandLine.AbstractParseResultHandler
Deprecated.
 
accessible - Variable in class picocli.CommandLine.Model.TypedMember
 
accessibleField(Class<?>, String) - Static method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
actualGenericTypeArguments - Variable in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
actualGenericTypeArguments - Variable in class picocli.CommandLine.Model.RuntimeTypeInfo
 
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.
addAll(String[]) - Method in class picocli.CommandLine.Model.UnmatchedArgsBinding
 
addAll(List<CommandLine.Help.Ansi.IStyle>, CommandLine.Help.Ansi.IStyle...) - Method in class picocli.CommandLine.Help.ColorScheme.Builder
 
addAllOptions(List<CommandLine.Model.OptionSpec>, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help.Layout
addAllPositionalParameters(List<CommandLine.Model.PositionalParamSpec>, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help.Layout
addAllSubcommands(Map<String, CommandLine>) - Method in class picocli.CommandLine.Help
Registers all specified subcommands with this Help.
addAllWithPrefix(ResourceBundle, String, Set<String>, List<String>) - Static method in class picocli.CommandLine.Model.Messages
 
addArg(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Adds the specified argument to the list of options and positional parameters that depend on this group.
addArg(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.Model.CommandSpec
 
addArgGroup(CommandLine.Model.ArgGroupSpec) - Method in class picocli.CommandLine.Model.CommandSpec
Adds the specified argument group to the groups in this command.
addArgGroup(CommandLine.Model.ArgGroupSpec, Set<CommandLine.Model.OptionSpec>, Set<CommandLine.Model.PositionalParamSpec>) - Method in class picocli.CommandLine.Model.CommandSpec
 
addCandidatesForArgsFollowing(Object, List<CharSequence>) - Static method in class picocli.AutoComplete
 
addCandidatesForArgsFollowing(CommandLine.Model.CommandSpec, List<CharSequence>) - Static method in class picocli.AutoComplete
 
addCandidatesForArgsFollowing(CommandLine.Model.OptionSpec, List<CharSequence>) - Static method in class picocli.AutoComplete
 
addCandidatesForArgsFollowing(CommandLine.Model.PositionalParamSpec, List<CharSequence>) - Static method in class picocli.AutoComplete
 
addCompletionCandidates(Iterable<String>, List<CharSequence>) - Static method in class picocli.AutoComplete
 
addEdge(int, int) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Graph
subgroup is a dependency for group
addEmptyRow() - Method in class picocli.CommandLine.Help.TextTable
Adds the required char[] slots for a new row to the CommandLine.Help.TextTable.columnValues field.
addError(CommandLine.PicocliException) - Method in class picocli.CommandLine.ParseResult.Builder
 
addField(Field) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedClass
 
addField(String, boolean) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedClass
 
addGroupArgsToCommand(CommandLine.Model.ArgGroupSpec, Map<String, CommandLine.Model.ArgGroupSpec>, Set<CommandLine.Model.OptionSpec>, Set<CommandLine.Model.PositionalParamSpec>) - Method in class picocli.CommandLine.Model.CommandSpec
 
addGroupOptionsToListRecursively(List<CommandLine.Model.OptionSpec>) - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
addGroupPositionalsToListRecursively(List<CommandLine.Model.PositionalParamSpec>) - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
addMatch(CommandLine) - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
addMatchedValue(CommandLine.Model.ArgSpec, int, Object, CommandLine.Tracer) - Method in class picocli.CommandLine.ParseResult.GroupMatch
 
addMethod(Method) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedClass
 
addMethod(String, Class...) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedClass
 
addMethod(String, List<String>) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedClass
 
addMethod0(String, String...) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedClass
 
addMethodSubcommands() - Method in annotation type picocli.CommandLine.Command
Specify whether methods annotated with @Command should be registered as subcommands of their enclosing @Command class.
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.
addMixin(String, CommandLine.Model.CommandSpec, CommandLine.Model.IAnnotatedElement) - Method in class picocli.CommandLine.Model.CommandSpec
Adds the specified mixin CommandSpec object to the map of mixins for this command.
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.
addOption(CommandLine.Model.OptionSpec, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help.Layout
Delegates to the option renderer of this layout to obtain text values for the specified CommandLine.Model.OptionSpec, and then calls the CommandLine.Help.Layout.layout(CommandLine.Model.ArgSpec, CommandLine.Help.Ansi.Text[][]) method to write these text values into the correct cells in the TextTable.
addOptionNegative(CommandLine.Model.OptionSpec, CommandLine.Tracer) - Method in class picocli.CommandLine.Model.CommandSpec
 
addOptions(List<CommandLine.Model.OptionSpec>, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help.Layout
addOrExpand(String, List<String>, Set<String>) - Method in class picocli.CommandLine.Interpreter
 
addOriginalStringValue(CommandLine.Model.ArgSpec, String) - Method in class picocli.CommandLine.ParseResult.Builder
 
addOriginalStringValue(CommandLine.Model.ArgSpec, String) - Method in class picocli.CommandLine.ParseResult.GroupMatch
 
addParentCommandElement(CommandLine.Model.IAnnotatedElement) - Method in class picocli.CommandLine.Model.CommandSpec
Adds the specified {@literal @}ParentCommand-annotated program element to the list of elements for this command.
addPattern(String, String, String) - Method in class picocli.CommandLine.RegexTransformer.Builder
Adds the specified negative replacement and synopsis replacement for the specified regular expression.
addPositional(CommandLine.Model.PositionalParamSpec) - Method in class picocli.CommandLine.Model.CommandSpec
Adds the specified positional parameter spec to the list of configured arguments to expect.
addPositionalParam(CommandLine.Model.PositionalParamSpec, int) - Method in class picocli.CommandLine.ParseResult.Builder
Adds the specified PositionalParamSpec to the list of parameters that were matched on the command line.
addPositionalParameter(CommandLine.Model.PositionalParamSpec, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help.Layout
Delegates to the parameter renderer of this layout to obtain text values for the specified positional parameter, and then calls CommandLine.Help.Layout.layout(CommandLine.Model.ArgSpec, CommandLine.Help.Ansi.Text[][]) to write these text values into the correct cells in the TextTable.
addPositionalParameters(List<CommandLine.Model.PositionalParamSpec>, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help.Layout
addPostponedRequiredArgs(Collection<CommandLine.Model.ArgSpec>, List<CommandLine.Model.ArgSpec>) - Method in class picocli.CommandLine.Interpreter
 
addRowValues(String...) - Method in class picocli.CommandLine.Help.TextTable
Delegates to CommandLine.Help.TextTable.addRowValues(CommandLine.Help.Ansi.Text...), after ensuring that multi-line values are layed out in the correct row and column.
addRowValues(CommandLine.Help.Ansi.Text...) - Method in class picocli.CommandLine.Help.TextTable
Adds a new empty row, then calls putValue for each of the specified values, adding more empty rows if the return value indicates that the value spanned multiple columns or was wrapped to multiple rows.
addSpecElement(CommandLine.Model.IAnnotatedElement) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Adds the specified {@literal @}Spec annotated program element to the list of spec elements for this group.
addSpecElement(CommandLine.Model.IAnnotatedElement) - Method in class picocli.CommandLine.Model.CommandSpec
Adds the specified {@literal @}Spec-annotated program element to the list of elements for this command.
addStringValue(CommandLine.Model.ArgSpec, String) - Method in class picocli.CommandLine.ParseResult.Builder
 
addStyledSection(int, int, String, String) - Method in class picocli.CommandLine.Help.Ansi.Text
 
addSubcommand(Object) - Method in class picocli.CommandLine
Registers a subcommand with the name obtained from the @Command(name = "...") annotation attribute of the specified command.
addSubcommand(String, Object) - Method in class picocli.CommandLine
Registers a subcommand with the specified name.
addSubcommand(String, Object) - Method in class picocli.CommandLine.Help
addSubcommand(String, Object, String...) - Method in class picocli.CommandLine
Registers a subcommand with the specified name and all specified aliases.
addSubcommand(String, CommandLine) - Method in class picocli.CommandLine.Model.CommandSpec
Adds the specified subcommand with the specified name.
addSubcommand(String, CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.Model.CommandSpec
Adds the specified subcommand with the specified name.
addSubgroup(CommandLine.Model.ArgGroupSpec) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Adds the specified group to the list of subgroups that this group is composed of.
addToInitialized(CommandLine.Model.ArgSpec, Set<CommandLine.Model.ArgSpec>) - Method in class picocli.CommandLine.Interpreter
 
addTrailingDefaultLine(List<CommandLine.Help.Ansi.Text[]>, CommandLine.Model.ArgSpec, CommandLine.Help.ColorScheme) - Static method in class picocli.CommandLine.Help
 
addTypedValues(CommandLine.Model.ArgSpec, int, Object) - Method in class picocli.CommandLine.ParseResult.Builder
 
addUnmatched(int, String) - Method in class picocli.CommandLine.ParseResult.Builder
Adds the specified command line argument to the list of unmatched command line arguments, and remembers the position of this argument.
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.
addUserInputToList(CommandLine.Model.ArgSpec, List<Object>, int, String) - Method in class picocli.CommandLine.Interpreter
 
addValueToListInMap(Map<K, List<T>>, K, T) - Static method in class picocli.CommandLine
 
adjacencyList - Variable in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Graph
 
adjustCJK() - Method in class picocli.CommandLine.Help
 
adjustForType(CommandLine.Range, CommandLine.Model.IAnnotatedElement) - Static method in class picocli.CommandLine.Range
 
adjustLineBreaksForWideCJKCharacters - Variable in class picocli.CommandLine.Help.TextTable
 
adjustLineBreaksForWideCJKCharacters - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
adjustLineBreaksForWideCJKCharacters() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns whether line breaks should take wide Chinese, Japanese and Korean characters into account for line-breaking purposes.
adjustLineBreaksForWideCJKCharacters(boolean) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets whether line breaks should take wide Chinese, Japanese and Korean characters into account, and returns this UsageMessageSpec.
adjustRelativeIndices(CommandLine.Model.PositionalParamSpec) - Method in class picocli.CommandLine.Model.CommandSpec
Adjusts the index of the new positional param and all others with relative indices that were sorted after this positional.
aliases - Variable in class picocli.CommandLine.Help
 
aliases - Variable in class picocli.CommandLine.Model.CommandSpec
 
aliases() - Method in annotation type picocli.CommandLine.Command
Alternative command names by which this subcommand is recognized on the command line.
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.
all() - Method in class picocli.codegen.aot.graalvm.DynamicProxyConfigGenerator.Visitor
 
ALL - Static variable in class picocli.codegen.annotation.processing.AnnotationValidator
 
allCommands - Variable in class picocli.codegen.aot.graalvm.processor.AbstractCompositeGeneratorProcessor
 
allCommands - Variable in class picocli.CommandLine.Help
 
allOptionsNested() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns all options configured for this group and all subgroups.
allPositionalParametersNested() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns all positional parameters configured for this group and all subgroups.
allSubcommands() - Method in class picocli.CommandLine.Help
Returns the map of all subcommand Help instances (including hidden commands) for this command Help.
ALWAYS - picocli.CommandLine.Help.Visibility
 
anchor - Variable in class picocli.CommandLine.Range
 
anchor() - Method in class picocli.CommandLine.Range
Returns the anchor position that this Range is relative to, or CommandLine.Range.min() if this Range is absolute.
andExit(int) - Method in class picocli.CommandLine.AbstractHandler
Deprecated.
use CommandLine.execute(String...) instead, and call System.exit() in the application.
annotatedElement - Variable in class picocli.codegen.annotation.processing.MixinInfo
 
annotatedElement - Variable in class picocli.CommandLine.Model.ArgSpec
 
annotatedElement - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
annotatedElement() - Method in class picocli.codegen.annotation.processing.MixinInfo
 
AnnotatedElementHolder - Class in picocli.codegen.annotation.processing
Implementation of the CommandLine.Model.IGetter and CommandLine.Model.ISetter interface that allows custom CommandSpec annotation processors to inspect ArgSpec objects to discover what program element was annotated with @Option or @Parameters.
AnnotatedElementHolder(Element) - Constructor for class picocli.codegen.annotation.processing.AnnotatedElementHolder
Constructs a new AnnotatedElementHolder with the specified element
annotationTypes() - Method in class picocli.CommandLine.Model.TypedMember
 
AnnotationValidator - Class in picocli.codegen.annotation.processing
 
AnnotationValidator(ProcessingEnvironment) - Constructor for class picocli.codegen.annotation.processing.AnnotationValidator
 
ansi - Variable in class picocli.CommandLine.Help.ColorScheme
 
ansi - Variable in class picocli.CommandLine.Help.ColorScheme.Builder
 
ansi - Variable in class picocli.CommandLine.HelpCommand
 
ansi() - Method in class picocli.CommandLine.AbstractHandler
ansi() - Method in class picocli.CommandLine.Help
Returns whether ANSI escape codes are enabled or not.
ansi() - Method in class picocli.CommandLine.Help.ColorScheme
Returns the Ansi setting of this color scheme.
ansi() - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Returns the Ansi setting of this color scheme builder.
ansi(CommandLine.Help.Ansi) - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Returns the Ansi setting of this color scheme builder.
Ansi() - Constructor for enum picocli.CommandLine.Help.Ansi
 
ansiPossible() - Static method in enum picocli.CommandLine.Help.Ansi
 
App() - Constructor for class picocli.AutoComplete.App
 
App() - Constructor for class picocli.codegen.aot.graalvm.DynamicProxyConfigGenerator.App
 
App() - Constructor for class picocli.codegen.aot.graalvm.JniConfigGenerator.App
 
App() - Constructor for class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.App
 
App() - Constructor for class picocli.codegen.aot.graalvm.ResourceConfigGenerator.App
 
App() - Constructor for class picocli.codegen.docgen.manpage.ManPageGenerator.App
 
append(String) - Method in class picocli.CommandLine.Help.Ansi.Text
append(CommandLine.Help.Ansi.Text) - Method in class picocli.CommandLine.Help.Ansi.Text
apply(CharSequence) - Method in class picocli.AutoComplete.Bashify
 
apply(CharSequence) - Method in class picocli.AutoComplete.NullFunction
 
apply(String, List<CommandLine.Help.Ansi.IStyle>) - Method in enum picocli.CommandLine.Help.Ansi
apply(String, List<CommandLine.Help.Ansi.IStyle>) - Method in class picocli.CommandLine.Help.ColorScheme
Returns a new Text object where all the specified styles are applied to the full length of the specified plain text.
apply(T) - Method in interface picocli.AutoComplete.Function
 
applyDefault(CommandLine.IDefaultValueProvider, CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.Interpreter
 
applyDefaultValues(List<CommandLine.Model.ArgSpec>, Set<CommandLine.Model.ArgSpec>) - Method in class picocli.CommandLine.Interpreter
 
applyGroupDefaults(CommandLine.IDefaultValueProvider, CommandLine.Model.ArgGroupSpec, List<CommandLine.Model.ArgSpec>, Set<CommandLine.Model.ArgSpec>) - Method in class picocli.CommandLine.Interpreter
 
applyInitialValue(CommandLine.Tracer) - Method in class picocli.CommandLine.Model.ArgSpec
 
applyModelTransformations() - Method in class picocli.CommandLine
Apply transformers to command spec recursively.
applyOption(CommandLine.Model.ArgSpec, boolean, CommandLine.LookBehind, boolean, CommandLine.Range, Stack<String>, Set<CommandLine.Model.ArgSpec>, String) - Method in class picocli.CommandLine.Interpreter
 
applySystemProperties() - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Replaces colors and styles in this scheme builder with ones specified in system properties, and returns this builder.
applyValuesToArrayField(CommandLine.Model.ArgSpec, boolean, CommandLine.LookBehind, boolean, CommandLine.Range, Stack<String>, Set<CommandLine.Model.ArgSpec>, String) - Method in class picocli.CommandLine.Interpreter
 
applyValuesToCollectionField(CommandLine.Model.ArgSpec, boolean, CommandLine.LookBehind, boolean, CommandLine.Range, Stack<String>, Set<CommandLine.Model.ArgSpec>, String) - Method in class picocli.CommandLine.Interpreter
 
applyValuesToMapField(CommandLine.Model.ArgSpec, CommandLine.LookBehind, boolean, CommandLine.Range, Stack<String>, Set<CommandLine.Model.ArgSpec>, String) - Method in class picocli.CommandLine.Interpreter
 
applyValueToSingleValuedField(CommandLine.Model.ArgSpec, boolean, CommandLine.LookBehind, boolean, CommandLine.Range, Stack<String>, Set<CommandLine.Model.ArgSpec>, String) - Method in class picocli.CommandLine.Interpreter
 
argCount() - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
argGroupElements - Variable in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Context
 
argGroups() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the argument groups in this command.
ArgGroupSpec(CommandLine.Model.ArgGroupSpec.Builder) - Constructor for class picocli.CommandLine.Model.ArgGroupSpec
 
args - Variable in class picocli.CommandLine.Model.ArgGroupSpec
 
args - Variable in class picocli.CommandLine.Model.ArgGroupSpec.Builder
 
args - Variable in class picocli.CommandLine.Model.CommandSpec
 
args() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the options and positional parameters in this group; may be empty but not null.
args() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the list of options and positional parameters that depend on this group.
args() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the list of all options and positional parameters configured for this command.
argSpec - Variable in exception picocli.CommandLine.ParameterException
 
ArgSpec(CommandLine.Model.ArgSpec.Builder<T>) - Constructor for class picocli.CommandLine.Model.ArgSpec
Constructs a new ArgSpec.
arity - Variable in class picocli.CommandLine.Model.ArgSpec
 
arity - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
arity() - Method in class picocli.CommandLine.Model.ArgSpec
Returns how many arguments this option or positional parameter requires.
arity() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns how many arguments this option or positional parameter requires.
arity() - Method in annotation type picocli.CommandLine.Option
Specifies the minimum number of required parameters and the maximum number of accepted parameters.
arity() - Method in annotation type picocli.CommandLine.Parameters
Specifies the minimum number of required parameters and the maximum number of accepted parameters.
arity(String) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets how many arguments this option or positional parameter requires, and returns this builder.
arity(CommandLine.Range) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets how many arguments this option or positional parameter requires, and returns this builder.
aritySatisfiedByAttachedOptionParam - Variable in class picocli.CommandLine.Model.ParserSpec
 
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.
arr(String[], String[], String[]) - Method in class picocli.CommandLine.Model.UsageMessageSpec
 
asCommandLineList() - Method in class picocli.CommandLine.ParseResult
Returns this ParseResult as a list of CommandLine objects, one for each matched command/subcommand.
asScope(Object) - Static method in class picocli.CommandLine.Model.ObjectScope
 
Assert - Class in picocli.codegen.util
Utility class providing some defensive coding convenience methods.
Assert() - Constructor for class picocli.codegen.util.Assert
 
Assert() - Constructor for class picocli.CommandLine.Assert
 
assertNoDuplicateAnnotations(CommandLine.Model.TypedMember, Class<? extends Annotation>, Class<? extends Annotation>...) - Static method in class picocli.CommandLine.Model.CommandReflection
 
assertNoMissingMandatoryParameter(CommandLine.Model.ArgSpec, Stack<String>, int, CommandLine.Range) - Method in class picocli.CommandLine.Interpreter
 
assertNoMissingParameters(CommandLine.Model.ArgSpec, CommandLine.Range, Stack<String>) - Method in class picocli.CommandLine.Interpreter
 
assertOneEntry(Map<Element, Integer>, String) - Method in class picocli.codegen.annotation.processing.AnnotationValidator
 
assertTrue(boolean, String) - Static method in class picocli.CommandLine.Assert
 
assertTrue(boolean, CommandLine.IHelpSectionRenderer) - Static method in class picocli.CommandLine.Assert
 
AT_FILE_POSITIONAL_PARAM - Variable in class picocli.CommandLine.Help
 
atFileCommentChar - Variable in class picocli.CommandLine.Model.ParserSpec
 
atFileCommentChar() - Method in class picocli.CommandLine.Model.ParserSpec
 
atFileCommentChar(Character) - Method in class picocli.CommandLine.Model.ParserSpec
 
atFileParameterList() - Method in class picocli.CommandLine.Help
Returns the section of the usage help message that lists the @-file and its description.
ATTACHED - picocli.CommandLine.LookBehind
 
ATTACHED_WITH_SEPARATOR - picocli.CommandLine.LookBehind
 
AUTO - picocli.CommandLine.Help.Ansi
Only emit ANSI escape codes if the platform supports it and system property "picocli.ansi" is not set to any value other than "true" (case insensitive).
AutoComplete - Class in picocli
Stand-alone tool that generates bash auto-complete scripts for picocli-based command line applications.
AutoComplete() - Constructor for class picocli.AutoComplete
 
AutoComplete.App - Class in picocli
CLI command class for generating completion script.
AutoComplete.Bashify - Class in picocli
Drops all characters that are not valid for bash function and identifier names.
AutoComplete.BooleanArgFilter - Class in picocli
 
AutoComplete.CommandDescriptor - Class in picocli
 
AutoComplete.Function<T,​V> - Interface in picocli
 
AutoComplete.GenerateCompletion - Class in picocli
Command that generates a Bash/ZSH completion script for its top-level command.
AutoComplete.NullFunction - Class in picocli
 
AutoComplete.Predicate<T> - Interface in picocli
 
autoCompleteScript - Variable in class picocli.AutoComplete.App
 
AutoHelpMixin() - Constructor for class picocli.CommandLine.AutoHelpMixin
 
autoWidth - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
autoWidth() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns whether picocli should attempt to detect the terminal size and adjust the usage help message width to take the full terminal width.
autoWidth(boolean) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets whether picocli should attempt to detect the terminal size and adjust the usage help message width to take the full terminal width.
auxiliaryTypes - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
auxiliaryTypes - Variable in class picocli.CommandLine.Model.RuntimeTypeInfo
 
auxiliaryTypes() - Method in class picocli.CommandLine.Model.ArgSpec
Returns auxiliary type information used when the CommandLine.Model.ArgSpec.type() is a generic type like Collection, Map or Optional; returns the concrete type when CommandLine.Model.ArgSpec.type() is an abstract class, otherwise, returns the same as CommandLine.Model.ArgSpec.type().
auxiliaryTypes() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns auxiliary type information used when the CommandLine.Model.ArgSpec.Builder.type() is a generic container like Collection, Map, Optional or an abstract class.
auxiliaryTypes(Class<?>...) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets auxiliary type information, and returns this builder.
auxTypeMirrors - Variable in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 

B

BASE_PATH - Static variable in class picocli.codegen.aot.graalvm.processor.NativeImageConfigGeneratorProcessor
Base path where generated files will be written to: "META-INF/native-image/picocli-generated/".
bash(String, File, File, CommandLine) - Static method in class picocli.AutoComplete
Generates source code for an autocompletion bash script for the specified picocli-based application, and writes this script to the specified out file, and optionally writes an invocation script to the specified command file.
bash(String, CommandLine) - Static method in class picocli.AutoComplete
Generates and returns the source code for an autocompletion bash script for the specified picocli-based application.
bashify(CharSequence) - Static method in class picocli.AutoComplete
 
Bashify() - Constructor for class picocli.AutoComplete.Bashify
 
beforeMatchingGroupElement(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.ParseResult.Builder
 
bg(String) - Static method in enum picocli.CommandLine.Help.Ansi.Style
Parses the specified style markup and returns the associated style.
bg_black - picocli.CommandLine.Help.Ansi.Style
 
bg_blue - picocli.CommandLine.Help.Ansi.Style
 
bg_cyan - picocli.CommandLine.Help.Ansi.Style
 
bg_green - picocli.CommandLine.Help.Ansi.Style
 
bg_magenta - picocli.CommandLine.Help.Ansi.Style
 
bg_red - picocli.CommandLine.Help.Ansi.Style
 
bg_white - picocli.CommandLine.Help.Ansi.Style
 
bg_yellow - picocli.CommandLine.Help.Ansi.Style
 
BigDecimalConverter() - Constructor for class picocli.CommandLine.BuiltIn.BigDecimalConverter
 
BigIntegerConverter() - Constructor for class picocli.CommandLine.BuiltIn.BigIntegerConverter
 
blink - picocli.CommandLine.Help.Ansi.Style
 
blockingFailure() - Method in class picocli.CommandLine.ParseResult.GroupValidationResult
FAILURE_PRESENT or FAILURE_PARTIAL
bold - picocli.CommandLine.Help.Ansi.Style
 
BOLD - Static variable in class picocli.codegen.docgen.manpage.ManPageGenerator
 
BooleanArgFilter() - Constructor for class picocli.AutoComplete.BooleanArgFilter
 
BooleanConverter() - Constructor for class picocli.CommandLine.BuiltIn.BooleanConverter
 
booleanValue(CommandLine.Model.ArgSpec, Object) - Method in class picocli.CommandLine.Interpreter
 
build() - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Creates and returns a new ColorScheme with the values configured on this builder.
build() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns a valid ArgGroupSpec instance.
build() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
 
build() - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Returns a valid OptionSpec instance.
build() - Method in class picocli.CommandLine.Model.PositionalParamSpec.Builder
Returns a valid PositionalParamSpec instance.
build() - Method in class picocli.CommandLine.ParseResult.Builder
Creates and returns a new ParseResult instance for this builder's configuration.
build() - Method in class picocli.CommandLine.RegexTransformer.Builder
 
buildArgForMember(CommandLine.Model.IAnnotatedElement, CommandLine.IFactory) - Static method in class picocli.CommandLine.Model.CommandReflection
 
buildArgGroup(Element, AbstractCommandSpecProcessor.Context, RoundEnvironment) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
buildArgGroupForMember(CommandLine.Model.IAnnotatedElement, CommandLine.IFactory, CommandLine.Model.CommandSpec) - Static method in class picocli.CommandLine.Model.CommandReflection
 
buildArgGroups(RoundEnvironment, AbstractCommandSpecProcessor.Context) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
buildCommand(Element, AbstractCommandSpecProcessor.Context, RoundEnvironment) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
buildCommands(RoundEnvironment, AbstractCommandSpecProcessor.Context) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
builder() - Static method in class picocli.CommandLine.Model.ArgGroupSpec
builder() - Static method in class picocli.CommandLine.Model.PositionalParamSpec
 
builder(String[]) - Static method in class picocli.CommandLine.Model.OptionSpec
 
builder(String, String...) - Static method in class picocli.CommandLine.Model.OptionSpec
 
builder(CommandLine.Model.CommandSpec) - Static method in class picocli.CommandLine.ParseResult
Creates and returns a new ParseResult.Builder for the specified command spec.
builder(CommandLine.Model.IAnnotatedElement) - Static method in class picocli.CommandLine.Model.ArgGroupSpec
Returns a new CommandLine.Model.ArgGroupSpec.Builder associated with the specified annotated element.
builder(CommandLine.Model.IAnnotatedElement, CommandLine.IFactory) - Static method in class picocli.CommandLine.Model.OptionSpec
 
builder(CommandLine.Model.IAnnotatedElement, CommandLine.IFactory) - Static method in class picocli.CommandLine.Model.PositionalParamSpec
 
builder(CommandLine.Model.OptionSpec) - Static method in class picocli.CommandLine.Model.OptionSpec
Returns a Builder initialized from the specified OptionSpec.
builder(CommandLine.Model.PositionalParamSpec) - Static method in class picocli.CommandLine.Model.PositionalParamSpec
Returns a Builder initialized from the specified PositionalSpec.
Builder() - Constructor for class picocli.CommandLine.Help.ColorScheme.Builder
Constructs an empty color scheme builder with Ansi.AUTO.
Builder() - Constructor for class picocli.CommandLine.Model.ArgGroupSpec.Builder
 
Builder() - Constructor for class picocli.CommandLine.Model.ArgSpec.Builder
 
Builder() - Constructor for class picocli.CommandLine.Model.PositionalParamSpec.Builder
 
Builder() - Constructor for class picocli.CommandLine.RegexTransformer.Builder
Constructs an empty builder.
Builder(String[]) - Constructor for class picocli.CommandLine.Model.OptionSpec.Builder
 
Builder(CommandLine.Help.Ansi) - Constructor for class picocli.CommandLine.Help.ColorScheme.Builder
Constructs an empty color scheme builder with the specified Ansi value.
Builder(CommandLine.Help.ColorScheme) - Constructor for class picocli.CommandLine.Help.ColorScheme.Builder
Constructs a color scheme builder with all attributes copied from the specified color scheme.
Builder(CommandLine.Model.ArgSpec) - Constructor for class picocli.CommandLine.Model.ArgSpec.Builder
 
Builder(CommandLine.Model.CommandSpec) - Constructor for class picocli.CommandLine.ParseResult.Builder
 
Builder(CommandLine.Model.IAnnotatedElement) - Constructor for class picocli.CommandLine.Model.ArgGroupSpec.Builder
 
Builder(CommandLine.Model.IAnnotatedElement) - Constructor for class picocli.CommandLine.Model.ArgSpec.Builder
 
Builder(CommandLine.Model.IAnnotatedElement, CommandLine.IFactory) - Constructor for class picocli.CommandLine.Model.OptionSpec.Builder
 
Builder(CommandLine.Model.IAnnotatedElement, CommandLine.IFactory) - Constructor for class picocli.CommandLine.Model.PositionalParamSpec.Builder
 
Builder(CommandLine.Model.OptionSpec) - Constructor for class picocli.CommandLine.Model.OptionSpec.Builder
 
Builder(CommandLine.Model.PositionalParamSpec) - Constructor for class picocli.CommandLine.Model.PositionalParamSpec.Builder
 
Builder(CommandLine.Option, CommandLine.Model.IAnnotatedElement, CommandLine.IFactory) - Constructor for class picocli.CommandLine.Model.ArgSpec.Builder
 
Builder(CommandLine.Parameters, CommandLine.Model.IAnnotatedElement, CommandLine.IFactory) - Constructor for class picocli.CommandLine.Model.ArgSpec.Builder
 
Builder(CommandLine.RegexTransformer) - Constructor for class picocli.CommandLine.RegexTransformer.Builder
Constructs a builder populated with the values from the specified RegexTransformer.
builderCapacity - Variable in class picocli.CommandLine.Model.PositionalParamSpec
 
buildMixin(Element, RoundEnvironment, AbstractCommandSpecProcessor.Context) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
buildMixinForMember(CommandLine.Model.IAnnotatedElement, CommandLine.IFactory) - Static method in class picocli.CommandLine.Model.CommandReflection
 
buildMixins(RoundEnvironment, AbstractCommandSpecProcessor.Context) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
buildOption(Element, AbstractCommandSpecProcessor.Context) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
buildOptions(RoundEnvironment, AbstractCommandSpecProcessor.Context) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
buildOptionsAndPositionalsFromMethodParameters(ExecutableElement, CommandLine.Model.CommandSpec, AbstractCommandSpecProcessor.Context) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
buildParameter(Element, AbstractCommandSpecProcessor.Context) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
buildParameters(RoundEnvironment, AbstractCommandSpecProcessor.Context) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
buildParentCommand(Element, AbstractCommandSpecProcessor.Context) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
buildParentCommands(RoundEnvironment, AbstractCommandSpecProcessor.Context) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
buildSpec(Element, AbstractCommandSpecProcessor.Context) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
buildSpecs(RoundEnvironment, AbstractCommandSpecProcessor.Context) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
buildTypedMember(Element) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
buildTypeHierarchy(TypeElement) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
buildUnmatched(RoundEnvironment, AbstractCommandSpecProcessor.Context) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
buildUnmatched(Element, AbstractCommandSpecProcessor.Context) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
buildUnmatchedForMember(CommandLine.Model.IAnnotatedElement) - Static method in class picocli.CommandLine.Model.CommandReflection
 
BuiltIn() - Constructor for class picocli.CommandLine.BuiltIn
 
bundleBaseName - Variable in class picocli.CommandLine.Model.Messages
 
bundles - Variable in class picocli.codegen.aot.graalvm.ResourceConfigGenerator.App
 
bundles - Variable in class picocli.codegen.aot.graalvm.ResourceConfigGenerator.Visitor
 
bundlesJson() - Method in class picocli.codegen.aot.graalvm.ResourceConfigGenerator.Visitor
 
bundleValue(ResourceBundle, String) - Static method in class picocli.CommandLine.Model.Interpolator
 
ByteConverter() - Constructor for class picocli.CommandLine.BuiltIn.ByteConverter
 
ByteOrderConverter() - Constructor for class picocli.CommandLine.BuiltIn.ByteOrderConverter
 

C

CACHED - picocli.CommandLine.Model.InitialValueState
 
cachedTerminalWidth - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
calcDefaultValue(boolean) - Method in class picocli.CommandLine.Model.ArgSpec
 
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.
calcTTY() - Static method in enum picocli.CommandLine.Help.Ansi
http://stackoverflow.com/questions/1403772/how-can-i-check-if-a-java-programs-input-output-streams-are-connected-to-a-term
call() - Method in class picocli.AutoComplete.App
 
call() - Method in class picocli.codegen.aot.graalvm.DynamicProxyConfigGenerator.App
 
call() - Method in class picocli.codegen.aot.graalvm.JniConfigGenerator.App
 
call() - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.App
 
call() - Method in class picocli.codegen.aot.graalvm.ResourceConfigGenerator.App
 
call() - Method in class picocli.codegen.docgen.manpage.ManPageGenerator.App
 
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(C, PrintStream, PrintStream, CommandLine.Help.Ansi, 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, String...) - Static method in class picocli.CommandLine
call(Class<C>, CommandLine.IFactory, PrintStream, PrintStream, CommandLine.Help.Ansi, 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, String...) - Static method in class picocli.CommandLine
canConsumeOneArgument(CommandLine.Model.ArgSpec, CommandLine.LookBehind, boolean, CommandLine.Range, int, String, String) - Method in class picocli.CommandLine.Interpreter
 
canConsumeOneMapArgument(CommandLine.Model.ArgSpec, CommandLine.LookBehind, boolean, CommandLine.Range, int, String, Class<?>[], CommandLine.ITypeConverter<?>, CommandLine.ITypeConverter<?>, String) - Method in class picocli.CommandLine.Interpreter
 
canMatchPositionalParam(CommandLine.Model.PositionalParamSpec) - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
capacity - Variable in class picocli.CommandLine.Model.PositionalParamSpec.Builder
 
capacity - Variable in class picocli.CommandLine.Model.PositionalParamSpec
 
capacity() - Method in class picocli.CommandLine.Model.PositionalParamSpec.Builder
 
capacity() - Method in class picocli.CommandLine.Model.PositionalParamSpec
 
capacity(CommandLine.Range) - Method in class picocli.CommandLine.Model.PositionalParamSpec.Builder
 
CaseAwareKeySet() - Constructor for class picocli.CommandLine.Model.CaseAwareLinkedMap.CaseAwareKeySet
 
CaseAwareLinkedMap() - Constructor for class picocli.CommandLine.Model.CaseAwareLinkedMap
Constructs an empty CaseAwareLinkedMap instance with Locale.ENGLISH.
CaseAwareLinkedMap(Locale) - Constructor for class picocli.CommandLine.Model.CaseAwareLinkedMap
Constructs an empty CaseAwareLinkedMap instance with the specified Locale.
CaseAwareLinkedMap(CommandLine.Model.CaseAwareLinkedMap<? extends K, ? extends V>) - Constructor for class picocli.CommandLine.Model.CaseAwareLinkedMap
Constructs a CaseAwareLinkedMap instance with the same mappings, case-sensitivity and locale as the specified map.
caseInsensitive - Variable in class picocli.CommandLine.Model.CaseAwareLinkedMap
 
caseInsensitiveEnumValuesAllowed - Variable in class picocli.CommandLine.Model.ParserSpec
 
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
CharacterConverter() - Constructor for class picocli.CommandLine.BuiltIn.CharacterConverter
 
CharArrayConverter() - Constructor for class picocli.CommandLine.BuiltIn.CharArrayConverter
 
charCount - Variable in class picocli.CommandLine.Help.TextTable.Count
 
CharSequenceConverter() - Constructor for class picocli.CommandLine.BuiltIn.CharSequenceConverter
 
CharsetConverter() - Constructor for class picocli.CommandLine.BuiltIn.CharsetConverter
 
check(CommandLine.Model.ArgGroupSpec, Set<CommandLine.Model.ArgGroupSpec>) - Method in class picocli.CommandLine.Model.CommandSpec
 
checkBooleanOptionType(Element, TypeMirror, String) - Method in class picocli.codegen.annotation.processing.AnnotationValidator
 
checkExists(File) - Method in class picocli.AutoComplete.App
 
ClassConverter() - Constructor for class picocli.CommandLine.BuiltIn.ClassConverter
 
classes - Variable in class picocli.codegen.aot.graalvm.DynamicProxyConfigGenerator.App
 
classes - Variable in class picocli.codegen.aot.graalvm.JniConfigGenerator.App
 
classes - Variable in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.App
 
classes - Variable in class picocli.codegen.aot.graalvm.ResourceConfigGenerator.App
 
classes - Variable in class picocli.codegen.docgen.manpage.ManPageGenerator.App
 
clear() - Method in class picocli.CommandLine.Interpreter
 
clear() - Method in class picocli.CommandLine.Model.CaseAwareLinkedMap
 
clear() - Method in class picocli.CommandLine.Model.UnmatchedArgsBinding
 
clear(CommandLine.Model.ArgGroupSpec) - Method in class picocli.CommandLine.Interpreter
 
clear(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.Interpreter
 
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
 
close(Closeable) - Static method in class picocli.CommandLine
 
closeSilently(Closeable) - Static method in class picocli.codegen.util.Util
 
collectErrors - Variable in class picocli.CommandLine.Model.ParserSpec
 
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.
color - Variable in class picocli.CommandLine.Help.Ansi.Palette256Color
 
COLOR_SCHEME - Static variable in class picocli.codegen.docgen.manpage.ManPageGenerator
 
ColoredStackTraceWriter(CommandLine.Help.ColorScheme) - Constructor for class picocli.CommandLine.ColoredStackTraceWriter
 
colorScheme - Variable in class picocli.CommandLine.AbstractHandler
Deprecated.
 
colorScheme - Variable in class picocli.CommandLine.ColoredStackTraceWriter
 
colorScheme - Variable in class picocli.CommandLine
 
colorScheme - Variable in class picocli.CommandLine.Help.Ansi.Text
 
colorScheme - Variable in class picocli.CommandLine.Help
 
colorScheme - Variable in class picocli.CommandLine.Help.Layout
 
colorScheme - Variable in class picocli.CommandLine.Help.TextTable
 
colorScheme - Variable in class picocli.CommandLine.HelpCommand
 
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.
ColorScheme(CommandLine.Help.ColorScheme.Builder) - Constructor for class picocli.CommandLine.Help.ColorScheme
Constructs a new empty ColorScheme with the specified Ansi enabled mode.
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
 
columnCount - Variable in class picocli.CommandLine.Help.TextTable.Count
 
columns - Variable in class picocli.CommandLine.Help.TextTable
The column definitions of this table.
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_DEFAULT_NAME - Static variable in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
COMMAND_TYPE - Static variable in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
CommandDescriptor(String, String, CommandLine, CommandLine) - Constructor for class picocli.AutoComplete.CommandDescriptor
 
commandInterfaces - Variable in class picocli.codegen.aot.graalvm.DynamicProxyConfigGenerator.Visitor
 
commandLine - Variable in class picocli.AutoComplete.CommandDescriptor
 
commandLine - Variable in exception picocli.CommandLine.ExecutionException
 
commandLine - Variable in class picocli.CommandLine.Model.CommandSpec
 
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(Object, CommandLine.IFactory, boolean) - Constructor for class picocli.CommandLine
 
CommandLine.AbbreviationMatcher - Class in picocli
 
CommandLine.AbstractHandler<R,​T extends CommandLine.AbstractHandler<R,​T>> - Class in picocli
CommandLine.AbstractParseResultHandler<R> - Class in picocli
CommandLine.ArgGroup - Annotation Type in picocli
A Command may define one or more ArgGroups: a group of options, positional parameters or a mixture of the two.
CommandLine.Assert - Class in picocli
Utility class providing some defensive coding convenience methods.
CommandLine.AutoHelpMixin - Class in picocli
 
CommandLine.BuiltIn - Class in picocli
Inner class to group the built-in CommandLine.ITypeConverter implementations.
CommandLine.BuiltIn.BigDecimalConverter - Class in picocli
 
CommandLine.BuiltIn.BigIntegerConverter - Class in picocli
 
CommandLine.BuiltIn.BooleanConverter - Class in picocli
Converts "true" or "false" to a Boolean.
CommandLine.BuiltIn.ByteConverter - Class in picocli
Converts text to a Byte by delegating to Byte.valueOf(String).
CommandLine.BuiltIn.ByteOrderConverter - Class in picocli
 
CommandLine.BuiltIn.CharacterConverter - Class in picocli
 
CommandLine.BuiltIn.CharArrayConverter - Class in picocli
 
CommandLine.BuiltIn.CharSequenceConverter - Class in picocli
 
CommandLine.BuiltIn.CharsetConverter - Class in picocli
 
CommandLine.BuiltIn.ClassConverter - Class in picocli
 
CommandLine.BuiltIn.CurrencyConverter - Class in picocli
 
CommandLine.BuiltIn.DoubleConverter - Class in picocli
 
CommandLine.BuiltIn.FileConverter - Class in picocli
 
CommandLine.BuiltIn.FloatConverter - Class in picocli
 
CommandLine.BuiltIn.InetAddressConverter - Class in picocli
Converts text to a InetAddress by delegating to InetAddress.getByName(String).
CommandLine.BuiltIn.IntegerConverter - Class in picocli
Converts text to an Integer by delegating to Integer.valueOf(String).
CommandLine.BuiltIn.ISO8601DateConverter - Class in picocli
Converts text in yyyy-mm-dd format to a java.util.Date.
CommandLine.BuiltIn.ISO8601TimeConverter - Class in picocli
Converts text in any of the following formats to a java.sql.Time: HH:mm, HH:mm:ss, HH:mm:ss.SSS, HH:mm:ss,SSS.
CommandLine.BuiltIn.LongConverter - Class in picocli
Converts text to a Long by delegating to Long.valueOf(String).
CommandLine.BuiltIn.NetworkInterfaceConverter - Class in picocli
 
CommandLine.BuiltIn.PatternConverter - Class in picocli
 
CommandLine.BuiltIn.ReflectionConverter - Class in picocli
 
CommandLine.BuiltIn.ShortConverter - Class in picocli
Converts text to a Short by delegating to Short.valueOf(String).
CommandLine.BuiltIn.StringBuilderConverter - Class in picocli
 
CommandLine.BuiltIn.StringConverter - Class in picocli
 
CommandLine.BuiltIn.TimeZoneConverter - Class in picocli
 
CommandLine.BuiltIn.URIConverter - Class in picocli
 
CommandLine.BuiltIn.URLConverter - Class in picocli
 
CommandLine.BuiltIn.UUIDConverter - Class in picocli
 
CommandLine.ColoredStackTraceWriter - Class in picocli
Extends StringWriter to use ColorScheme.
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.CosineSimilarity - Class in picocli
Uses cosine similarity to find matches from a candidate set for a specified input.
CommandLine.DefaultExceptionHandler<R> - Class in picocli
CommandLine.DefaultFactory - Class in picocli
 
CommandLine.DefaultHelpFactory - Class in picocli
 
CommandLine.DuplicateNameException - Exception in picocli
Exception indicating that multiple named elements have incorrectly used the same name.
CommandLine.DuplicateOptionAnnotationsException - Exception in picocli
Exception indicating that multiple fields have been annotated with the same Option name.
CommandLine.ExecutionException - Exception in picocli
Exception indicating a problem while invoking a command or subcommand.
CommandLine.ExitCode - Class in picocli
Defines some exit codes used by picocli as default return values from the execute and executeHelpRequest methods.
CommandLine.Help - Class in picocli
A collection of methods and inner classes that provide fine-grained control over the contents and layout of the usage help message to display to end users when help is requested or invalid input values were specified.
CommandLine.Help.Ansi - Enum in picocli
Provides methods and inner classes to support using ANSI escape codes in usage help messages.
CommandLine.Help.Ansi.IStyle - Interface in picocli
Defines the interface for an ANSI escape sequence.
CommandLine.Help.Ansi.Palette256Color - Class in picocli
Defines a palette map of 216 colors: 6 * 6 * 6 cube (216 colors): 16 + 36 * r + 6 * g + b (0 <= r, g, b <= 5).
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.StyledSection - Class in picocli
 
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.DefaultOptionRenderer - Class in picocli
The DefaultOptionRenderer converts Options to five columns of text to match the default TextTable column layout.
CommandLine.Help.DefaultParameterRenderer - Class in picocli
The DefaultParameterRenderer converts positional parameters to five columns of text to match the default TextTable column layout.
CommandLine.Help.DefaultParamLabelRenderer - Class in picocli
DefaultParamLabelRenderer separates option parameters from their option names with a separator string, and, unless CommandLine.Model.ArgSpec.hideParamSyntax() is true, surrounds optional values with '[' and ']' characters and uses ellipses ("...") to indicate that any number of values is allowed for options or parameters with variable arity.
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.MinimalOptionRenderer - Class in picocli
The MinimalOptionRenderer converts Options to a single row with two columns of text: an option name and a description.
CommandLine.Help.MinimalParameterRenderer - Class in picocli
The MinimalParameterRenderer converts positional parameters to a single row with two columns of text: the parameters label and a description.
CommandLine.Help.ShortestFirst - Class in picocli
Sorts short strings before longer strings.
CommandLine.Help.SortByOptionArityAndNameAlphabetically - Class in picocli
Sorts OptionSpec instances by their max arity first, then their min arity, then delegates to super class.
CommandLine.Help.SortByOrder<T extends CommandLine.Model.IOrdered> - Class in picocli
 
CommandLine.Help.SortByShortestOptionNameAlphabetically - Class in picocli
Sorts OptionSpec instances by their name in case-insensitive alphabetic order.
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.TextTable.Count - Class in picocli
 
CommandLine.Help.Visibility - Enum in picocli
Controls the visibility of certain aspects of the usage help message.
CommandLine.HelpCommand - Class in picocli
Help command that can be installed as a subcommand on all application commands.
CommandLine.IDefaultValueProvider - Interface in picocli
Provides default value for a command.
CommandLine.IExceptionHandler - Interface in picocli
CommandLine.IExceptionHandler2<R> - Interface in picocli
CommandLine.IExecutionExceptionHandler - Interface in picocli
Classes implementing this interface know how to handle Exceptions that occurred while executing the Runnable, Callable or Method user object of the command.
CommandLine.IExecutionStrategy - Interface in picocli
Implementations are responsible for "executing" the user input and returning an exit code.
CommandLine.IExitCodeExceptionMapper - Interface in picocli
Interface that provides the appropriate exit code that will be returned from the execute method for an exception that occurred during parsing or while invoking the command's Runnable, Callable, or Method.
CommandLine.IExitCodeGenerator - Interface in picocli
@Command-annotated classes can implement this interface to specify an exit code that will be returned from the execute method when the command is successfully invoked.
CommandLine.IFactory - Interface in picocli
Factory for instantiating classes that are registered declaratively with annotation attributes, like CommandLine.Command.subcommands(), CommandLine.Option.converter(), CommandLine.Parameters.converter() and CommandLine.Command.versionProvider().
CommandLine.IHelpCommandInitializable - Interface in picocli
CommandLine.IHelpCommandInitializable2 - Interface in picocli
Help commands that provide usage help for other commands can implement this interface to be initialized with the information they need.
CommandLine.IHelpFactory - Interface in picocli
Creates the CommandLine.Help instance used to render the usage help message.
CommandLine.IHelpSectionRenderer - Interface in picocli
Renders a section of the usage help message.
CommandLine.IModelTransformer - Interface in picocli
Provides a way to modify how the command model is built.
CommandLine.INegatableOptionTransformer - Interface in picocli
Determines the option name transformation of negatable boolean options.
CommandLine.InitializationException - Exception in picocli
Exception indicating a problem during CommandLine initialization.
CommandLine.Interpreter - Class in picocli
Helper class responsible for processing command line arguments.
CommandLine.IParameterConsumer - Interface in picocli
Options or positional parameters can be assigned a IParameterConsumer that implements custom logic to process the parameters for this option or this position.
CommandLine.IParameterExceptionHandler - Interface in picocli
Classes implementing this interface know how to handle ParameterExceptions (usually from invalid user input).
CommandLine.IParameterPreprocessor - Interface in picocli
Options, positional parameters and commands can be assigned a IParameterPreprocessor that implements custom logic to preprocess the parameters for this option, position or command.
CommandLine.IParseResultHandler - Interface in picocli
Deprecated.
CommandLine.IParseResultHandler2<R> - Interface in picocli
CommandLine.ITypeConverter<K> - Interface in picocli
When parsing command line arguments and initializing fields annotated with @Option or @Parameters, String values can be converted to any type for which a ITypeConverter is registered.
CommandLine.IVersionProvider - Interface in picocli
Provides version information for a command.
CommandLine.LookBehind - Enum in picocli
 
CommandLine.MaxValuesExceededException - Exception in picocli
Exception indicating that more values were specified for an option or parameter than its arity allows.
CommandLine.MissingParameterException - Exception in picocli
Exception indicating that a required parameter was not specified.
CommandLine.MissingTypeConverterException - Exception in picocli
Exception indicating that an annotated field had a type for which no CommandLine.ITypeConverter was registered.
CommandLine.Mixin - Annotation Type in picocli
Fields annotated with @Mixin are "expanded" into the current command: @Option and @Parameters in the mixin class are added to the options and positional parameters of this command.
CommandLine.Model - Class in picocli
This class provides a namespace for classes and interfaces that model concepts and attributes of command line interfaces in picocli.
CommandLine.Model.ArgGroupSpec - Class in picocli
The ArgGroupSpec class models a group of arguments (options, positional parameters or a mixture of the two).
CommandLine.Model.ArgGroupSpec.Builder - Class in picocli
Builder responsible for creating valid ArgGroupSpec objects.
CommandLine.Model.ArgSpec - Class in picocli
CommandLine.Model.ArgSpec.Builder<T extends CommandLine.Model.ArgSpec.Builder<T>> - Class in picocli
 
CommandLine.Model.CaseAwareLinkedMap<K,​V> - Class in picocli
This class provides a case-aware Linked HashMap.
CommandLine.Model.CaseAwareLinkedMap.CaseAwareKeySet - Class in picocli
 
CommandLine.Model.CommandReflection - 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.CommandUserObject - Class in picocli
 
CommandLine.Model.FieldBinding - Class in picocli
 
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.InitialValueState - Enum in picocli
 
CommandLine.Model.Interpolator - Class in picocli
 
CommandLine.Model.Interpolator.ILookup - Interface in picocli
 
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.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.MethodBinding - Class in picocli
 
CommandLine.Model.MethodParam - Class in picocli
Command method parameter, similar to java.lang.reflect.Parameter (not available before Java 8).
CommandLine.Model.ObjectBinding - Class in picocli
 
CommandLine.Model.ObjectScope - Class in picocli
 
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.PicocliInvocationHandler - Class in picocli
 
CommandLine.Model.PicocliInvocationHandler.ProxyBinding - Class in picocli
 
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.Predicate<T> - Interface in picocli
 
CommandLine.Model.RuntimeTypeInfo - Class in picocli
 
CommandLine.Model.TypedMember - Class in picocli
 
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.NoCompletionCandidates - Class in picocli
 
CommandLine.NoDefaultProvider - Class in picocli
 
CommandLine.NoOpModelTransformer - Class in picocli
 
CommandLine.NoOpParameterPreprocessor - Class in picocli
 
CommandLine.NoVersionProvider - Class in picocli
 
CommandLine.NullParameterConsumer - Class in picocli
 
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.ParseResult.GroupValidationResult - Class in picocli
 
CommandLine.ParseResult.GroupValidationResult.Type - Enum in picocli
 
CommandLine.PicocliException - Exception in picocli
Base class of all exceptions thrown by picocli.CommandLine.
CommandLine.PositionalParametersSorter - Class in picocli
 
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
 
CommandLine.Tracer - Class in picocli
 
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.
commandLineFQCN - Variable in class picocli.AutoComplete.App
 
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 - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
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.
commandMethodParamValues() - Method in class picocli.CommandLine.Model.CommandSpec
 
commandName - Variable in class picocli.AutoComplete.App
 
commandName - Variable in class picocli.AutoComplete.CommandDescriptor
 
commandName() - Method in class picocli.CommandLine.Help
 
commandNamesText(String) - Method in class picocli.CommandLine.Help
Returns a Text object containing the command name and all aliases, separated with the specified separator.
CommandReflection() - Constructor for class picocli.CommandLine.Model.CommandReflection
 
commands - Variable in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Context
 
commands - Variable in class picocli.CommandLine.HelpCommand
 
commands - Variable in class picocli.CommandLine.Model.CommandSpec
 
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 - Variable in class picocli.CommandLine
 
commandSpec - Variable in class picocli.CommandLine.Help
 
commandSpec - Variable in class picocli.CommandLine.Help.DefaultParamLabelRenderer
 
commandSpec - Variable in class picocli.CommandLine.Model.ArgSpec
 
commandSpec - Variable in class picocli.CommandLine.Model.CommandUserObject
 
commandSpec - Variable in class picocli.CommandLine.Model.Interpolator
 
commandSpec - Variable in class picocli.CommandLine.ParseResult.Builder
 
commandSpec - Variable in class picocli.CommandLine.ParseResult
 
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.
CommandSpec(CommandLine.Model.CommandUserObject) - Constructor for class picocli.CommandLine.Model.CommandSpec
 
commandsRequestingStandardHelpOptions - Variable in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Context
 
commandStyles - Variable in class picocli.CommandLine.Help.ColorScheme.Builder
 
commandStyles - Variable in class picocli.CommandLine.Help.ColorScheme
 
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.
commandTypes - Variable in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Context
 
CommandUserObject(Object, CommandLine.IFactory) - Constructor for class picocli.CommandLine.Model.CommandUserObject
 
compare(String, String) - Method in class picocli.codegen.docgen.manpage.ManPageGenerator.ShortestFirst
 
compare(String, String) - Method in class picocli.CommandLine.Help.ShortestFirst
 
compare(CommandLine.Model.ArgSpec, CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.PositionalParametersSorter
 
compare(CommandLine.Model.OptionSpec, CommandLine.Model.OptionSpec) - Method in class picocli.codegen.docgen.manpage.ManPageGenerator.SortByShortestOptionNameAlphabetically
 
compare(CommandLine.Model.OptionSpec, CommandLine.Model.OptionSpec) - Method in class picocli.CommandLine.Help.SortByOptionArityAndNameAlphabetically
 
compare(CommandLine.Model.OptionSpec, CommandLine.Model.OptionSpec) - Method in class picocli.CommandLine.Help.SortByShortestOptionNameAlphabetically
 
compare(T, T) - Method in class picocli.codegen.docgen.manpage.ManPageGenerator.SortByOrder
 
compare(T, T) - Method in class picocli.CommandLine.Help.SortByOrder
 
compareTo(ReflectionConfigGenerator.ReflectedField) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedField
 
compareTo(ReflectionConfigGenerator.ReflectedMethod) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedMethod
 
compareTo(CommandLine.Range) - Method in class picocli.CommandLine.Range
 
CompileTimeTypeInfo - Class in picocli.codegen.annotation.processing
 
CompileTimeTypeInfo(TypeMirror) - Constructor for class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
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(CommandLine) - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
complete(CommandLine.Model.CommandSpec, String[], int, int, int, List<CharSequence>) - Static method in class picocli.AutoComplete
 
completionCandidates - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
completionCandidates - Variable in class picocli.CommandLine.Model.ArgSpec
 
completionCandidates() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns the completion candidates for this option or positional parameter, or null.
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.
completionCandidates(Iterable<String>) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets the completion candidates for this option or positional parameter, and returns this builder.
CompletionCandidatesMetaData - Class in picocli.codegen.annotation.processing
Implementation of the Iterable interface that provides metadata on the @Command(completionCandidates = xxx.class) annotation.
CompletionCandidatesMetaData(TypeMirror) - Constructor for class picocli.codegen.annotation.processing.CompletionCandidatesMetaData
 
compositesReferencingMe - Variable in class picocli.CommandLine.Model.ArgGroupSpec.Builder
 
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(String, String...) - Static method in class picocli.AutoComplete
 
concat(String, List<String>) - Static method in class picocli.AutoComplete
 
concat(String, List<T>, T, AutoComplete.Function<V, String>) - Static method in class picocli.AutoComplete
 
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.
concatOptionText(String, CommandLine.Help.Ansi.Text, CommandLine.Help.ColorScheme, CommandLine.Model.OptionSpec) - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
concatOptionText(String, CommandLine.Help.Ansi.Text, CommandLine.Help.ColorScheme, CommandLine.Model.OptionSpec, CommandLine.Help.IParamLabelRenderer) - Static method in class picocli.CommandLine.Help
 
concatPositionalText(String, CommandLine.Help.Ansi.Text, CommandLine.Help.ColorScheme, CommandLine.Model.PositionalParamSpec) - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
concatPositionalText(String, CommandLine.Help.Ansi.Text, CommandLine.Help.ColorScheme, CommandLine.Model.PositionalParamSpec, CommandLine.Help.IParamLabelRenderer) - Static method in class picocli.CommandLine.Help
 
config - Variable in class picocli.codegen.docgen.manpage.ManPageGenerator.App
 
config - Variable in class picocli.codegen.docgen.manpage.ManPageGenerator
 
config() - Method in class picocli.CommandLine.Interpreter
 
Config() - Constructor for class picocli.codegen.docgen.manpage.ManPageGenerator.Config
 
connectArgGroups(AbstractCommandSpecProcessor) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Context
 
connectModel(AbstractCommandSpecProcessor) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Context
 
constructor - Variable in class picocli.CommandLine.BuiltIn.ISO8601TimeConverter
 
consumeArguments(CommandLine.Model.ArgSpec, boolean, CommandLine.LookBehind, boolean, boolean, CommandLine.Range, Stack<String>, String) - Method in class picocli.CommandLine.Interpreter
 
consumedCount(int, int, CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.Interpreter
 
consumedCountMap(int, int, CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.Interpreter
 
consumeMapArguments(CommandLine.Model.ArgSpec, CommandLine.LookBehind, boolean, CommandLine.Range, Stack<String>, Map<Object, Object>, String) - Method in class picocli.CommandLine.Interpreter
 
consumeOneArgument(CommandLine.Model.ArgSpec, CommandLine.LookBehind, boolean, CommandLine.Range, int, String, List<Object>, int, String) - Method in class picocli.CommandLine.Interpreter
 
consumeOneMapArgument(CommandLine.Model.ArgSpec, CommandLine.LookBehind, boolean, CommandLine.Range, int, String, Class<?>[], CommandLine.ITypeConverter<?>, CommandLine.ITypeConverter<?>, Map<Object, Object>, int, String) - Method in class picocli.CommandLine.Interpreter
 
consumeParameters(Stack<String>, CommandLine.Model.ArgSpec, CommandLine.Model.CommandSpec) - Method in class picocli.codegen.annotation.processing.ParameterConsumerMetaData
Does nothing.
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.
consumeParameters(Stack<String>, CommandLine.Model.ArgSpec, CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.NullParameterConsumer
 
container - Variable in class picocli.CommandLine.ParseResult.GroupMatch
 
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.
contains(Object) - Method in class picocli.CommandLine.Model.CaseAwareLinkedMap.CaseAwareKeySet
 
containsKey(Object) - Method in class picocli.CommandLine.Model.CaseAwareLinkedMap
 
containsValue(Object) - Method in class picocli.CommandLine.Model.CaseAwareLinkedMap
 
Context() - Constructor for class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Context
 
convert(String) - Method in class picocli.codegen.annotation.processing.TypeConverterMetaData
Always returns null.
convert(String) - Method in class picocli.CommandLine.BuiltIn.BigDecimalConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.BigIntegerConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.BooleanConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.ByteConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.ByteOrderConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.CharacterConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.CharArrayConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.CharSequenceConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.CharsetConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.ClassConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.CurrencyConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.DoubleConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.FileConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.FloatConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.InetAddressConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.IntegerConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.ISO8601DateConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.ISO8601TimeConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.LongConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.NetworkInterfaceConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.PatternConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.ReflectionConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.ShortConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.StringBuilderConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.StringConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.TimeZoneConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.URIConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.URLConverter
 
convert(String) - Method in class picocli.CommandLine.BuiltIn.UUIDConverter
 
convert(String) - Method in interface picocli.CommandLine.ITypeConverter
Converts the specified command line argument value to some domain object.
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).
converterRegistry - Variable in class picocli.CommandLine.Interpreter
 
converters - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
converters - Variable in class picocli.CommandLine.Model.ArgSpec
 
converters() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
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).
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).
converters(CommandLine.ITypeConverter<?>...) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets option/positional param-specific converter (or converters for Maps), and returns this builder.
copy() - Method in class picocli.CommandLine
 
copy() - Method in class picocli.CommandLine.Model.CommandSpec
 
copy() - Method in class picocli.CommandLine.Model.CommandUserObject
 
copy(BreakIterator, CommandLine.Help.Ansi.Text, CommandLine.Help.Ansi.Text, int) - Method in class picocli.CommandLine.Help.TextTable
 
copy(Stack<String>) - Static method in class picocli.CommandLine
 
copy(CommandLine.Help.Ansi.Text, CommandLine.Help.Ansi.Text, int) - Method in class picocli.CommandLine.Help.TextTable
 
copy(CommandLine.Help.Ansi.Text, CommandLine.Help.Ansi.Text, int, CommandLine.Help.TextTable.Count) - Method in class picocli.CommandLine.Help.TextTable
 
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.
CosineSimilarity() - Constructor for class picocli.CommandLine.CosineSimilarity
 
Count() - Constructor for class picocli.CommandLine.Help.TextTable.Count
 
countNgramFrequency(String, int) - Static method in class picocli.CommandLine.CosineSimilarity
 
countTrailingSpaces(String) - Static method in class picocli.CommandLine.Help
 
create() - Static method in class picocli.CommandLine.Model.CommandSpec
Creates and returns a new CommandSpec without any associated user object.
create(Class<?>, Class<?>[], Type, CommandLine.Range, Class<?>, boolean) - Static method in class picocli.CommandLine.Model.RuntimeTypeInfo
 
create(Class<?>, Class<?>[], List<String>, CommandLine.Range, Class<?>, boolean) - Static method in class picocli.CommandLine.Model.RuntimeTypeInfo
 
create(Class<K>) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.NullFactory
 
create(Class<K>) - Method in interface picocli.CommandLine.IFactory
Returns an instance of the specified class.
create(Class<T>) - Method in class picocli.CommandLine.DefaultFactory
 
create(Object, CommandLine.IFactory) - Static method in class picocli.CommandLine.Model.CommandUserObject
 
create(String, CommandLine.Model.ArgSpec, CommandLine.Model.ArgSpec) - Static method in exception picocli.CommandLine.DuplicateOptionAnnotationsException
 
create(CommandLine.IFactory, Class<T>) - Static method in class picocli.CommandLine.DefaultFactory
 
create(CommandLine.Model.CommandSpec, CommandLine.Help.ColorScheme) - Method in class picocli.CommandLine.DefaultHelpFactory
 
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(CommandLine, Exception, String, int, String[]) - Static method in exception picocli.CommandLine.ParameterException
 
create(CommandLine, Collection<CommandLine.Model.ArgSpec>, String) - Static method in exception picocli.CommandLine.MissingParameterException
 
createBundle(String) - Static method in class picocli.CommandLine.Model.Messages
 
createCaseInsensitive() - Static method in class picocli.CommandLine.RegexTransformer
Returns the RegexTransformer for case-insensitive negatable options.
createCollection(Class<?>, Class<?>[]) - Method in class picocli.CommandLine.Interpreter
 
createCompletionCandidates(CommandLine.IFactory, Class<? extends Iterable<String>>) - Static method in class picocli.CommandLine.DefaultFactory
 
createConverter(CommandLine.IFactory, Class<? extends CommandLine.ITypeConverter<?>>[]) - Static method in class picocli.CommandLine.DefaultFactory
 
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.
createDefaultValueProvider(CommandLine.IFactory, Class<? extends CommandLine.IDefaultValueProvider>) - Static method in class picocli.CommandLine.DefaultFactory
 
createDescriptionFirstLines(CommandLine.Help.ColorScheme, CommandLine.Model.ArgSpec, String[], boolean[]) - Static method in class picocli.CommandLine.Help
 
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.
createEndOfOptionsOption(String) - Method in class picocli.CommandLine.Help
 
createForAuxType(Class<?>) - Static method in class picocli.CommandLine.Model.RuntimeTypeInfo
 
createGroupMatchContainer(CommandLine.Model.ArgGroupSpec, CommandLine.ParseResult.GroupMatchContainer, CommandLine) - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
createHeading(String, Object...) - Method in class picocli.CommandLine.Help
Returns a String that can be used as a help section heading.
createHelpSectionRendererMap() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the help section renderers for the predefined section keys.
createHierarchy(String, CommandLine) - Static method in class picocli.AutoComplete
 
createIfAnnotated(Field, CommandLine.Model.IScope) - Static method in class picocli.CommandLine.Model.TypedMember
 
createIfAnnotated(Method, CommandLine.Model.IScope, CommandLine.Model.CommandSpec) - Static method in class picocli.CommandLine.Model.TypedMember
 
createLabelRenderer(CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
createLayout(int, CommandLine.Help.ColorScheme) - Method in class picocli.CommandLine.Help
 
createLongOptionText(CommandLine.Model.OptionSpec, CommandLine.Help.IParamLabelRenderer, CommandLine.Help.ColorScheme, String) - Method in class picocli.CommandLine.Help.DefaultOptionRenderer
 
createMap(Class<?>) - Method in class picocli.CommandLine.Interpreter
 
createMarkupMap() - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
createMethodSubcommands(Class<?>, CommandLine.IFactory, boolean) - Static method in class picocli.CommandLine.Model.CommandSpec
 
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.
createMissingParameterMessage(CommandLine.Model.ArgSpec, CommandLine.Range, List<CommandLine.Model.PositionalParamSpec>, Stack<String>, int) - Static method in class picocli.CommandLine
 
createMissingParameterMessageFoundOtherOption(CommandLine.Model.ArgSpec, Stack<String>, int, CommandLine.Range) - Method in class picocli.CommandLine.Interpreter
 
createOrderComparator() - Static method in class picocli.CommandLine.Help
Sorts options by their option order, lowest first, highest last.
createOrderComparatorIfNecessary(List<CommandLine.Model.OptionSpec>) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
createOrderComparatorIfNecessary(List<CommandLine.Model.OptionSpec>) - Static method in class picocli.CommandLine.Help
 
createParameterConsumer(CommandLine.IFactory, Class<? extends CommandLine.IParameterConsumer>) - Static method in class picocli.CommandLine.DefaultFactory
 
createParameterException(Object, Throwable) - Method in class picocli.CommandLine.Model.MethodBinding
 
createProperties(File, CommandLine.Model.CommandSpec) - Static method in class picocli.CommandLine.PropertiesDefaultProvider
 
createRelativePath(String) - Method in class picocli.codegen.aot.graalvm.processor.AbstractGenerator
 
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.
createStringTypeMirror() - Method in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
createSubHierarchy(String, CommandLine, List<AutoComplete.CommandDescriptor>) - Static method in class picocli.AutoComplete
 
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.
createTime(long) - Method in class picocli.CommandLine.BuiltIn.ISO8601TimeConverter
 
createTypeInfo(Class<?>, Type) - Method in class picocli.CommandLine.Model.TypedMember
 
createUserInputDebugString(CommandLine.Model.ArgSpec, char[], String) - Method in class picocli.CommandLine.Interpreter
 
createVersionProvider(CommandLine.IFactory, Class<? extends CommandLine.IVersionProvider>) - Static method in class picocli.CommandLine.DefaultFactory
 
CSI - Static variable in interface picocli.CommandLine.Help.Ansi.IStyle
The Control Sequence Introducer (CSI) escape sequence "\u001b[".
CurrencyConverter() - Constructor for class picocli.CommandLine.BuiltIn.CurrencyConverter
 
currentValue - Variable in class picocli.CommandLine.Model.MethodBinding
 
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 - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
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.

D

debug(String[], String, String) - Method in class picocli.CommandLine.Model.ArgSpec
 
debug(String, Object...) - Method in class picocli.CommandLine.Tracer
 
DEBUG - picocli.CommandLine.TraceLevel
 
debugElement(Element, String) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
debugFoundAnnotations(Set<? extends TypeElement>, RoundEnvironment) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
debugMethod(ExecutableElement) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
debugType(TypeMirror, Element, String) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
decapitalize(String) - Static method in class picocli.codegen.annotation.processing.TypedMember
 
decapitalize(String) - Static method in class picocli.CommandLine.Model.TypedMember
 
DEFAULT_ABBREVIATE_SYNOPSIS - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Constant Boolean holding the default setting for whether to abbreviate the synopsis: .
DEFAULT_ADJUST_CJK - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Constant Boolean holding the default setting for whether line breaks should take wide CJK characters into account: .
DEFAULT_COMMAND_LIST_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Constant String holding the default command list heading: "Commands:%n".
DEFAULT_COMMAND_NAME - Static variable in class picocli.CommandLine.Help
Constant String holding the default program name, value defined in CommandLine.Model.CommandSpec.DEFAULT_COMMAND_NAME.
DEFAULT_COMMAND_NAME - Static variable in class picocli.CommandLine.Model.CommandSpec
Constant String holding the default program name: "<main class>" .
DEFAULT_END_OF_OPTIONS_DELIMITER - Static variable in class picocli.CommandLine.Model.ParserSpec
 
DEFAULT_FALLBACK_VALUE - Static variable in class picocli.CommandLine.Model.OptionSpec
 
DEFAULT_HIDDEN - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Constant Boolean holding the default setting for whether this command should be listed in the usage help of the parent command: .
DEFAULT_INTERPOLATE_VARIABLES - Static variable in class picocli.CommandLine.Model.CommandSpec
Constant Boolean holding the default setting for whether variables should be interpolated in String values: .
DEFAULT_IS_ADD_METHOD_SUBCOMMANDS - Static variable in class picocli.CommandLine.Model.CommandSpec
Constant Boolean holding the default setting for whether method commands should be added as subcommands: .
DEFAULT_IS_HELP_COMMAND - Static variable in class picocli.CommandLine.Model.CommandSpec
Constant Boolean holding the default setting for whether this is a help command: .
DEFAULT_MULTI_LINE - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
 
DEFAULT_ORDER - Static variable in class picocli.CommandLine.Model.ArgGroupSpec
 
DEFAULT_ORDER - Static variable in class picocli.CommandLine.Model.OptionSpec
 
DEFAULT_REQUIRED_OPTION_MARKER - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Constant String holding the default string that separates options from option parameters: ' ' (32).
DEFAULT_SEPARATOR - Static variable in class picocli.CommandLine.Help
Constant String holding the default string that separates options from option parameters, value defined in CommandLine.Model.ParserSpec.DEFAULT_SEPARATOR.
DEFAULT_SEPARATOR - Static variable in class picocli.CommandLine.Model.ParserSpec
Constant String holding the default separator between options and option parameters: "=".
DEFAULT_SHOW_AT_FILE - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Constant Boolean holding the default setting for whether to show an entry for @-files in the usage help message.
DEFAULT_SHOW_DEFAULT_VALUES - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Constant Boolean holding the default setting for whether to show default values in the usage help message: .
DEFAULT_SHOW_END_OF_OPTIONS - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Constant Boolean holding the default setting for whether to show an entry for the -- End of Options delimiter in the usage help message.
DEFAULT_SINGLE_VALUE - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
 
DEFAULT_SORT_OPTIONS - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Constant Boolean holding the default setting for whether to sort the options alphabetically: .
DEFAULT_SUBCOMMANDS_REPEATABLE - Static variable in class picocli.CommandLine.Model.CommandSpec
 
DEFAULT_SYNOPSIS_AUTO_INDENT_THRESHOLD - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
 
DEFAULT_SYNOPSIS_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Constant String holding the default synopsis heading: "Usage: ".
DEFAULT_SYNOPSIS_INDENT - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
 
DEFAULT_SYNOPSIS_SUBCOMMANDS - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Constant String holding the default synopsis subcommands: "[COMMAND]".
DEFAULT_USAGE_AUTO_WIDTH - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Constant Boolean holding the default setting for whether to attempt to adjust the width to the terminal width: .
DEFAULT_USAGE_LONG_OPTIONS_WIDTH - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
 
DEFAULT_USAGE_WIDTH - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Constant holding the default usage message width: 80.
defaultArity(Class<?>) - Static method in class picocli.CommandLine.Range
Deprecated.
defaultArity(Field) - Static method in class picocli.CommandLine.Range
Returns the default arity Range: for interactive options/positional parameters, this is 0; for options this is 0 for booleans and 1 for other types, for parameters booleans have arity 0, arrays or Collections have arity "0..*", and other types have arity 1.
defaultArity(CommandLine.Model.IAnnotatedElement) - Static method in class picocli.CommandLine.Range
 
defaultColorScheme(CommandLine.Help.Ansi) - Static method in class picocli.CommandLine.Help
Creates and returns a new CommandLine.Help.ColorScheme initialized with picocli default values: commands are bold, options and parameters use a yellow foreground, and option parameters use italic.
defaultExceptionHandler() - Static method in class picocli.CommandLine
Convenience method that returns new DefaultExceptionHandler<List<Object>>().
DefaultExceptionHandler() - Constructor for class picocli.CommandLine.DefaultExceptionHandler
Deprecated.
 
defaultFactory() - Static method in class picocli.CommandLine
Returns the default CommandLine.IFactory implementation used if no factory was specified in the CommandLine constructor.
DefaultFactory() - Constructor for class picocli.CommandLine.DefaultFactory
 
DefaultHelpFactory() - Constructor for class picocli.CommandLine.DefaultHelpFactory
 
DefaultOptionRenderer(boolean, String) - Constructor for class picocli.CommandLine.Help.DefaultOptionRenderer
 
defaultParameterIndex(CommandLine.Model.ITypeInfo) - Static method in class picocli.CommandLine.Range
 
DefaultParameterRenderer(boolean, String) - Constructor for class picocli.CommandLine.Help.DefaultParameterRenderer
 
DefaultParamLabelRenderer(CommandLine.Model.CommandSpec) - Constructor for class picocli.CommandLine.Help.DefaultParamLabelRenderer
Constructs a new DefaultParamLabelRenderer with the specified separator string.
defaultValue - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
defaultValue - Variable in class picocli.CommandLine.Model.ArgSpec
 
defaultValue() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns the default value of this option or positional parameter, before splitting and type conversion.
defaultValue() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the default value to assign if this option or positional parameter was not specified on the command line, before splitting and type conversion.
defaultValue() - Method in annotation type picocli.CommandLine.Option
Returns the default value of this option, before splitting and type conversion.
defaultValue() - Method in annotation type picocli.CommandLine.Parameters
Returns the default value of this positional parameter, before splitting and type conversion.
defaultValue(String) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets the default value of this option or positional parameter to the specified value, and returns this builder.
defaultValue(CommandLine.Model.ArgSpec) - Method in class picocli.codegen.annotation.processing.DefaultValueProviderMetaData
Always returns null.
defaultValue(CommandLine.Model.ArgSpec) - Method in interface picocli.CommandLine.IDefaultValueProvider
Returns the default value for an option or positional parameter or null.
defaultValue(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.NoDefaultProvider
 
defaultValue(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.PropertiesDefaultProvider
 
defaultValueFromProvider() - Method in class picocli.CommandLine.Model.ArgSpec
 
defaultValueProvider - Variable in class picocli.CommandLine.Model.CommandSpec
 
defaultValueProvider() - Method in annotation type picocli.CommandLine.Command
Class that can provide default values dynamically at runtime.
defaultValueProvider() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the default value provider for this command.
defaultValueProvider(CommandLine.IDefaultValueProvider) - Method in class picocli.CommandLine.Model.CommandSpec
Sets default value provider for this command.
DefaultValueProviderMetaData - Class in picocli.codegen.annotation.processing
Implementation of the CommandLine.IDefaultValueProvider interface that provides metadata on the @Command(defaultValueProvider = xxx.class) annotation.
DefaultValueProviderMetaData() - Constructor for class picocli.codegen.annotation.processing.DefaultValueProviderMetaData
 
DefaultValueProviderMetaData(TypeMirror) - Constructor for class picocli.codegen.annotation.processing.DefaultValueProviderMetaData
 
defaultValueString() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the default value String for the purpose of displaying it in the description, without interpolating variables.
defaultValueString(boolean) - Method in class picocli.CommandLine.Model.ArgSpec
Returns the default value String displayed in the description; interpolating variables if specified.
describe(Collection<CommandLine.Model.ArgSpec>) - Static method in class picocli.CommandLine.Model.ArgSpec
 
describe(Collection<CommandLine.Model.ArgSpec>, String, String, String, String) - Static method in class picocli.CommandLine.Model.ArgSpec
 
describe(List<String>, CommandLine) - Static method in exception picocli.CommandLine.UnmatchedArgumentException
 
describe(CommandLine.Model.ArgSpec, String) - Static method in class picocli.CommandLine.Model.ArgSpec
Returns a description of the option or positional arg, e.g.
describe(CommandLine.Model.ArgSpec, String, String) - Static method in class picocli.CommandLine.Model.ArgSpec
Returns a description of the option or positional arg
describeTypes(Collection<CommandLine.Model.ArgSpec>) - Static method in class picocli.CommandLine.Model.ArgSpec
 
description - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
description - Variable in class picocli.CommandLine.Model.ArgSpec
 
description - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
description() - Method in annotation type picocli.CommandLine.Command
Optional text to display between the synopsis line(s) and the list of options.
description() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns the description of this option, used when generating the usage documentation.
description() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the description of this option or positional parameter, after all variables have been rendered, including the ${DEFAULT-VALUE} and ${COMPLETION-CANDIDATES} variables.
description() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional text lines to use as the description of the help message, displayed between the synopsis and the options list.
description() - Method in annotation type picocli.CommandLine.Option
Description of this option, used when generating the usage documentation.
description() - Method in annotation type picocli.CommandLine.Parameters
Description of the parameter(s), used when generating the usage documentation.
description(Object...) - Method in class picocli.CommandLine.Help
Returns command description text as a string.
description(String...) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets the description of this option, used when generating the usage documentation, and returns this builder.
description(String...) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the optional text lines to use as the description of the help message, displayed between the synopsis and the options list.
DESCRIPTION_VARIABLE_COMPLETION_CANDIDATES - Static variable in class picocli.CommandLine.Model.ArgSpec
 
DESCRIPTION_VARIABLE_DEFAULT_VALUE - Static variable in class picocli.CommandLine.Model.ArgSpec
 
DESCRIPTION_VARIABLE_FALLBACK_VALUE - Static variable in class picocli.CommandLine.Model.ArgSpec
 
DESCRIPTION_VARIABLE_MAP_FALLBACK_VALUE - Static variable in class picocli.CommandLine.Model.ArgSpec
 
descriptionHeading - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
descriptionHeading() - Method in annotation type picocli.CommandLine.Command
Set the heading preceding the description section.
descriptionHeading() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional heading preceding the description section.
descriptionHeading(Object...) - Method in class picocli.CommandLine.Help
Returns the text displayed before the description text; an empty string if there is no description, otherwise the result of String.format(descriptionHeading, params).
descriptionHeading(String) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the heading preceding the description section.
descriptionKey - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
descriptionKey - Variable in class picocli.CommandLine.Model.ArgSpec
 
descriptionKey() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns the description key of this arg spec, used to get the description from a resource bundle.
descriptionKey() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the description key of this arg spec, used to get the description from a resource bundle.
descriptionKey() - Method in annotation type picocli.CommandLine.Option
ResourceBundle key for this option.
descriptionKey() - Method in annotation type picocli.CommandLine.Parameters
ResourceBundle key for this option.
descriptionKey(String) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets the description key that is used to look up the description in a resource bundle, and returns this builder.
detailedSynopsis(int, Comparator<CommandLine.Model.OptionSpec>, boolean) - Method in class picocli.CommandLine.Help
Generates a detailed synopsis message showing all options and parameters.
detailedSynopsis(Comparator<CommandLine.Model.OptionSpec>, boolean) - Method in class picocli.CommandLine.Help
detectTerminalWidth() - Static method in class picocli.CommandLine.Model.UsageMessageSpec
 
directory - Variable in class picocli.codegen.docgen.manpage.ManPageGenerator.Config
 
disableKey - Variable in class picocli.codegen.aot.graalvm.processor.AbstractGenerator
 
dotProduct(Map<String, Integer>, Map<String, Integer>) - Static method in class picocli.CommandLine.CosineSimilarity
 
DoubleConverter() - Constructor for class picocli.CommandLine.BuiltIn.DoubleConverter
 
DuplicateNameException(String) - Constructor for exception picocli.CommandLine.DuplicateNameException
 
DuplicateOptionAnnotationsException(String) - Constructor for exception picocli.CommandLine.DuplicateOptionAnnotationsException
 
DynamicProxyConfigGenerator - Class in picocli.codegen.aot.graalvm
DynamicProxyConfigGenerator generates a JSON String with the fully qualified interface names for which dynamic proxy classes should be generated at native image build time.
DynamicProxyConfigGenerator() - Constructor for class picocli.codegen.aot.graalvm.DynamicProxyConfigGenerator
 
DynamicProxyConfigGenerator.App - Class in picocli.codegen.aot.graalvm
 
DynamicProxyConfigGenerator.Visitor - Class in picocli.codegen.aot.graalvm
 

E

echo - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
echo - Variable in class picocli.CommandLine.Model.ArgSpec
 
echo() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns whether the user input is echoed to the console or not for an interactive option or positional parameter when asking for user input.
echo() - Method in class picocli.CommandLine.Model.ArgSpec
Returns whether the user input is echoed to the console or not for an interactive option or positional parameter when asking for user input.
echo() - Method in annotation type picocli.CommandLine.Option
Use this attribute to control whether user input for an interactive option is echoed to the console or not.
echo() - Method in annotation type picocli.CommandLine.Parameters
Use this attribute to control whether user input for an interactive positional parameter is echoed to the console or not.
echo(boolean) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets whether the user input is echoed to the console or not for an interactive option or positional parameter.
element - Variable in class picocli.codegen.annotation.processing.AnnotatedElementHolder
 
element - Variable in class picocli.codegen.annotation.processing.MixinInfo
 
element - Variable in class picocli.codegen.annotation.processing.TypedMember
 
elementTypeName(TypeMirror) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
empty(Object[]) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
empty(Object[]) - Static method in class picocli.CommandLine
 
empty(String) - Static method in class picocli.codegen.annotation.processing.TypedMember
 
empty(String) - Static method in class picocli.CommandLine
 
empty(CommandLine.Model.Messages) - Static method in class picocli.CommandLine.Model.Messages
Returns true if the specified Messages is null or has a null ResourceBundle.
EMPTY_STYLE - Static variable in class picocli.CommandLine.Help.ColorScheme
 
EMPTY_TEXT - Static variable in enum picocli.CommandLine.Help.Ansi
 
enabled() - Method in class picocli.codegen.aot.graalvm.processor.AbstractGenerator
 
enabled() - Method in enum picocli.CommandLine.Help.Ansi
Returns true if ANSI escape codes should be emitted, false otherwise.
enclosingElement() - Method in class picocli.codegen.annotation.processing.MixinInfo
 
END_OF_OPTIONS_OPTION - Variable in class picocli.CommandLine.Help
 
endCode - Variable in enum picocli.CommandLine.Help.Ansi.Style
 
endOfOptions - Variable in class picocli.CommandLine.Interpreter
 
endOfOptionsDelimiter - Variable in class picocli.CommandLine.Model.ParserSpec
 
endOfOptionsDelimiter() - Method in class picocli.CommandLine.Model.ParserSpec
 
endOfOptionsDelimiter(String) - Method in class picocli.CommandLine.Model.ParserSpec
 
endOfOptionsList() - Method in class picocli.CommandLine.Help
Returns the section of the usage help message that lists the -- End of Options delimiter and its description.
endStyles - Variable in class picocli.CommandLine.Help.Ansi.StyledSection
 
enrichForBackwardsCompatibility(T) - Method in class picocli.CommandLine
 
entrySet() - Method in class picocli.CommandLine.Model.CaseAwareLinkedMap
 
equals(Object) - Method in class picocli.codegen.annotation.processing.MixinInfo
 
equals(Object) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedField
 
equals(Object) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedMethod
 
equals(Object) - Method in class picocli.CommandLine.Help.Ansi.Palette256Color
 
equals(Object) - Method in class picocli.CommandLine.Help.Ansi.Text
 
equals(Object) - Method in class picocli.CommandLine.Help.ColorScheme
 
equals(Object) - Method in class picocli.CommandLine.Help.Column
 
equals(Object) - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
equals(Object) - Method in class picocli.CommandLine.Model.OptionSpec
 
equals(Object) - Method in class picocli.CommandLine.Model.PositionalParamSpec
 
equals(Object) - Method in class picocli.CommandLine.Model.RuntimeTypeInfo
 
equals(Object) - Method in class picocli.CommandLine.NoOpParameterPreprocessor
 
equals(Object) - Method in class picocli.CommandLine.Range
 
equals(Object, Object) - Static method in class picocli.codegen.util.Assert
 
equals(Object, Object) - Static method in class picocli.CommandLine.Assert
 
equalsImpl(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.Model.ArgSpec
 
err - Variable in class picocli.CommandLine.AbstractHandler
Deprecated.
 
err - Variable in class picocli.CommandLine
 
err - Variable in class picocli.CommandLine.HelpCommand
 
err() - Method in class picocli.CommandLine.AbstractHandler
Deprecated.
Returns the stream to print diagnostic messages to.
error(Element, String, Object...) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
Prints a compile-time error message for the specified element.
error(Element, AnnotationMirror, String, Object...) - Method in class picocli.codegen.annotation.processing.AnnotationValidator
 
ERRORMSG - Static variable in class picocli.CommandLine.Model.RuntimeTypeInfo
 
errors - Variable in class picocli.CommandLine.ParseResult.Builder
 
errors - Variable in class picocli.CommandLine.ParseResult
 
errors() - Method in class picocli.CommandLine.ParseResult
If CommandLine.Model.ParserSpec.collectErrors is true, returns the list of exceptions that were encountered during parsing, otherwise, returns an empty list.
errors(CommandLine.Help.Ansi.IStyle...) - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Adds the specified styles to the registered styles for errors in this color scheme builder and returns this builder.
errorStyles - Variable in class picocli.CommandLine.Help.ColorScheme.Builder
 
errorStyles - Variable in class picocli.CommandLine.Help.ColorScheme
 
errorStyles() - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Returns the registered styles for errors in this color scheme builder.
errorStyles() - Method in class picocli.CommandLine.Help.ColorScheme
Returns the registered styles for errors in this color scheme.
errorText(String) - Method in class picocli.CommandLine.Help.ColorScheme
Returns a Text with all error styles applied to the specified error string.
errWriter - Variable in class picocli.CommandLine.HelpCommand
 
exception - Variable in class picocli.CommandLine.ParseResult.GroupValidationResult
 
excl(String) - Method in class picocli.CommandLine.Interpreter
 
excluded - Static variable in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
excluded(String) - Static method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
excluded(String, CommandLine.Tracer) - Static method in class picocli.CommandLine.BuiltIn
 
excludeHiddenAndGroupOptions(List<CommandLine.Model.OptionSpec>) - Method in class picocli.CommandLine.Help
 
excludeHiddenAndGroupParams(List<CommandLine.Model.PositionalParamSpec>) - Method in class picocli.CommandLine.Help
 
exclusive - Variable in class picocli.CommandLine.Model.ArgGroupSpec.Builder
 
exclusive - Variable in class picocli.CommandLine.Model.ArgGroupSpec
 
exclusive() - Method in annotation type picocli.CommandLine.ArgGroup
Determines whether this is a mutually exclusive group; true by default.
exclusive() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns whether this is a mutually exclusive group; true by default.
exclusive() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns whether this is a mutually exclusive group; true by default.
exclusive(boolean) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets whether this is a mutually exclusive group; true by default.
execute(String...) - Method in class picocli.CommandLine
Convenience method to allow command line application authors to avoid some boilerplate code in their application.
execute(CommandLine.ParseResult) - Method in class picocli.CommandLine.AbstractParseResultHandler
Deprecated.
 
execute(CommandLine.ParseResult) - Method in interface picocli.CommandLine.IExecutionStrategy
"Executes" the user input and returns an exit code.
executeHelpRequest(List<CommandLine>) - Static method in class picocli.CommandLine
 
executeHelpRequest(CommandLine.ParseResult) - Static method in class picocli.CommandLine
Helper method that may be useful when processing the ParseResult that results from successfully parsing command line arguments.
executeUserObject(CommandLine, List<Object>) - Static method in class picocli.CommandLine
 
executeUserObjectOfLastSubcommandWithSameParent(List<CommandLine>) - Static method in class picocli.CommandLine.RunLast
 
ExecutionException(CommandLine, String) - Constructor for exception picocli.CommandLine.ExecutionException
 
ExecutionException(CommandLine, String, Throwable) - Constructor for exception picocli.CommandLine.ExecutionException
 
executionExceptionHandler - Variable in class picocli.CommandLine
 
executionResult - Variable in class picocli.CommandLine
 
executionStrategy - Variable in class picocli.CommandLine
 
exit - Variable in class picocli.codegen.aot.graalvm.DynamicProxyConfigGenerator.App
 
exit - Variable in class picocli.codegen.aot.graalvm.JniConfigGenerator.App
 
exit - Variable in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.App
 
exit - Variable in class picocli.codegen.aot.graalvm.ResourceConfigGenerator.App
 
exit - Variable in class picocli.codegen.docgen.manpage.ManPageGenerator.App
 
exit(int) - Method in class picocli.CommandLine.AbstractHandler
Deprecated.
Calls System.exit(int) with the specified exit code.
EXIT_CODE_COMMAND_SCRIPT_EXISTS - Static variable in class picocli.AutoComplete
Exit code of this application when the specified command script exists (2).
EXIT_CODE_COMPLETION_SCRIPT_EXISTS - Static variable in class picocli.AutoComplete
Exit code of this application when the specified completion script exists (3).
EXIT_CODE_EXECUTION_ERROR - Static variable in class picocli.AutoComplete
Exit code of this application when an exception was encountered during operation (4).
EXIT_CODE_INVALID_INPUT - Static variable in class picocli.AutoComplete
Exit code of this application when the specified command line arguments are invalid (1).
EXIT_CODE_SUCCESS - Static variable in class picocli.AutoComplete
Normal exit code of this application (0).
EXIT_CODE_TEMPLATE_EXISTS - Static variable in class picocli.codegen.docgen.manpage.ManPageGenerator
 
exitCode - Variable in class picocli.CommandLine.AbstractHandler
Deprecated.
 
exitCode() - Method in class picocli.CommandLine.AbstractHandler
Deprecated.
Returns the exit code to use as the termination status, or null (the default) if the handler should not call System.exit(int) after processing completes.
ExitCode() - Constructor for class picocli.CommandLine.ExitCode
 
exitCodeExceptionMapper - Variable in class picocli.CommandLine
 
exitCodeList - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
exitCodeList() - Method in annotation type picocli.CommandLine.Command
Set the values to be displayed in the exit codes section as a list of "key:value" pairs: keys are exit codes, values are descriptions.
exitCodeList() - Method in class picocli.CommandLine.Help
Returns a 2-column list with exit codes and their description.
exitCodeList() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns an unmodifiable map with values to be displayed in the exit codes section: keys are exit codes, values are descriptions.
exitCodeList(Map<String, String>) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the values to be displayed in the exit codes section: keys are exit codes, values are descriptions.
exitCodeListHeading - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
exitCodeListHeading() - Method in annotation type picocli.CommandLine.Command
Set the heading preceding the exit codes section, may contain "%n" line separators.
exitCodeListHeading() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional heading preceding the exit codes section, may contain "%n" line separators.
exitCodeListHeading(Object...) - Method in class picocli.CommandLine.Help
Returns the text displayed before the exit code list text; the result of String.format(exitCodeHeading, params).
exitCodeListHeading(String) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the optional heading preceding the exit codes section, may contain "%n" line separators.
exitCodeListStrings - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
exitCodeOnExecutionException - Variable in class picocli.CommandLine.Model.CommandSpec
 
exitCodeOnExecutionException() - Method in annotation type picocli.CommandLine.Command
Exit code signifying that an exception occurred when invoking the Runnable, Callable or Method user object of a command.
exitCodeOnExecutionException() - Method in class picocli.CommandLine.Model.CommandSpec
Returns exit code signifying that an exception occurred when invoking the Runnable, Callable or Method user object of a command.
exitCodeOnExecutionException(int) - Method in class picocli.CommandLine.Model.CommandSpec
Sets exit code signifying that an exception occurred when invoking the Runnable, Callable or Method user object of a command.
exitCodeOnInvalidInput - Variable in class picocli.CommandLine.Model.CommandSpec
 
exitCodeOnInvalidInput() - Method in annotation type picocli.CommandLine.Command
Exit code for command line usage error.
exitCodeOnInvalidInput() - Method in class picocli.CommandLine.Model.CommandSpec
Returns exit code for command line usage error.
exitCodeOnInvalidInput(int) - Method in class picocli.CommandLine.Model.CommandSpec
Sets exit code for command line usage error.
exitCodeOnSuccess - Variable in class picocli.CommandLine.Model.CommandSpec
 
exitCodeOnSuccess() - Method in annotation type picocli.CommandLine.Command
Exit code for successful termination.
exitCodeOnSuccess() - Method in class picocli.CommandLine.Model.CommandSpec
Returns exit code for successful termination.
exitCodeOnSuccess(int) - Method in class picocli.CommandLine.Model.CommandSpec
Sets exit code for successful termination.
exitCodeOnUsageHelp - Variable in class picocli.CommandLine.Model.CommandSpec
 
exitCodeOnUsageHelp() - Method in annotation type picocli.CommandLine.Command
Exit code for successful termination after printing usage help on user request.
exitCodeOnUsageHelp() - Method in class picocli.CommandLine.Model.CommandSpec
Returns exit code for successful termination after printing usage help on user request.
exitCodeOnUsageHelp(int) - Method in class picocli.CommandLine.Model.CommandSpec
Sets exit code for successful termination after printing usage help on user request.
exitCodeOnVersionHelp - Variable in class picocli.CommandLine.Model.CommandSpec
 
exitCodeOnVersionHelp() - Method in annotation type picocli.CommandLine.Command
Exit code for successful termination after printing version help on user request.
exitCodeOnVersionHelp() - Method in class picocli.CommandLine.Model.CommandSpec
Returns exit code for successful termination after printing version help on user request.
exitCodeOnVersionHelp(int) - Method in class picocli.CommandLine.Model.CommandSpec
Sets exit code for successful termination after printing version help on user request.
exitOnError() - Static method in class picocli.AutoComplete
 
exitOnSuccess() - Static method in class picocli.AutoComplete
 
expandArgumentFile(String, List<String>, Set<String>) - Method in class picocli.CommandLine.Interpreter
 
expandAtFiles - Variable in class picocli.CommandLine.Model.ParserSpec
 
expandAtFiles() - Method in class picocli.CommandLine.Model.ParserSpec
 
expandAtFiles(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
expandedArgList - Variable in class picocli.CommandLine.ParseResult.Builder
 
expandedArgs - Variable in class picocli.CommandLine.ParseResult
 
expandedArgs() - Method in class picocli.CommandLine.ParseResult
Returns the command line arguments after @-files were expanded; these are the arguments that were actually parsed.
expandedArgs(Collection<String>) - Method in class picocli.CommandLine.ParseResult.Builder
Sets the specified command line arguments after @-files were expanded; these are the arguments that were actually parsed.
expandValidArgumentFile(String, File, List<String>, Set<String>) - Method in class picocli.CommandLine.Interpreter
 
expandVariables(String[]) - Method in class picocli.CommandLine.Model.ArgSpec
 
extract(Iterable<String>) - Static method in class picocli.AutoComplete
 
extract(Element) - Static method in class picocli.codegen.annotation.processing.CompletionCandidatesMetaData
Returns the completion candidates from the annotations present on the specified element.
extract(Element) - Static method in class picocli.codegen.annotation.processing.ParameterConsumerMetaData
Returns the type converters from the annotations present on the specified element.
extract(Element) - Static method in class picocli.codegen.annotation.processing.TypeConverterMetaData
Returns the type converters from the annotations present on the specified element.
extractArgGroupSpec(CommandLine.Model.IAnnotatedElement, CommandLine.IFactory, CommandLine.Model.CommandSpec, boolean) - Static method in class picocli.CommandLine.Model.CommandReflection
 
extractBlockingFailure(List<CommandLine.ParseResult.GroupValidationResult>) - Static method in class picocli.CommandLine.ParseResult.GroupValidationResult
 
extractCommandSpec(Object, CommandLine.IFactory, boolean) - Static method in class picocli.CommandLine.Model.CommandReflection
 
extractExitCodeGenerators(CommandLine.ParseResult) - Method in class picocli.CommandLine.AbstractParseResultHandler
Deprecated.
 
extractExitCodeGenerators(CommandLine.ParseResult) - Method in class picocli.CommandLine.RunAll
 
extractExitCodeGenerators(CommandLine.ParseResult) - Method in class picocli.CommandLine.RunFirst
 
extractExitCodeGenerators(CommandLine.ParseResult) - Method in class picocli.CommandLine.RunLast
 
extractName(ResourceBundle) - Static method in class picocli.CommandLine.Model.Messages
 
extractTypedMember(Element, String) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
extractTypeParameters(ParameterizedType) - Static method in class picocli.CommandLine.Model.RuntimeTypeInfo
 

F

factory - Variable in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Context
 
factory - Variable in class picocli.CommandLine
 
factory - Variable in class picocli.CommandLine.Model.CommandUserObject
 
factoryClass - Variable in class picocli.AutoComplete.App
 
factoryClass - Variable in class picocli.codegen.aot.graalvm.DynamicProxyConfigGenerator.App
 
factoryClass - Variable in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.App
 
factoryClass - Variable in class picocli.codegen.aot.graalvm.ResourceConfigGenerator.App
 
factoryClass - Variable in class picocli.codegen.docgen.manpage.ManPageGenerator.App
 
fail(String, Class<?>) - Static method in class picocli.CommandLine.BuiltIn
 
fail(String, Class<?>, String) - Static method in class picocli.CommandLine.BuiltIn
 
failGroupMultiplicityExceeded(List<CommandLine.ParseResult.GroupMatch>, CommandLine) - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
FAILURE_ABSENT - picocli.CommandLine.ParseResult.GroupValidationResult.Type
 
FAILURE_PARTIAL - picocli.CommandLine.ParseResult.GroupValidationResult.Type
 
FAILURE_PRESENT - picocli.CommandLine.ParseResult.GroupValidationResult.Type
 
faint - picocli.CommandLine.Help.Ansi.Style
 
fallbackValue - Variable in class picocli.CommandLine.Model.OptionSpec.Builder
 
fallbackValue - Variable in class picocli.CommandLine.Model.OptionSpec
 
fallbackValue() - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Returns the fallback value for this option: the value that is assigned for options with an optional parameter if the option was specified on the command line without parameter.
fallbackValue() - Method in class picocli.CommandLine.Model.OptionSpec
Returns the fallback value for this option: the value that is assigned for options with an optional parameter (for example, arity = "0..1") if the option was specified on the command line without parameter.
fallbackValue() - Method in annotation type picocli.CommandLine.Option
For options with an optional parameter (for example, arity = "0..1"), this value is assigned to the annotated element if the option is specified on the command line without an option parameter.
fallbackValue(String) - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Sets the fallback value for this option: the value that is assigned for options with an optional parameter if the option was specified on the command line without parameter, and returns this builder.
fatalError(String) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
Prints a compile-time error message prefixed with "FATAL ERROR".
fatalError(String) - Method in class picocli.codegen.aot.graalvm.processor.AbstractGenerator
Prints a compile-time error message prefixed with "FATAL ERROR".
fg(String) - Static method in enum picocli.CommandLine.Help.Ansi.Style
Parses the specified style markup and returns the associated style.
fg_black - picocli.CommandLine.Help.Ansi.Style
 
fg_blue - picocli.CommandLine.Help.Ansi.Style
 
fg_cyan - picocli.CommandLine.Help.Ansi.Style
 
fg_green - picocli.CommandLine.Help.Ansi.Style
 
fg_magenta - picocli.CommandLine.Help.Ansi.Style
 
fg_red - picocli.CommandLine.Help.Ansi.Style
 
fg_white - picocli.CommandLine.Help.Ansi.Style
 
fg_yellow - picocli.CommandLine.Help.Ansi.Style
 
fgbg - Variable in class picocli.CommandLine.Help.Ansi.Palette256Color
 
field - Variable in class picocli.CommandLine.Model.FieldBinding
 
FieldBinding(Object, Field) - Constructor for class picocli.CommandLine.Model.FieldBinding
 
FieldBinding(CommandLine.Model.IScope, Field) - Constructor for class picocli.CommandLine.Model.FieldBinding
 
fields - Variable in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedClass
 
FileConverter() - Constructor for class picocli.CommandLine.BuiltIn.FileConverter
 
fileName - Variable in class picocli.codegen.aot.graalvm.processor.AbstractGenerator
 
fileName() - Method in class picocli.codegen.aot.graalvm.processor.AbstractGenerator
 
filter(List<T>, AutoComplete.Predicate<K>) - Static method in class picocli.AutoComplete
 
filterAndTrimMatchingPrefix(String, List<CharSequence>) - Static method in class picocli.AutoComplete
 
find(String, TypeElement) - Static method in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
find(String, TypeElement, Set<Element>) - Static method in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
findClosingBrace(String, int) - Method in class picocli.CommandLine.Model.Interpolator
 
findCommandFor(CommandLine.Model.ArgSpec, CommandLine.Model.CommandSpec) - Static method in class picocli.AutoComplete
 
findCommandFor(CommandLine.Model.OptionSpec, CommandLine.Model.CommandSpec) - Static method in class picocli.AutoComplete
 
findCommandFor(CommandLine.Model.PositionalParamSpec, CommandLine.Model.CommandSpec) - Static method in class picocli.AutoComplete
 
findCompletionStartPoint(CommandLine.ParseResult) - Static method in class picocli.AutoComplete
 
findLastMatchContainer(CommandLine.Model.ArgGroupSpec) - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
findMatchContainers(CommandLine.Model.ArgGroupSpec, List<CommandLine.ParseResult.GroupMatchContainer>) - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
findMatches(CommandLine.Model.ArgGroupSpec) - Method in class picocli.CommandLine.ParseResult
Returns the matches for the specified argument group.
findOpeningDollar(String, String, int) - Method in class picocli.CommandLine.Model.Interpolator
 
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(char, Iterable<CommandLine.Model.OptionSpec>) - Static method in class picocli.CommandLine.Model.CommandSpec
 
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.
findOption(String, List<CommandLine.Model.OptionSpec>) - Static method in class picocli.CommandLine.Model.CommandSpec
 
findOrCreateMatchingGroup(CommandLine.Model.ArgSpec, CommandLine) - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
findSectionContaining(int) - Method in class picocli.CommandLine.Help.Ansi.Text
 
findSubcommands(List<? extends AnnotationMirror>, AbstractCommandSpecProcessor.Context, RoundEnvironment) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
findVisibleOptionNamesWithPrefix(String) - Method in class picocli.CommandLine.Model.CommandSpec
 
firstElement(String[]) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
firstElement(List<Object>) - Static method in class picocli.CommandLine
 
firstUnmatchedPosition - Variable in class picocli.CommandLine.ParseResult.Builder
 
flatList(Collection<? extends Collection<T>>) - Static method in class picocli.CommandLine
 
flatten(Collection<CommandLine.Model.ArgGroupSpec>, Set<CommandLine.Model.ArgGroupSpec>) - Method in class picocli.CommandLine.Model.CommandSpec
 
flatten(CommandLine.Model.ArgGroupSpec, Set<CommandLine.Model.ArgGroupSpec>) - Method in class picocli.CommandLine.Model.CommandSpec
 
FloatConverter() - Constructor for class picocli.CommandLine.BuiltIn.FloatConverter
 
footer - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
footer() - Method in annotation type picocli.CommandLine.Command
Optional text to display after the list of options.
footer() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional footer text lines displayed at the bottom of the help message.
footer(Object...) - Method in class picocli.CommandLine.Help
Returns command footer text as a string.
footer(String...) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the optional footer text lines displayed at the bottom of the help message.
footerHeading - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
footerHeading() - Method in annotation type picocli.CommandLine.Command
Set the heading preceding the footer section.
footerHeading() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional heading preceding the footer section.
footerHeading(Object...) - Method in class picocli.CommandLine.Help
Returns the text displayed before the footer text; the result of String.format(footerHeading, params).
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.
force - Variable in class picocli.codegen.docgen.manpage.ManPageGenerator.Config
 
forceDisabled() - Static method in enum picocli.CommandLine.Help.Ansi
https://no-color.org/
forceEnabled() - Static method in enum picocli.CommandLine.Help.Ansi
Jan Niklas Hasse's https://bixense.com/clicolors/ proposal
forColumns(CommandLine.Help.Ansi, CommandLine.Help.Column...) - Static method in class picocli.CommandLine.Help.TextTable
forColumns(CommandLine.Help.ColorScheme, CommandLine.Help.Column...) - Static method in class picocli.CommandLine.Help.TextTable
Constructs a TextTable with the specified columns.
forColumnWidths(CommandLine.Help.Ansi, int...) - Static method in class picocli.CommandLine.Help.TextTable
forColumnWidths(CommandLine.Help.ColorScheme, int...) - Static method in class picocli.CommandLine.Help.TextTable
Constructs a new TextTable with columns with the specified width, all SPANning multiple columns on overflow except the last column which WRAPS to the next row.
forDefaultColumns(CommandLine.Help.Ansi, int) - Static method in class picocli.CommandLine.Help.TextTable
forDefaultColumns(CommandLine.Help.Ansi, int, int) - Static method in class picocli.CommandLine.Help.TextTable
forDefaultColumns(CommandLine.Help.ColorScheme, int, int) - Static method in class picocli.CommandLine.Help.TextTable
Constructs a TextTable with five columns as follows: required option/parameter marker (width: 2, indent: 0, TRUNCATE on overflow) short option name (width: 2, indent: 0, TRUNCATE on overflow) comma separator (width: 1, indent: 0, TRUNCATE on overflow) long option name(s) (width: 24, indent: 1, SPAN multiple columns on overflow) description line(s) (width: 51, indent: 1, WRAP to next row on overflow)
format(String, Object...) - Static method in class picocli.CommandLine
 
format(LogRecord) - Method in class picocli.codegen.util.JulLogFormatter
 
formatParamTypes() - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedMethod
 
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.
from - Variable in class picocli.CommandLine.Help.Ansi.Text
 
fullSynopsis() - Method in class picocli.CommandLine.Help
Returns the full usage synopsis of this command.
functionName - Variable in class picocli.AutoComplete.CommandDescriptor
 

G

genCommands(PrintWriter, CommandLine.Model.CommandSpec) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
generate(Map<Element, CommandLine.Model.CommandSpec>) - Method in class picocli.codegen.aot.graalvm.processor.AbstractGenerator
 
generate(Map<Element, CommandLine.Model.CommandSpec>) - Method in interface picocli.codegen.aot.graalvm.processor.IGenerator
 
generate(JavaFileManager.Location, String, String, ProcessingEnvironment, Element...) - Static method in class picocli.codegen.aot.graalvm.processor.ProcessorUtil
 
GenerateCompletion() - Constructor for class picocli.AutoComplete.GenerateCompletion
 
generateCompletionCandidates(StringBuilder, CommandLine.Model.OptionSpec) - Static method in class picocli.AutoComplete
 
generateConfig(Map<Element, CommandLine.Model.CommandSpec>) - Method in class picocli.codegen.aot.graalvm.processor.AbstractGenerator
 
generateConfig(CommandLine.Model.CommandSpec[]) - Method in class picocli.codegen.aot.graalvm.processor.AbstractGenerator
 
generateConfig(CommandLine.Model.CommandSpec[]) - Method in class picocli.codegen.aot.graalvm.processor.ProxyConfigGen
 
generateConfig(CommandLine.Model.CommandSpec[]) - Method in class picocli.codegen.aot.graalvm.processor.ReflectConfigGen
 
generateConfig(CommandLine.Model.CommandSpec[]) - Method in class picocli.codegen.aot.graalvm.processor.ResourceConfigGen
 
generateCustomizableTemplate(ManPageGenerator.Config, CommandLine.Model.CommandSpec) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
generateEntryPointFunction(String, CommandLine, List<AutoComplete.CommandDescriptor>) - Static method in class picocli.AutoComplete
 
generateFunctionCallsToArrContains(StringBuilder, List<String>, List<AutoComplete.CommandDescriptor>) - Static method in class picocli.AutoComplete
 
generateFunctionForCommand(String, String, CommandLine) - Static method in class picocli.AutoComplete
 
generateJniConfig(Class<?>[]) - Static method in class picocli.codegen.aot.graalvm.JniConfigGenerator
 
generateManPage(File, File, boolean[], boolean, CommandLine.Model.CommandSpec...) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
Generates AsciiDoc files for the specified classes to the specified output directory, optionally also generating template files in the customizablePagesDirectory directory.
generateManPage(ManPageGenerator.Config, CommandLine.Model.CommandSpec...) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
generateOptionsCases(List<CommandLine.Model.OptionSpec>, String, String) - Static method in class picocli.AutoComplete
 
generateOptionsSwitch(List<CommandLine.Model.OptionSpec>) - Static method in class picocli.AutoComplete
 
generatePositionalParamsCases(List<CommandLine.Model.PositionalParamSpec>, String, String) - Static method in class picocli.AutoComplete
 
generatePositionParamCompletionCandidates(StringBuilder, CommandLine.Model.PositionalParamSpec) - Static method in class picocli.AutoComplete
 
generateProxyConfig(CommandLine.Model.CommandSpec[], String[]) - Static method in class picocli.codegen.aot.graalvm.DynamicProxyConfigGenerator
Returns a JSON String with the interface names to generate dynamic proxy classes for in the native image, used by the specified CommandSpec objects.
generateReflectionConfig(ReflectionConfigGenerator.Visitor) - Static method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator
 
generateReflectionConfig(CommandLine.Model.CommandSpec...) - Static method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator
Returns a JSON String with the program elements that will be accessed reflectively for the specified CommandSpec objects.
generateResourceConfig(CommandLine.Model.CommandSpec[], String[], String[]) - Static method in class picocli.codegen.aot.graalvm.ResourceConfigGenerator
Returns a JSON String with the resources and resource bundles to include for the specified CommandSpec objects.
generateSingleManPage(ManPageGenerator.Config, CommandLine.Model.CommandSpec) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
generateSingleManPage(CommandLine.Model.CommandSpec, File) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
generators - Variable in class picocli.codegen.aot.graalvm.processor.AbstractCompositeGeneratorProcessor
 
genExitStatus(PrintWriter, CommandLine.Model.CommandSpec) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
genFooter(PrintWriter, CommandLine.Model.CommandSpec) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
genHeader(PrintWriter, CommandLine.Model.CommandSpec) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
genOptions(PrintWriter, CommandLine.Model.CommandSpec) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
genPositionalArgs(PrintWriter, CommandLine.Model.CommandSpec) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
get() - Method in class picocli.codegen.annotation.processing.AnnotatedElementHolder
This implementation does nothing and always returns null.
get() - Method in class picocli.CommandLine.Model.CommandUserObject
 
get() - Method in class picocli.CommandLine.Model.FieldBinding
 
get() - Method in interface picocli.CommandLine.Model.IGetter
Returns the current value of the binding.
get() - Method in class picocli.CommandLine.Model.MethodBinding
 
get() - Method in class picocli.CommandLine.Model.ObjectBinding
 
get() - Method in class picocli.CommandLine.Model.ObjectScope
 
get() - Method in class picocli.CommandLine.Model.PicocliInvocationHandler.ProxyBinding
 
get(Object) - Method in class picocli.CommandLine.Model.CaseAwareLinkedMap
 
get(String) - Method in interface picocli.CommandLine.Model.Interpolator.ILookup
 
getActualGenericTypeArguments() - Method in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
getActualGenericTypeArguments() - Method in interface picocli.CommandLine.Model.ITypeInfo
Returns the names of the type arguments if this is a generic type.
getActualGenericTypeArguments() - Method in class picocli.CommandLine.Model.RuntimeTypeInfo
 
getActualTypeConverter(Class<?>, CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.Interpreter
 
getAdditionalDescriptionKeys() - Method in class picocli.CommandLine.Model.ArgSpec
Subclasses should override to return a collection of additional description keys that may be used to find description text for this option or positional parameter in the resource bundle.
getAdditionalDescriptionKeys() - Method in class picocli.CommandLine.Model.OptionSpec
Returns the additional lookup keys for finding description lines in the resource bundle for this option.
getAdditionalDescriptionKeys() - Method in class picocli.CommandLine.Model.PositionalParamSpec
Returns the additional lookup keys for finding description lines in the resource bundle for this positional parameter.
getAnnotation(Class<T>) - Method in class picocli.codegen.annotation.processing.TypedMember
 
getAnnotation(Class<T>) - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
getAnnotation(Class<T>) - Method in class picocli.CommandLine.Model.MethodParam
 
getAnnotation(Class<T>) - Method in class picocli.CommandLine.Model.TypedMember
 
getArgSpec() - Method in exception picocli.CommandLine.ParameterException
Returns the ArgSpec object for the (sub)command whose input could not be parsed.
getAtFileCommentChar() - Method in class picocli.CommandLine
Returns the character that starts a single-line comment or null if all content of argument files should be interpreted as arguments (without comments).
getAuxiliaryTypeInfos() - Method in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
getAuxiliaryTypeInfos() - Method in interface picocli.CommandLine.Model.ITypeInfo
Returns type information of components or elements of a multivalue type.
getAuxiliaryTypeInfos() - Method in class picocli.CommandLine.Model.RuntimeTypeInfo
 
getAuxiliaryTypes() - Method in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
getAuxiliaryTypes() - Method in interface picocli.CommandLine.Model.ITypeInfo
Returns the component class of an array, or the parameter type of a generic Collection, or the parameter types of the key and the value of a generic Map.
getAuxiliaryTypes() - Method in class picocli.CommandLine.Model.RuntimeTypeInfo
 
getAuxiliaryTypes() - Method in class picocli.CommandLine.Model.TypedMember
 
getCaseSensitiveKey(K) - Method in class picocli.CommandLine.Model.CaseAwareLinkedMap
Returns the case-sensitive key of the specified case-insensitive key if isCaseSensitive().
getCJKAdjustedLength() - Method in class picocli.CommandLine.Help.Ansi.Text
Returns the number of columns this Text will occupy on the console, adjusted for wide CJK characters.
getCJKAdjustedLength(int, int) - Method in class picocli.CommandLine.Help.Ansi.Text
Returns the number of columns that the specified portion of this Text will occupy on the console, adjusted for wide CJK characters.
getClassName() - Method in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
Returns the fully qualified class name (not the canonical name, but with $-signs for inner classes) of the typeElement.
getClassName() - Method in interface picocli.CommandLine.Model.ITypeInfo
 
getClassName() - Method in class picocli.CommandLine.Model.RuntimeTypeInfo
 
getClassSimpleName() - Method in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
getClassSimpleName() - Method in interface picocli.CommandLine.Model.ITypeInfo
 
getClassSimpleName() - Method in class picocli.CommandLine.Model.RuntimeTypeInfo
 
getColorScheme() - Method in class picocli.CommandLine
Returns the color scheme to use when printing help.
getCommand() - Method in class picocli.CommandLine
Returns the annotated user object that this CommandLine instance was constructed with.
getCommandLine() - Method in exception picocli.CommandLine.ExecutionException
Returns the CommandLine object for the (sub)command that could not be invoked.
getCommandLine() - Method in exception picocli.CommandLine.ParameterException
Returns the CommandLine object for the (sub)command whose input could not be parsed.
getCommandMethods(Class<?>, String) - Static method in class picocli.CommandLine
Helper to get methods of a class annotated with @Command via reflection, optionally filtered by method name (not @Command.name).
getCommandMethods(Class<?>, String, boolean) - Static method in class picocli.CommandLine
 
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.
getCommandSpecs(String, Class<?>[]) - Static method in class picocli.codegen.util.Util
 
getDeclaredAnnotations() - Method in class picocli.CommandLine.Model.MethodParam
 
getDeclaringExecutable() - Method in class picocli.CommandLine.Model.MethodParam
 
getDefaultValueProvider() - Method in class picocli.CommandLine
Returns the default value provider for the command, or null if none has been set.
getElement() - Method in class picocli.codegen.annotation.processing.AnnotatedElementHolder
Returns the program element annotated with @Option or @Parameters.
getEndOfOptionsDelimiter() - Method in class picocli.CommandLine
Returns the end-of-options delimiter that signals that the remaining command line arguments should be treated as positional parameters.
getEnumConstantNames() - Method in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
getEnumConstantNames() - Method in interface picocli.CommandLine.Model.ITypeInfo
 
getEnumConstantNames() - Method in class picocli.CommandLine.Model.RuntimeTypeInfo
 
getEnumTypeConverter(Class<?>) - Method in class picocli.CommandLine.Interpreter
 
getErr() - Method in class picocli.CommandLine
Returns the writer to use when printing diagnostic (error) messages during command execution.
getExecutionExceptionHandler() - Method in class picocli.CommandLine
Returns the handler for dealing with exceptions that occurred in the Callable, Runnable or Method user object of a command when the command was executed.
getExecutionResult() - Method in class picocli.CommandLine
Returns the result of calling the user object Callable or invoking the user object Method after parsing the user input, or null if this command has not been executed or if this CommandLine is for a subcommand that was not specified by the end user on the command line.
getExecutionStrategy() - Method in class picocli.CommandLine
Returns the execution strategy used by the execute method to invoke the business logic on the user objects of this command and/or the user-specified subcommand(s).
getExitCode() - Method in interface picocli.CommandLine.IExitCodeGenerator
Returns the exit code that should be returned from the execute method.
getExitCode(Throwable) - Method in interface picocli.CommandLine.IExitCodeExceptionMapper
Returns the exit code that should be returned from the execute method.
getExitCodeExceptionMapper() - Method in class picocli.CommandLine
Returns the mapper that was set by the application to map from exceptions to exit codes, for use by the execute method.
getExtension(Class<T>) - Method in class picocli.codegen.annotation.processing.TypedMember
 
getExtension(Class<T>) - Method in interface picocli.CommandLine.Model.IExtensible
Returns an instance of the specified class, or null if this extension is not supported.
getExtension(Class<T>) - Method in class picocli.CommandLine.Model.TypedMember
 
getFactory() - Method in class picocli.CommandLine
Returns the factory that this CommandLine was constructed with.
getGroupMatches() - Method in class picocli.CommandLine.ParseResult
Returns the top-level container for the ArgGroupSpec match or matches found.
getHelp() - Method in class picocli.CommandLine
Returns a new Help object created by the IHelpFactory with the CommandSpec and ColorScheme of this command.
getHelpFactory() - Method in class picocli.CommandLine
Returns the IHelpFactory that is used to construct the usage help message.
getHelpFactory() - Method in class picocli.CommandLine.Help
Returns the IHelpFactory that this Help was constructed with.
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.
getInstance() - Method in class picocli.CommandLine.Model.CommandUserObject
 
getLocale() - Method in class picocli.CommandLine.Model.CaseAwareLinkedMap
Returns the locale of the map.
getMaskedValue(CommandLine.Model.ArgSpec, String) - Method in class picocli.CommandLine.Interpreter
 
getMethodParamPosition() - Method in class picocli.codegen.annotation.processing.TypedMember
 
getMethodParamPosition() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
getMethodParamPosition() - Method in class picocli.CommandLine.Model.TypedMember
 
getMissing() - Method in exception picocli.CommandLine.MissingParameterException
 
getMixinName() - Method in class picocli.codegen.annotation.processing.TypedMember
 
getMixinName() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
getMixinName() - Method in class picocli.CommandLine.Model.TypedMember
 
getMixins() - Method in class picocli.CommandLine
Returns a map of user objects whose options and positional parameters were added to ("mixed in" with) this command.
getName() - Method in class picocli.codegen.annotation.processing.TypedMember
 
getName() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
getName() - Method in class picocli.CommandLine.Model.MethodParam
 
getName() - Method in class picocli.CommandLine.Model.TypedMember
 
getNegatableOptionTransformer() - Method in class picocli.CommandLine
Returns the INegatableOptionTransformer used to create the negative form of negatable options.
getOptionalEmpty() - Static method in class picocli.CommandLine
 
getOptionalOfNullable(Object) - Static method in class picocli.CommandLine
 
getOrCreateClass(Class<?>) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
getOrCreateClassByName(Class<?>) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
getOrCreateClassByName(String) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
getOrCreateCommandSpecForArg(Element, Map<Element, CommandLine.Model.CommandSpec>) - Static method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Context
 
getOut() - Method in class picocli.CommandLine
Returns the writer used when printing user-requested usage help or version help during command execution.
getOverwritten() - Method in exception picocli.CommandLine.OverwrittenOptionException
Returns the CommandLine.Model.ArgSpec for the option which was being overwritten.
getParameterExceptionHandler() - Method in class picocli.CommandLine
Returns the handler for dealing with invalid user input when the command is executed.
getParameterizedType() - Method in class picocli.CommandLine.Model.MethodParam
 
getParent() - Method in class picocli.CommandLine
Returns the command that this is a subcommand of, or null if this is a top-level command.
getParseResult() - Method in class picocli.CommandLine
 
getPicocliAnnotationMirror(Element) - Method in class picocli.codegen.annotation.processing.AnnotationValidator
 
getPosition(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.Interpreter
 
getResourceBundle() - Method in class picocli.CommandLine
Returns the ResourceBundle of this command or null if no resource bundle is set.
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.
getSupportedAnnotationTypes() - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
Returns the annotation types supported by the super class, and adds "picocli.*" if necessary.
getSupportedSourceVersion() - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
Returns the max supported source version.
getSysPropertyWidthOrDefault(int, boolean) - Method in class picocli.CommandLine.Model.UsageMessageSpec
 
getter - Variable in class picocli.codegen.annotation.processing.TypedMember
 
getter - Variable in class picocli.CommandLine.Model.ArgGroupSpec.Builder
 
getter - Variable in class picocli.CommandLine.Model.ArgGroupSpec
 
getter - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
getter - Variable in class picocli.CommandLine.Model.ArgSpec
 
getter - Variable in class picocli.CommandLine.Model.TypedMember
 
getter - Variable in class picocli.CommandLine.Model.UnmatchedArgsBinding
 
getter() - Method in class picocli.codegen.annotation.processing.TypedMember
 
getter() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the CommandLine.Model.IGetter that is responsible for supplying the value of the annotated program element associated with this group.
getter() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the CommandLine.Model.IGetter that is responsible for supplying the value of the annotated program element associated with this group.
getter() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns the CommandLine.Model.IGetter that is responsible for supplying the value of this argument.
getter() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the CommandLine.Model.IGetter that is responsible for supplying the value of this argument.
getter() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
getter() - Method in class picocli.CommandLine.Model.TypedMember
 
getter() - Method in class picocli.CommandLine.Model.UnmatchedArgsBinding
Returns the getter responsible for producing a Collection that the unmatched arguments can be added to.
getter(CommandLine.Model.IGetter) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets the CommandLine.Model.IGetter that is responsible for getting the value of the annotated program element associated with this group, and returns this builder.
getter(CommandLine.Model.IGetter) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets the CommandLine.Model.IGetter that is responsible for getting the value of this argument, and returns this builder.
getTerminalWidth() - Static method in class picocli.CommandLine.Model.UsageMessageSpec
 
getToString() - Method in class picocli.codegen.annotation.processing.TypedMember
 
getToString() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
getToString() - Method in class picocli.CommandLine.Model.TypedMember
 
getType() - Method in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
getType() - Method in class picocli.CommandLine.Model.CommandUserObject
 
getType() - Method in interface picocli.CommandLine.Model.ITypeInfo
Returns the class that the option or parameter value should be converted to when matched on the command line.
getType() - Method in class picocli.CommandLine.Model.MethodParam
 
getType() - Method in class picocli.CommandLine.Model.RuntimeTypeInfo
 
getType() - Method in class picocli.CommandLine.Model.TypedMember
 
getTypeConverter(Class<?>[], CommandLine.Model.ArgSpec, int) - Method in class picocli.CommandLine.Interpreter
 
getTypeElement() - Method in class picocli.codegen.annotation.processing.CompletionCandidatesMetaData
 
getTypeElement() - Method in class picocli.codegen.annotation.processing.DefaultValueProviderMetaData
 
getTypeElement() - Method in interface picocli.codegen.annotation.processing.ITypeMetaData
Returns the TypeElement of the type mirror.
getTypeElement() - Method in class picocli.codegen.annotation.processing.ParameterConsumerMetaData
 
getTypeElement() - Method in class picocli.codegen.annotation.processing.TypeConverterMetaData
 
getTypeElement() - Method in class picocli.codegen.annotation.processing.VersionProviderMetaData
 
getTypeInfo() - Method in class picocli.codegen.annotation.processing.TypedMember
 
getTypeInfo() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
getTypeInfo() - Method in class picocli.CommandLine.Model.TypedMember
 
getTypeMirror() - Method in class picocli.codegen.annotation.processing.CompletionCandidatesMetaData
Returns the TypeMirror that this TypeConverterMetaData was constructed with.
getTypeMirror() - Method in class picocli.codegen.annotation.processing.DefaultValueProviderMetaData
Returns the TypeMirror that this DefaultValueProviderMetaData was constructed with.
getTypeMirror() - Method in interface picocli.codegen.annotation.processing.ITypeMetaData
Returns the TypeMirror of the value.
getTypeMirror() - Method in class picocli.codegen.annotation.processing.ParameterConsumerMetaData
Returns the TypeMirror that this TypeConverterMetaData was constructed with.
getTypeMirror() - Method in class picocli.codegen.annotation.processing.TypeConverterMetaData
Returns the TypeMirror that this TypeConverterMetaData was constructed with.
getTypeMirror() - Method in class picocli.codegen.annotation.processing.VersionProviderMetaData
Returns the TypeMirror that this VersionProviderMetaData was constructed with.
getUnmatched() - Method in exception picocli.CommandLine.UnmatchedArgumentException
Returns the unmatched command line arguments.
getUnmatchedArguments() - Method in class picocli.CommandLine
Returns the list of unmatched command line arguments, if any.
getUsageHelpLongOptionsMaxWidth() - Method in class picocli.CommandLine
Returns the maximum usage help long options column max width to the specified value.
getUsageHelpWidth() - Method in class picocli.CommandLine
Returns the maximum width of the usage help message.
getUsageMessage() - Method in class picocli.CommandLine
Similar to CommandLine.usage(PrintStream), but returns the usage help message as a String instead of printing it to the PrintStream.
getUsageMessage(CommandLine.Help.Ansi) - Method in class picocli.CommandLine
Similar to CommandLine.usage(PrintStream, Help.Ansi), but returns the usage help message as a String instead of printing it to the PrintStream.
getUsageMessage(CommandLine.Help.ColorScheme) - Method in class picocli.CommandLine
Similar to CommandLine.usage(PrintStream, Help.ColorScheme), but returns the usage help message as a String instead of printing it to the PrintStream.
getValue() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the current value of this argument.
getValue() - Method in exception picocli.CommandLine.ParameterException
Returns the String value for the (sub)command whose input could not be parsed.
getValue(String, CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.PropertiesDefaultProvider
 
getVersion() - Method in class picocli.codegen.annotation.processing.VersionProviderMetaData
Always returns an empty array.
getVersion() - Method in interface picocli.CommandLine.IVersionProvider
Returns version information for a command.
getVersion() - Method in class picocli.CommandLine.NoVersionProvider
 
Graph(int) - Constructor for class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Graph
 
GROOVY_CLOSURE_CLASS - Static variable in class picocli.CommandLine.DefaultFactory
 
group - Variable in class picocli.CommandLine.Model.ArgSpec
 
group - Variable in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
group() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the groups this option or positional parameter belongs to, or null if this option is not part of a group.
group() - Method in class picocli.CommandLine.ParseResult.GroupMatch
Returns the ArgGroupSpec of the container GroupMatchContainer of this match.
group() - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
Returns the ArgGroupSpec whose matches are captured in this GroupMatchContainer.
GroupMatch(CommandLine.ParseResult.GroupMatchContainer) - Constructor for class picocli.CommandLine.ParseResult.GroupMatch
 
groupMatchContainer - Variable in class picocli.CommandLine.ParseResult.Builder
 
groupMatchContainer - Variable in class picocli.CommandLine.ParseResult
 
GroupMatchContainer(CommandLine.Model.ArgGroupSpec, CommandLine) - Constructor for class picocli.CommandLine.ParseResult.GroupMatchContainer
 
groups - Variable in class picocli.CommandLine.Model.CommandSpec
 
GroupValidationResult(CommandLine.ParseResult.GroupValidationResult.Type) - Constructor for class picocli.CommandLine.ParseResult.GroupValidationResult
 
GroupValidationResult(CommandLine.ParseResult.GroupValidationResult.Type, CommandLine.ParameterException) - Constructor for class picocli.CommandLine.ParseResult.GroupValidationResult
 

H

handle(Exception, String, CommandLine.Tracer) - Static method in class picocli.CommandLine.BuiltIn
 
handle(CommandLine.ParseResult) - Method in class picocli.CommandLine.AbstractParseResultHandler
Deprecated.
Processes the specified ParseResult and returns the result as a list of objects.
handle(CommandLine.ParseResult) - Method in class picocli.CommandLine.RunAll
Executes the top-level command and all subcommands as Runnable or Callable.
handle(CommandLine.ParseResult) - Method in class picocli.CommandLine.RunFirst
Executes the top-level Runnable or Callable subcommand.
handle(CommandLine.ParseResult) - Method in class picocli.CommandLine.RunLast
Executes the most specific Runnable or Callable subcommand.
handleCommands(Map<Element, CommandLine.Model.CommandSpec>, Set<? extends TypeElement>, RoundEnvironment) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
Subclasses must implement this method and do something with the CommandSpec command model objects that were found during compilation.
handleCommands(Map<Element, CommandLine.Model.CommandSpec>, Set<? extends TypeElement>, RoundEnvironment) - Method in class picocli.codegen.aot.graalvm.processor.AbstractCompositeGeneratorProcessor
 
handleException(CommandLine.ParameterException, PrintStream, CommandLine.Help.Ansi, String...) - Method in class picocli.CommandLine.DefaultExceptionHandler
Deprecated.
 
handleException(CommandLine.ParameterException, PrintStream, CommandLine.Help.Ansi, String...) - Method in interface picocli.CommandLine.IExceptionHandler
Deprecated.
Handles a ParameterException that occurred while parsing the command line arguments and optionally returns a list of results.
handleExecutionException(Exception, CommandLine, CommandLine.ParseResult) - Method in interface picocli.CommandLine.IExecutionExceptionHandler
Handles an Exception that occurred while executing the Runnable or Callable command and returns an exit code suitable for returning from CommandLine.execute(String...).
handleExecutionException(CommandLine.ExecutionException, CommandLine.ParseResult) - Method in class picocli.CommandLine.DefaultExceptionHandler
Deprecated.
This implementation always simply rethrows the specified exception.
handleExecutionException(CommandLine.ExecutionException, CommandLine.ParseResult) - Method in interface picocli.CommandLine.IExceptionHandler2
Deprecated.
Handles a ExecutionException that occurred while executing the Runnable or Callable command and optionally returns a list of results.
handleParseException(CommandLine.ParameterException, String[]) - Method in class picocli.CommandLine.DefaultExceptionHandler
Deprecated.
Prints the message of the specified exception, followed by the usage message for the command or subcommand whose input was invalid, to the stream returned by CommandLine.AbstractHandler.err().
handleParseException(CommandLine.ParameterException, String[]) - Method in interface picocli.CommandLine.IExceptionHandler2
Deprecated.
Handles a ParameterException that occurred while parsing the command line arguments and optionally returns a list of results.
handleParseException(CommandLine.ParameterException, String[]) - Method in interface picocli.CommandLine.IParameterExceptionHandler
Handles a ParameterException that occurred while parsing the command line arguments and returns an exit code suitable for returning from CommandLine.execute(String...).
handleParseResult(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(List<CommandLine>, PrintStream, CommandLine.Help.Ansi) - Method in class picocli.CommandLine.RunAll
Prints help if requested, and otherwise executes the top-level command and all subcommands as Runnable, Callable or Method.
handleParseResult(List<CommandLine>, PrintStream, CommandLine.Help.Ansi) - Method in class picocli.CommandLine.RunFirst
Prints help if requested, and otherwise executes the top-level Runnable or Callable command.
handleParseResult(List<CommandLine>, PrintStream, CommandLine.Help.Ansi) - Method in class picocli.CommandLine.RunLast
Prints help if requested, and otherwise executes the most specific Runnable or Callable subcommand.
handleParseResult(CommandLine.ParseResult) - Method in class picocli.CommandLine.AbstractParseResultHandler
Deprecated.
Prints help if requested, and otherwise calls CommandLine.AbstractParseResultHandler.handle(CommandLine.ParseResult).
handleParseResult(CommandLine.ParseResult) - Method in interface picocli.CommandLine.IParseResultHandler2
Deprecated.
Processes the ParseResult object resulting from successfully parsing the command line arguments and returns a return value.
handler - Static variable in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
handleUnhandled(Exception, CommandLine, int) - Static method in class picocli.CommandLine
 
handleUnmatchedArgument(Stack<String>) - Method in class picocli.CommandLine.Interpreter
 
hasAtFileParameter() - Method in class picocli.CommandLine.Help
Returns true if the usage help should show the at file parameter in the parameter list, otherwise false.
hasExitCode() - Method in class picocli.CommandLine.AbstractHandler
Deprecated.
Returns true if an exit code was set with CommandLine.AbstractHandler.andExit(int), or false (the default) if the handler should not call System.exit(int) after processing completes.
hasFullyMatchedSubgroup(boolean) - Method in class picocli.CommandLine.ParseResult.GroupMatch
 
hashCode() - Method in class picocli.codegen.annotation.processing.MixinInfo
 
hashCode() - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedField
 
hashCode() - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedMethod
 
hashCode() - Method in class picocli.CommandLine.Help.Ansi.Palette256Color
 
hashCode() - Method in class picocli.CommandLine.Help.Ansi.Text
 
hashCode() - Method in class picocli.CommandLine.Help.ColorScheme
 
hashCode() - Method in class picocli.CommandLine.Help.Column
 
hashCode() - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
hashCode() - Method in class picocli.CommandLine.Model.OptionSpec
 
hashCode() - Method in class picocli.CommandLine.Model.PositionalParamSpec
 
hashCode() - Method in class picocli.CommandLine.Model.RuntimeTypeInfo
 
hashCode() - Method in class picocli.CommandLine.NoOpParameterPreprocessor
 
hashCode() - Method in class picocli.CommandLine.Range
 
hashCode(boolean) - Static method in class picocli.codegen.util.Assert
 
hashCode(boolean) - Static method in class picocli.CommandLine.Assert
 
hashCode(Object) - Static method in class picocli.codegen.util.Assert
 
hashCode(Object) - Static method in class picocli.CommandLine.Assert
 
hashCodeImpl() - Method in class picocli.CommandLine.Model.ArgSpec
 
hasInitialValue - Variable in class picocli.codegen.annotation.processing.TypedMember
 
hasInitialValue - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
hasInitialValue - Variable in class picocli.CommandLine.Model.ArgSpec
 
hasInitialValue() - Method in class picocli.codegen.annotation.processing.TypedMember
 
hasInitialValue() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Determines whether the option or positional parameter will be reset to the CommandLine.Model.ArgSpec.Builder.initialValue() before parsing new input.
hasInitialValue() - Method in class picocli.CommandLine.Model.ArgSpec
Determines whether the option or positional parameter will be reset to the CommandLine.Model.ArgSpec.initialValue() before parsing new input.
hasInitialValue() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
hasInitialValue() - Method in class picocli.CommandLine.Model.TypedMember
 
hasInitialValue(boolean) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Determines whether the option or positional parameter will be reset to the CommandLine.Model.ArgSpec.Builder.initialValue() before parsing new input.
hasInstance(CommandLine.Model.IScope) - Static method in class picocli.CommandLine.Model.ObjectScope
 
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.
hasMatchedValueAtPosition(CommandLine.Model.ArgSpec, int) - Method in class picocli.CommandLine.ParseResult.GroupMatch
 
hasOsType() - Static method in enum picocli.CommandLine.Help.Ansi
 
hasSubcommand() - Method in class picocli.CommandLine.ParseResult
Returns true if a subcommand was matched on the command line, false otherwise.
header - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
header() - Method in annotation type picocli.CommandLine.Command
Optional summary description of the command, shown before the synopsis.
header() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional header lines displayed at the top of the help message.
header(Object...) - Method in class picocli.CommandLine.Help
Returns the command header text as a string.
header(String...) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the optional header lines displayed at the top of the help message.
headerDescriptionString(CommandLine.Model.CommandSpec) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
headerHeading - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
headerHeading() - Method in annotation type picocli.CommandLine.Command
Set the heading preceding the header section.
headerHeading() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional heading preceding the header section.
headerHeading(Object...) - Method in class picocli.CommandLine.Help
Returns the text displayed before the header text; the result of String.format(headerHeading, params).
headerHeading(String) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the heading preceding the header section.
heading - Variable in class picocli.CommandLine.Model.ArgGroupSpec.Builder
 
heading - Variable in class picocli.CommandLine.Model.ArgGroupSpec
 
heading() - Method in annotation type picocli.CommandLine.ArgGroup
The heading of this group, used when generating the usage documentation.
heading() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the heading of this group, used when generating the usage documentation.
heading() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the heading of this group (may be null), used when generating the usage documentation.
heading(String) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets the heading of this group (may be null), used when generating the usage documentation.
heading(CommandLine.Help.Ansi, int, boolean, String, Object...) - Static method in class picocli.CommandLine.Help
 
headingKey - Variable in class picocli.CommandLine.Model.ArgGroupSpec.Builder
 
headingKey - Variable in class picocli.CommandLine.Model.ArgGroupSpec
 
headingKey() - Method in annotation type picocli.CommandLine.ArgGroup
ResourceBundle key for this group's usage help message section heading.
headingKey() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the heading key of this group, used to get the heading from a resource bundle.
headingKey() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the heading key of this group (may be null), used to get the heading from a resource bundle.
headingKey(String) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets the heading key of this group, used to get the heading from a resource bundle.
help - Variable in class picocli.CommandLine.Model.OptionSpec.Builder
 
help - Variable in class picocli.CommandLine.Model.OptionSpec
 
help() - Method in class picocli.CommandLine.Model.OptionSpec.Builder
help() - Method in class picocli.CommandLine.Model.OptionSpec
help() - Method in annotation type picocli.CommandLine.Option
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(Object) - Constructor for class picocli.CommandLine.Help
Constructs a new Help instance with a default color scheme, initialized from annotations on the specified class and superclasses.
Help(Object, CommandLine.Help.Ansi) - Constructor for class picocli.CommandLine.Help
Constructs a new Help instance with a default color scheme, initialized from annotations on the specified class and superclasses.
Help(Object, CommandLine.Help.ColorScheme) - Constructor for class picocli.CommandLine.Help
Help(CommandLine.Model.CommandSpec, CommandLine.Help.ColorScheme) - Constructor for class picocli.CommandLine.Help
Constructs a new Help instance with the specified color scheme, initialized from annotations on the specified class and superclasses.
helpCommand() - Method in annotation type picocli.CommandLine.Command
Set this attribute to true if this subcommand is a help command, and required options and positional parameters of the parent command should not be validated.
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.
HelpCommand() - Constructor for class picocli.CommandLine.HelpCommand
 
helpFactory - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
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.
helpRequested - Variable in class picocli.CommandLine.AutoHelpMixin
 
helpRequested - Variable in class picocli.CommandLine.HelpCommand
 
helpSectionRendererMap - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
hidden - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
hidden - Variable in class picocli.CommandLine.Model.ArgSpec
 
hidden - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
hidden() - Method in annotation type picocli.CommandLine.Command
Set hidden=true if this command should not be included in the list of commands in the usage help of the parent command.
hidden() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns whether this option should be excluded from the usage 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() - Method in annotation type picocli.CommandLine.Option
Set hidden=true if this option should not be included in the usage help message.
hidden() - Method in annotation type picocli.CommandLine.Parameters
Set hidden=true if this parameter should not be included in the usage message.
hidden(boolean) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets whether this option should be excluded from the usage message, and returns this builder.
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 - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
hideParamSyntax - Variable in class picocli.CommandLine.Model.ArgSpec
 
hideParamSyntax() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns whether usage syntax decorations around the paramLabel should be suppressed.
hideParamSyntax() - Method in class picocli.CommandLine.Model.ArgSpec
Returns whether usage syntax decorations around the paramLabel should be suppressed.
hideParamSyntax() - Method in annotation type picocli.CommandLine.Option
Returns whether usage syntax decorations around the paramLabel should be suppressed.
hideParamSyntax() - Method in annotation type picocli.CommandLine.Parameters
Returns whether usage syntax decorations around the paramLabel should be suppressed.
hideParamSyntax(boolean) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets whether usage syntax decorations around the paramLabel should be suppressed.
HIGHLIGHT - Static variable in class picocli.codegen.docgen.manpage.ManPageGenerator
 
hintDisabled() - Static method in enum picocli.CommandLine.Help.Ansi
 
hintEnabled() - Static method in enum picocli.CommandLine.Help.Ansi
https://github.com/adoxa/ansicon/blob/master/readme.txt, Jan Niklas Hasse's https://bixense.com/clicolors/ proposal, https://conemu.github.io/en/AnsiEscapeCodes.html#Environment_variable

I

id - Variable in class picocli.CommandLine.Model.ArgGroupSpec
 
id() - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
IGenerator - Interface in picocli.codegen.aot.graalvm.processor
 
increment(Map<T, Integer>, T) - Method in class picocli.codegen.annotation.processing.AnnotationValidator
 
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 - Variable in class picocli.CommandLine.Model.PositionalParamSpec.Builder
 
index - Variable in class picocli.CommandLine.Model.PositionalParamSpec
 
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() - 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.
index() - Method in annotation type picocli.CommandLine.Parameters
Specify an index ("0", or "1", etc.) to pick which of the command line arguments should be assigned to this field.
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.Model.ArgSpec) - Method in class picocli.CommandLine.PositionalParametersSorter
 
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.
indexOfLastSubcommandWithSameParent(List<CommandLine>) - Static method in class picocli.CommandLine.RunLast
 
InetAddressConverter() - Constructor for class picocli.CommandLine.BuiltIn.InetAddressConverter
 
inferLabel(String, String, CommandLine.Model.ITypeInfo) - Static method in class picocli.CommandLine.Model.ArgSpec.Builder
 
inferTypes(Class<?>, Class<?>[], Type) - Static method in class picocli.CommandLine.Model.RuntimeTypeInfo
 
info(String, Object...) - Method in class picocli.CommandLine.Tracer
 
INFO - picocli.CommandLine.TraceLevel
 
INHERIT - picocli.CommandLine.ScopeType
The element exists in the command where the element is defined and all descendents (subcommands, sub-subcommands, etc.).
inheritAttributesFrom(CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.Model.CommandSpec
 
inherited - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
inherited - Variable in class picocli.CommandLine.Model.ArgSpec
 
inherited - Variable in class picocli.CommandLine.Model.CommandSpec
 
inherited() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns whether this option is inherited from a parent command.
inherited() - Method in class picocli.CommandLine.Model.ArgSpec
Returns whether this option is inherited from a parent command.
inherited() - Method in class picocli.CommandLine.Model.CommandSpec
Returns whether this command is inherited from a parent command.
inherited(boolean) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets whether this option is inherited from a parent command, and returns this builder.
init(ProcessingEnvironment) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
init(ProcessingEnvironment) - Method in class picocli.codegen.aot.graalvm.processor.NativeImageConfigGeneratorProcessor
 
init(CommandLine, CommandLine.Help.Ansi, PrintStream, PrintStream) - Method in class picocli.CommandLine.HelpCommand
Deprecated.
init(CommandLine, CommandLine.Help.Ansi, PrintStream, PrintStream) - Method in interface picocli.CommandLine.IHelpCommandInitializable
Deprecated.
init(CommandLine, CommandLine.Help.ColorScheme, PrintWriter, PrintWriter) - Method in class picocli.CommandLine.HelpCommand
Initializes this object with the information needed to implement a help command that provides usage help for other commands.
init(CommandLine, CommandLine.Help.ColorScheme, PrintWriter, PrintWriter) - Method in interface picocli.CommandLine.IHelpCommandInitializable2
Initializes this object with the information needed to implement a help command that provides usage help for other commands.
initCapacity() - Method in class picocli.CommandLine.Model.PositionalParamSpec
 
initCommandHierarchyWithResourceBundle(String, ResourceBundle) - Method in class picocli.CommandLine.Model.CommandSpec
 
initDefaultValueProvider(Class<? extends CommandLine.IDefaultValueProvider>, CommandLine.IFactory) - Method in class picocli.CommandLine.Model.CommandSpec
 
initDefaultValueProvider(CommandLine.IDefaultValueProvider) - Method in class picocli.CommandLine.Model.CommandSpec
 
initDefaultValueProvider(CommandLine.Model.CommandSpec, CommandLine.Command) - Static method in class picocli.codegen.annotation.processing.DefaultValueProviderMetaData
Sets the specified CommandSpec's default value provider to a DefaultValueProviderMetaData instance if the annotation attribute was present on the specified Command annotation.
initExitCodeOnExecutionException(int) - Method in class picocli.CommandLine.Model.CommandSpec
 
initExitCodeOnInvalidInput(int) - Method in class picocli.CommandLine.Model.CommandSpec
 
initExitCodeOnSuccess(int) - Method in class picocli.CommandLine.Model.CommandSpec
 
initExitCodeOnUsageHelp(int) - Method in class picocli.CommandLine.Model.CommandSpec
 
initExitCodeOnVersionHelp(int) - Method in class picocli.CommandLine.Model.CommandSpec
 
initFrom(CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.Model.CommandSpec
 
initFrom(CommandLine.Model.ParserSpec) - Method in class picocli.CommandLine.Model.ParserSpec
 
initFrom(CommandLine.Model.UsageMessageSpec, CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.Model.UsageMessageSpec
 
initFromAnnotatedFields(CommandLine.Model.IScope, Class<?>, CommandLine.Model.CommandSpec, CommandLine.Model.ArgGroupSpec.Builder, CommandLine.IFactory, CommandLine.Model.Predicate<CommandLine.Model.TypedMember>) - Static method in class picocli.CommandLine.Model.CommandReflection
 
initFromAnnotatedTypedMembers(CommandLine.Model.TypedMember, CommandLine.Model.Predicate<CommandLine.Model.TypedMember>, CommandLine.Model.CommandSpec, CommandLine.Model.ArgGroupSpec.Builder, CommandLine.IFactory) - Static method in class picocli.CommandLine.Model.CommandReflection
 
initFromMethodParameters(CommandLine.Model.IScope, Method, CommandLine.Model.CommandSpec, CommandLine.Model.ArgGroupSpec.Builder, CommandLine.IFactory) - Static method in class picocli.CommandLine.Model.CommandReflection
 
initFromMixin(CommandLine.Model.UsageMessageSpec, CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.Model.UsageMessageSpec
 
initHelpCommand(boolean) - Method in class picocli.CommandLine.Model.CommandSpec
 
initializable(Object, Object[], Object[]) - Static method in class picocli.CommandLine.Model
 
initializable(Object, Object, Object) - Static method in class picocli.CommandLine.Model
 
InitializationException(String) - Constructor for exception picocli.CommandLine.InitializationException
 
InitializationException(String, Exception) - Constructor for exception picocli.CommandLine.InitializationException
 
initializeInitialValue(Object) - Method in class picocli.CommandLine.Model.TypedMember
 
initialValue - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
initialValue - Variable in class picocli.CommandLine.Model.ArgSpec
 
initialValue - Variable in class picocli.CommandLine.Model.UnmatchedArgsBinding
 
initialValue() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns the initial value this option or positional parameter.
initialValue() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the initial value of this option or positional parameter: the value that, if CommandLine.Model.ArgSpec.hasInitialValue() is true, the option will be reset to before parsing (regardless of whether a default value exists), to clear values that would otherwise remain from parsing previous input.
initialValue(Object) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets the initial value of this option or positional parameter to the specified value, and returns this builder.
initialValueState - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
initialValueState - Variable in class picocli.CommandLine.Model.ArgSpec
 
initialValueState - Variable in class picocli.CommandLine.Model.TypedMember
 
InitialValueState() - Constructor for enum picocli.CommandLine.Model.InitialValueState
 
initMethodSubcommands(Class<?>, CommandLine.Model.CommandSpec, CommandLine.IFactory) - Static method in class picocli.CommandLine.Model.CommandReflection
 
initModelTransformer(CommandLine.IModelTransformer) - Method in class picocli.CommandLine.Model.CommandSpec
 
initName(String) - Method in class picocli.CommandLine.Model.CommandSpec
 
initPreprocessor(CommandLine.IParameterPreprocessor) - Method in class picocli.CommandLine.Model.CommandSpec
 
initSeparator(String) - Method in class picocli.CommandLine.Model.ParserSpec
 
initSubcommands(CommandLine.Command, Class<?>, CommandLine.Model.CommandSpec, CommandLine.IFactory, Stack<Class<?>>) - Static method in class picocli.CommandLine.Model.CommandReflection
 
initSubcommandsRepeatable(boolean) - Method in class picocli.CommandLine.Model.CommandSpec
 
initUserObject(CommandLine) - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
initVersion(String[]) - Method in class picocli.CommandLine.Model.CommandSpec
 
initVersionProvider(CommandLine.IVersionProvider) - Method in class picocli.CommandLine.Model.CommandSpec
 
initVersionProvider(CommandLine.Model.CommandSpec, CommandLine.Command) - Static method in class picocli.codegen.annotation.processing.VersionProviderMetaData
Sets the specified CommandSpec's CommandLine.Model.CommandSpec.versionProvider(picocli.CommandLine.IVersionProvider) version provider} to a VersionProviderMetaData instance if the annotation attribute was present on the specified Command annotation.
injectParentCommand(CommandLine.Model.CommandUserObject) - Method in class picocli.CommandLine.Model.CommandSpec
 
injectSpecIntoVersionProvider(CommandLine.Model.CommandSpec, CommandLine.Command, CommandLine.IFactory) - Static method in class picocli.CommandLine.Model.CommandReflection
 
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.
instance - Variable in class picocli.CommandLine.Model.CommandUserObject
 
IntegerConverter() - Constructor for class picocli.CommandLine.BuiltIn.IntegerConverter
 
interactive - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
interactive - Variable in class picocli.CommandLine.Model.ArgSpec
 
interactive() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns whether this option prompts the user to enter a value on the command line.
interactive() - Method in class picocli.CommandLine.Model.ArgSpec
Returns whether this option will prompt the user to enter a value on the command line.
interactive() - Method in annotation type picocli.CommandLine.Option
Set interactive=true to make this option prompt the end user for a value (like a password).
interactive() - Method in annotation type picocli.CommandLine.Parameters
Set interactive=true if this positional parameter will prompt the end user for a value (like a password).
interactive(boolean) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets whether this option prompts the user to enter a value on the command line, and returns this builder.
interactiveCount - Variable in class picocli.CommandLine.Interpreter
 
interfaces - Variable in class picocli.codegen.aot.graalvm.DynamicProxyConfigGenerator.App
 
interfaces - Variable in class picocli.codegen.aot.graalvm.DynamicProxyConfigGenerator.Visitor
 
internalHandleParseException(CommandLine.ParameterException, PrintWriter, CommandLine.Help.ColorScheme) - Static method in class picocli.CommandLine.DefaultExceptionHandler
Deprecated.
 
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
 
internalToString() - Method in class picocli.CommandLine.Range
Returns equivalent of format("%s (%s)", originalValue, toString()).
interpolate(String) - Method in class picocli.CommandLine.Model.ArgSpec
 
interpolate(String) - Method in class picocli.CommandLine.Model.Interpolator
 
interpolate(String) - Method in class picocli.CommandLine.Model.UsageMessageSpec
 
interpolate(String[]) - Method in class picocli.CommandLine.Model.ArgSpec
 
interpolate(String[]) - Method in class picocli.CommandLine.Model.Interpolator
 
interpolate(String[]) - Method in class picocli.CommandLine.Model.UsageMessageSpec
 
interpolateCommandName(String) - Method in class picocli.CommandLine.Model.Interpolator
 
interpolateVariables - Variable in class picocli.CommandLine.Model.CommandSpec
 
interpolateVariables() - Method in class picocli.CommandLine.Model.CommandSpec
Returns whether whether variables should be interpolated in String values.
interpolateVariables(Boolean) - Method in class picocli.CommandLine.Model.CommandSpec
Sets whether whether variables should be interpolated in String values.
interpolator - Variable in class picocli.CommandLine.Model.CommandSpec
 
interpolator - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
Interpolator(CommandLine.Model.CommandSpec) - Constructor for class picocli.CommandLine.Model.Interpolator
 
interpreter - Variable in class picocli.CommandLine
 
Interpreter() - Constructor for class picocli.CommandLine.Interpreter
 
invoke(Object, Method, Object[]) - Method in class picocli.CommandLine.Model.PicocliInvocationHandler
 
invoke(String, Class<?>, PrintStream, PrintStream, CommandLine.Help.Ansi, 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<?>, String...) - Static method in class picocli.CommandLine
is(CommandLine.Model.ArgSpec, String, boolean) - Method in class picocli.CommandLine.Interpreter
 
isAbbreviatedOptionsAllowed() - Method in class picocli.CommandLine
Returns whether abbreviation of option names should be allowed when matching options.
isAbbreviatedSubcommandsAllowed() - Method in class picocli.CommandLine
Returns whether abbreviation of subcommands should be allowed when matching subcommands.
isAccessible() - Method in class picocli.CommandLine.Model.MethodParam
 
isAddMethodSubcommands - Variable in class picocli.CommandLine.Model.CommandSpec
 
isAddMethodSubcommands() - Method in class picocli.CommandLine.Model.CommandSpec
Returns whether method commands should be added as subcommands.
isAdjustLineBreaksForWideCJKCharacters() - Method in class picocli.CommandLine.Help.TextTable
 
isAdjustLineBreaksForWideCJKCharacters() - Method in class picocli.CommandLine
Returns whether line breaks should take wide Chinese, Japanese and Korean characters into account for line-breaking purposes.
isAnnotated(AnnotatedElement) - Static method in class picocli.CommandLine.Model.TypedMember
 
isAnnotated(Element) - Static method in class picocli.codegen.annotation.processing.TypedMember
 
isAnnotationPresent(Class<? extends Annotation>) - Method in class picocli.codegen.annotation.processing.TypedMember
 
isAnnotationPresent(Class<? extends Annotation>) - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isAnnotationPresent(Class<? extends Annotation>) - Method in class picocli.CommandLine.Model.TypedMember
 
isAnyHelpRequested() - Method in class picocli.CommandLine.Interpreter
 
isArgGroup() - Method in class picocli.codegen.annotation.processing.TypedMember
 
isArgGroup() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isArgGroup() - Method in class picocli.CommandLine.Model.TypedMember
 
isArgResemblesOptionThereforeDiscontinue(CommandLine.Model.ArgSpec, Stack<String>, int, CommandLine.Range) - Method in class picocli.CommandLine.Interpreter
 
isArgSpec() - Method in class picocli.codegen.annotation.processing.TypedMember
 
isArgSpec() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isArgSpec() - Method in class picocli.CommandLine.Model.TypedMember
 
isArray() - Method in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
isArray() - Method in interface picocli.CommandLine.Model.ITypeInfo
 
isArray() - Method in class picocli.CommandLine.Model.RuntimeTypeInfo
 
isAttached() - Method in enum picocli.CommandLine.LookBehind
 
isBoolean() - Method in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
isBoolean() - Method in interface picocli.CommandLine.Model.ITypeInfo
Returns true if CommandLine.Model.ITypeInfo.getType() is boolean or java.lang.Boolean.
isBoolean() - Method in class picocli.CommandLine.Model.RuntimeTypeInfo
 
isBoolean(Class<?>) - Static method in class picocli.CommandLine
 
isBoolean(Class<?>[]) - Static method in class picocli.CommandLine
 
isBooleanType(TypeMirror) - Static method in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
isCaseConvertible(Class<?>) - Static method in class picocli.CommandLine.Model.CaseAwareLinkedMap
 
isCaseInsensitive() - Method in class picocli.CommandLine.Model.CaseAwareLinkedMap
Returns the case-insensitivity of the map.
isCaseInsensitiveEnumValuesAllowed() - Method in class picocli.CommandLine
Returns whether the parser should ignore case when converting arguments to enum values.
isCharCJK(char) - Static method in class picocli.CommandLine.Model.UsageMessageSpec
Given a character, is this character considered to be a CJK character? Shamelessly stolen from StackOverflow where it was contributed by user Rakesh N.
isCollection - Variable in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
isCollection() - Method in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
isCollection() - Method in interface picocli.CommandLine.Model.ITypeInfo
 
isCollection() - Method in class picocli.CommandLine.Model.RuntimeTypeInfo
 
isCygwin() - Static method in enum picocli.CommandLine.Help.Ansi
 
isDebug() - Method in class picocli.CommandLine.Tracer
 
isDefault() - Method in class picocli.codegen.annotation.processing.CompletionCandidatesMetaData
Returns true if the command did not have a completionCandidates annotation attribute.
isDefault() - Method in class picocli.codegen.annotation.processing.DefaultValueProviderMetaData
Returns true if the command did not have a defaultValueProvider annotation attribute.
isDefault() - Method in interface picocli.codegen.annotation.processing.ITypeMetaData
Returns true if the annotated element did not have the annotation attribute.
isDefault() - Method in class picocli.codegen.annotation.processing.ParameterConsumerMetaData
Returns true if the command did not have a typeConverter annotation attribute.
isDefault() - Method in class picocli.codegen.annotation.processing.TypeConverterMetaData
Returns true if the command did not have a typeConverter annotation attribute.
isDefault() - Method in class picocli.codegen.annotation.processing.VersionProviderMetaData
Returns true if the command did not have a versionProvider annotation attribute.
isEmpty() - Method in class picocli.CommandLine.Model.Messages
 
isEmpty() - Method in class picocli.CommandLine.ParseResult.GroupMatch
Returns true if this match has no matched arguments and no matched subgroups.
isEnabled(CommandLine.TraceLevel) - Method in enum picocli.CommandLine.TraceLevel
 
isEnum() - Method in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
isEnum() - Method in interface picocli.CommandLine.Model.ITypeInfo
Returns true if CommandLine.Model.ITypeInfo.getType() is an enum.
isEnum() - Method in class picocli.CommandLine.Model.RuntimeTypeInfo
 
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.
isFinal - Variable in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedField
 
isFinal(Field) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedClass
 
isHelpCommand - Variable in class picocli.CommandLine.Model.CommandSpec
 
isHelpRequested - Variable in class picocli.CommandLine.Interpreter
 
isInfo() - Method in class picocli.CommandLine.Tracer
 
isInitializingDefaultValues - Variable in class picocli.CommandLine.ParseResult.Builder
 
isInteractive() - Method in class picocli.codegen.annotation.processing.TypedMember
 
isInteractive() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isInteractive() - Method in class picocli.CommandLine.Model.TypedMember
 
isInterpolateVariables() - Method in class picocli.CommandLine
Returns whether whether variables should be interpolated in String values.
isJansiConsoleInstalled() - Static method in enum picocli.CommandLine.Help.Ansi
 
isMac() - Static method in enum picocli.CommandLine.Help.Ansi
 
isMap - Variable in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
isMap() - Method in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
isMap() - Method in interface picocli.CommandLine.Model.ITypeInfo
 
isMap() - Method in class picocli.CommandLine.Model.RuntimeTypeInfo
 
isMaxMultiplicityReached() - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
Returns true if no more MatchedGroupMultiples can be added to this GroupMatchContainer.
isMethod() - Method in class picocli.CommandLine.Model.CommandUserObject
 
isMethodParameter() - Method in class picocli.codegen.annotation.processing.TypedMember
 
isMethodParameter() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isMethodParameter() - Method in class picocli.CommandLine.Model.TypedMember
 
isMinMultiplicityReached() - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
Returns true if this GroupMatchContainer has at least the minimum number of MatchedGroupMultiples.
isMixin() - Method in class picocli.codegen.annotation.processing.TypedMember
 
isMixin() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isMixin() - Method in class picocli.CommandLine.Model.TypedMember
 
isMultiValue() - Method in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
isMultiValue() - Method in class picocli.codegen.annotation.processing.TypedMember
 
isMultiValue() - Method in class picocli.CommandLine.Model.ArgSpec
Returns true if this argument's CommandLine.Model.ArgSpec.type() is an array, a Collection or a Map, false otherwise.
isMultiValue() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isMultiValue() - Method in interface picocli.CommandLine.Model.ITypeInfo
Returns true if CommandLine.Model.ITypeInfo.getType() is an array, map or collection.
isMultiValue() - Method in class picocli.CommandLine.Model.RuntimeTypeInfo
 
isMultiValue() - Method in class picocli.CommandLine.Model.TypedMember
 
isMultiValue(Class<?>) - Static method in class picocli.CommandLine
 
isNonAlphabetic(String) - Static method in class picocli.CommandLine.AbbreviationMatcher
 
isNonDefault(Object[], Object[]) - Static method in class picocli.CommandLine.Model
 
isNonDefault(Object, Object) - Static method in class picocli.CommandLine.Model
 
isNumeric(String) - Static method in class picocli.CommandLine.Model.UsageMessageSpec
 
ISO8601DateConverter() - Constructor for class picocli.CommandLine.BuiltIn.ISO8601DateConverter
 
ISO8601TimeConverter(Constructor<?>) - Constructor for class picocli.CommandLine.BuiltIn.ISO8601TimeConverter
 
isOption() - Method in class picocli.codegen.annotation.processing.TypedMember
 
isOption() - Method in class picocli.CommandLine.Model.ArgSpec
Returns true if this argument is a named option, false otherwise.
isOption() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isOption() - Method in class picocli.CommandLine.Model.OptionSpec
 
isOption() - Method in class picocli.CommandLine.Model.PositionalParamSpec
 
isOption() - Method in class picocli.CommandLine.Model.TypedMember
 
isOption(String) - Method in class picocli.CommandLine.Interpreter
Returns true if the specified arg is "--", a registered option, or potentially a clustered POSIX option.
isOption(DeclaredType) - Static method in class picocli.codegen.annotation.processing.TypeUtil
 
isOptional() - Method in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
isOptional() - Method in interface picocli.CommandLine.Model.ITypeInfo
Returns true if CommandLine.Model.ITypeInfo.getType() is java.util.Optional
isOptional() - Method in class picocli.CommandLine.Model.RuntimeTypeInfo
 
isOptional(Class<?>) - Static method in class picocli.CommandLine
 
isOptionsCaseInsensitive() - Method in class picocli.CommandLine
Returns whether upper case and lower case should be ignored when matching option names.
isOverwrittenOptionsAllowed() - Method in class picocli.CommandLine
Returns whether options for single-value fields can be specified multiple times on the command line.
isParameter() - Method in class picocli.codegen.annotation.processing.TypedMember
 
isParameter() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isParameter() - Method in class picocli.CommandLine.Model.TypedMember
 
isParameter(DeclaredType) - Static method in class picocli.codegen.annotation.processing.TypeUtil
 
isParentCommand() - Method in class picocli.codegen.annotation.processing.TypedMember
 
isParentCommand() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isParentCommand() - Method in class picocli.CommandLine.Model.TypedMember
 
isPicocliModelObject(Object) - Static method in class picocli.AutoComplete
 
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.
isProxyClass() - Method in class picocli.CommandLine.Model.CommandUserObject
 
isProxyClass(CommandLine.Model.IScope) - Static method in class picocli.CommandLine.Model.ObjectScope
 
isPseudoTTY() - Static method in enum picocli.CommandLine.Help.Ansi
Cygwin and MSYS use pseudo-tty and console is always null...
isRelative() - Method in class picocli.CommandLine.Range
Returns true if this Range contains a relative index like "1+", or false if this Range does not contain any relative indices.
isRelativeToAnchor() - Method in class picocli.CommandLine.Range
 
isSpec() - Method in class picocli.codegen.annotation.processing.TypedMember
 
isSpec() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isSpec() - Method in class picocli.CommandLine.Model.TypedMember
 
isSplitQuotedStrings() - Method in class picocli.CommandLine
Deprecated.
Most applications should not change the default. The rare application that does need to split parameter values without respecting quotes should use CommandLine.Model.ParserSpec.splitQuotedStrings(boolean).
isStandaloneOption(String) - Method in class picocli.CommandLine.Interpreter
 
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.
isSubcommand(ExecutableElement, RoundEnvironment) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
isSubcommandsCaseInsensitive() - Method in class picocli.CommandLine
Returns whether upper case and lower case should be ignored when matching subcommands.
isSubgroupOf(CommandLine.Model.ArgGroupSpec) - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns true if this group is a subgroup (or a nested sub-subgroup, to any level of depth) of the specified group, false otherwise.
isToggleBooleanFlags() - Method in class picocli.CommandLine
Returns whether the value of boolean flag options should be "toggled" when the option is matched.
isTrimQuotes() - Method in class picocli.CommandLine
Returns whether the parser should trim quotes from command line arguments.
isTTY() - Static method in enum picocli.CommandLine.Help.Ansi
 
isUnknownOption() - Method in exception picocli.CommandLine.UnmatchedArgumentException
Returns true if the first unmatched command line arguments resembles an option, false otherwise.
isUnknownOption(List<String>, CommandLine) - Static method in exception picocli.CommandLine.UnmatchedArgumentException
 
isUnmatched() - Method in class picocli.codegen.annotation.processing.TypedMember
 
isUnmatched() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
isUnmatched() - Method in class picocli.CommandLine.Model.TypedMember
 
isUnmatchedArgumentsAllowed() - Method in class picocli.CommandLine
Returns whether the end user may specify arguments on the command line that are not matched to any option or parameter fields.
isUnmatchedOptionsAllowedAsOptionParameters() - Method in class picocli.CommandLine
Returns whether options can have parameter values that resemble an option, or whether such values should be rejected as unknown options.
isUnmatchedOptionsArePositionalParams() - Method in class picocli.CommandLine
Returns whether arguments on the command line that resemble an option should be treated as positional parameters.
isUnresolved() - Method in class picocli.CommandLine.Range
Returns true if this range contains a relative index like "1+", or variables that have not been expanded yet, false if this Range does not contain any variables or relative indices.
isUnspecified - Variable in class picocli.CommandLine.Range
 
isUnspecified() - Method in class picocli.CommandLine.Range
Returns true if this Range is a default value, false if the user specified this value.
isUsageHelpAutoWidth() - Method in class picocli.CommandLine
Returns whether picocli should attempt to detect the terminal size and adjust the usage help message width to take the full terminal width.
isUsageHelpRequested() - Method in class picocli.CommandLine
Returns true if an option annotated with CommandLine.Option.usageHelp() was specified on the command line.
isUsageHelpRequested() - Method in class picocli.CommandLine.ParseResult
Returns true if one of the options that was matched on the command line is a usageHelp option.
isUseSimplifiedAtFiles() - Method in class picocli.CommandLine
Returns whether to use a simplified argument file format that is compatible with JCommander.
isValidForInteractiveArgs() - Method in class picocli.CommandLine.Range
Returns true for these ranges: 0 and 0..1.
isValidSubcommandHasNameAttribute(Element) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
isVariable - Variable in class picocli.CommandLine.Range
Deprecated.
isVariable() - Method in class picocli.CommandLine.Range
Returns true if this range has no fixed upper bound.
isVersionHelpRequested() - Method in class picocli.CommandLine
Returns true if an option annotated with CommandLine.Option.versionHelp() was specified on the command line.
isVersionHelpRequested() - Method in class picocli.CommandLine.ParseResult
Returns true if one of the options that was matched on the command line is a versionHelp option.
isWarn() - Method in class picocli.CommandLine.Tracer
 
isWindows() - Static method in enum picocli.CommandLine.Help.Ansi
 
isXterm() - Static method in enum picocli.CommandLine.Help.Ansi
 
italic - picocli.CommandLine.Help.Ansi.Style
 
ITALIC - Static variable in class picocli.codegen.docgen.manpage.ManPageGenerator
 
iterator() - Method in class picocli.codegen.annotation.processing.CompletionCandidatesMetaData
Always returns null.
iterator() - Method in class picocli.CommandLine.Model.CaseAwareLinkedMap.CaseAwareKeySet
 
iterator() - Method in class picocli.CommandLine.NoCompletionCandidates
 
ITypeMetaData - Interface in picocli.codegen.annotation.processing
Abstraction over annotation attributes that take a class (or array of classes) as their value.

J

JniConfigGenerator - Class in picocli.codegen.aot.graalvm
 
JniConfigGenerator() - Constructor for class picocli.codegen.aot.graalvm.JniConfigGenerator
 
JniConfigGenerator.App - Class in picocli.codegen.aot.graalvm
 
join(String[], int, int, String) - Static method in class picocli.CommandLine.Help
 
join(String, Object...) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
join(CommandLine.Help.Ansi, int, boolean, String[], StringBuilder, Object...) - Static method in class picocli.CommandLine.Help
Formats each of the specified values and appends it to the specified StringBuilder.
join(CommandLine.Help.Ansi, int, String[], StringBuilder, Object...) - Static method in class picocli.CommandLine.Help
json(Collection<String>, String) - Static method in class picocli.codegen.aot.graalvm.ResourceConfigGenerator.Visitor
 
json(List<String>...) - Static method in class picocli.codegen.aot.graalvm.DynamicProxyConfigGenerator.Visitor
 
JulLogFormatter - Class in picocli.codegen.util
 
JulLogFormatter() - Constructor for class picocli.codegen.util.JulLogFormatter
 

K

KEY - Static variable in class picocli.CommandLine.AutoHelpMixin
 
keyMap - Variable in class picocli.CommandLine.Model.CaseAwareLinkedMap
 
keys - Variable in class picocli.CommandLine.Model.Messages
 
keys(ResourceBundle) - Static method in class picocli.CommandLine.Model.Messages
 
keySet - Variable in class picocli.CommandLine.Model.CaseAwareLinkedMap
 
keySet() - Method in class picocli.CommandLine.Model.CaseAwareLinkedMap
 
keyValuesMap(String...) - Static method in class picocli.CommandLine.Model.UsageMessageSpec
Creates and returns a Map that contains an entry for each specified String that is in "key:value" format.

L

lastMatch() - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
Returns the "active" multiple of this GroupMatchContainer.
layout(CommandLine.Model.ArgSpec, CommandLine.Help.Ansi.Text[][]) - Method in class picocli.CommandLine.Help.Layout
Copies the specified text values into the correct cells in the CommandLine.Help.TextTable.
Layout(CommandLine.Help.ColorScheme, int) - Constructor for class picocli.CommandLine.Help.Layout
Constructs a Layout with the specified color scheme, a new default TextTable, the default option renderer, and the default parameter renderer.
Layout(CommandLine.Help.ColorScheme, CommandLine.Help.TextTable) - Constructor for class picocli.CommandLine.Help.Layout
Constructs a Layout with the specified color scheme, the specified TextTable, the default option renderer, and the default parameter renderer.
Layout(CommandLine.Help.ColorScheme, CommandLine.Help.TextTable, CommandLine.Help.IOptionRenderer, CommandLine.Help.IParameterRenderer) - Constructor for class picocli.CommandLine.Help.Layout
Constructs a Layout with the specified color scheme, the specified TextTable, the specified option renderer and the specified parameter renderer.
length - Variable in class picocli.CommandLine.Help.Ansi.StyledSection
 
length - Variable in class picocli.CommandLine.Help.Ansi.Text
 
length(CommandLine.Help.Ansi.Text) - Method in class picocli.CommandLine.Help.TextTable
 
length(CommandLine.Help.Ansi.Text, int, int) - Method in class picocli.CommandLine.Help.TextTable
 
level - Variable in class picocli.CommandLine.Tracer
 
limitSplit - Variable in class picocli.CommandLine.Model.ParserSpec
 
limitSplit() - Method in class picocli.CommandLine.Model.ParserSpec
Returns true if arguments should be split first before any further processing and the number of parts resulting from the split is limited to the max arity of the argument.
limitSplit(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
Sets whether arguments should be split first before any further processing.
loadClosureClass() - Static method in class picocli.CommandLine.DefaultFactory
 
loadProperties(CommandLine.Model.CommandSpec) - Static method in class picocli.CommandLine.PropertiesDefaultProvider
 
LOCAL - picocli.CommandLine.ScopeType
The element only exists in the current command.
locale - Variable in class picocli.CommandLine.Model.CaseAwareLinkedMap
 
localPositionalParamCount() - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
location - Variable in class picocli.CommandLine.PropertiesDefaultProvider
 
logElementDetails(Element, String) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
logger - Static variable in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
logger - Static variable in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
logInfo(String) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
Prints a compile-time NOTE message.
logInfo(String) - Method in class picocli.codegen.aot.graalvm.processor.AbstractGenerator
Prints a compile-time NOTE message.
LONG_OPTION_COLUMN - Static variable in class picocli.CommandLine.Help.TextTable
 
LongConverter() - Constructor for class picocli.CommandLine.BuiltIn.LongConverter
 
longestFirst(String[]) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator.ShortestFirst
Sorts the specified array of Strings longest-first and returns it.
longestFirst(String[]) - Static method in class picocli.CommandLine.Help.ShortestFirst
Sorts the specified array of Strings longest-first and returns it.
longestName() - Method in class picocli.CommandLine.Model.OptionSpec
Returns the longest option name.
longOptionsMaxWidth - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
longOptionsMaxWidth() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the maximum usage help long options column max width to the specified value.
longOptionsMaxWidth(int) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the maximum usage help long options column max width to the specified value.
LookBehind() - Constructor for enum picocli.CommandLine.LookBehind
 
lookup(String) - Static method in enum picocli.CommandLine.TraceLevel
 
lookups - Variable in class picocli.CommandLine.Model.Interpolator
 

M

main(String...) - Static method in class picocli.AutoComplete
Generates a bash completion script for the specified command class.
main(String...) - Static method in class picocli.codegen.aot.graalvm.DynamicProxyConfigGenerator
Runs this class as a standalone application, printing the resulting JSON String to a file or to System.out.
main(String...) - Static method in class picocli.codegen.aot.graalvm.JniConfigGenerator
Runs this class as a standalone application, printing the resulting JSON String to a file or to System.out.
main(String...) - Static method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator
Runs this class as a standalone application, printing the resulting JSON String to a file or to System.out.
main(String...) - Static method in class picocli.codegen.aot.graalvm.ResourceConfigGenerator
Runs this class as a standalone application, printing the resulting JSON String to a file or to System.out.
main(String[]) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
Invokes ManPageGenerator.generateManPage(Config, CommandLine.Model.CommandSpec...) to generate man pages for the user-specified @Command-annotated classes.
makeCanonical(String) - Static method in class picocli.CommandLine.AbbreviationMatcher
 
makeFileName(CommandLine.Model.CommandSpec) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
makeHeading(String, String) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
makeNegative(String, CommandLine.Model.CommandSpec) - Method in interface picocli.CommandLine.INegatableOptionTransformer
Returns the negative form of the specified option name for the parser to recognize when parsing command line arguments.
makeNegative(String, CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.RegexTransformer
Returns the negative form of the specified option name for the parser to recognize when parsing command line arguments.
makeSynopsis(String, CommandLine.Model.CommandSpec) - Method in interface picocli.CommandLine.INegatableOptionTransformer
Returns the documentation string to show in the synopsis and usage help message for the specified option.
makeSynopsis(String, CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.RegexTransformer
Returns the documentation string to show in the synopsis and usage help message for the specified option.
makeSynopsisFromParts(int, CommandLine.Help.Ansi.Text, CommandLine.Help.Ansi.Text, CommandLine.Help.Ansi.Text, CommandLine.Help.Ansi.Text, CommandLine.Help.Ansi.Text) - Method in class picocli.CommandLine.Help
Concatenates the command name and the specified synopsis parts and returns a fully rendered synopsis String.
ManPageGenerator - Class in picocli.codegen.docgen.manpage
Generates AsciiDoc files in a special format that can be converted to HTML, PDF and Unix Man pages.
ManPageGenerator() - Constructor for class picocli.codegen.docgen.manpage.ManPageGenerator
 
ManPageGenerator.App - Class in picocli.codegen.docgen.manpage
 
ManPageGenerator.Config - Class in picocli.codegen.docgen.manpage
 
ManPageGenerator.ShortestFirst - Class in picocli.codegen.docgen.manpage
Sorts short strings before longer strings.
ManPageGenerator.SortByOrder<T extends CommandLine.Model.IOrdered> - Class in picocli.codegen.docgen.manpage
 
ManPageGenerator.SortByShortestOptionNameAlphabetically - Class in picocli.codegen.docgen.manpage
Sorts OptionSpec instances by their name in case-insensitive alphabetic order.
manualTitle(CommandLine.Model.CommandSpec) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
map - Variable in class picocli.CommandLine.Model.PicocliInvocationHandler
 
mapFallbackValue - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
mapFallbackValue - Variable in class picocli.CommandLine.Model.ArgSpec
 
mapFallbackValue() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns the fallback value for this Map option or positional parameter: the value that is put into the Map when only the key is specified for the option or positional parameter, like -Dkey instead of -Dkey=value.
mapFallbackValue() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the fallback value for this Map option or positional parameter: the value that is put into the Map when only the key is specified for the option or positional parameter, like -Dkey instead of -Dkey=value.
mapFallbackValue() - Method in annotation type picocli.CommandLine.Option
For options of type Map, setting the mapFallbackValue to any value allows end user to specify key-only parameters for this option.
mapFallbackValue() - Method in annotation type picocli.CommandLine.Parameters
For positional parameters of type Map, setting the mapFallbackValue to any value allows end user to specify key-only parameters for this parameter.
mapFallbackValue(String) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets the fallback value for this Map option or positional parameter: the value that is put into the Map when only the key is specified for the option or positional parameter, like -Dkey instead of -Dkey=value.
mapOf(String, Object, Object...) - Static method in class picocli.CommandLine
 
mappedExitCode(Throwable, CommandLine.IExitCodeExceptionMapper, int) - Static method in class picocli.CommandLine
 
markupMap - Variable in class picocli.CommandLine.Help.ColorScheme.Builder
 
markupMap - Variable in class picocli.CommandLine.Help.ColorScheme
 
match(Set<String>, String, boolean, CommandLine) - Static method in class picocli.CommandLine.AbbreviationMatcher
Returns the non-abbreviated name if found, otherwise returns the specified original abbreviation value.
matchCount(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.ParseResult.GroupMatch
 
matchedArgs - Variable in class picocli.CommandLine.ParseResult
 
matchedArgs() - Method in class picocli.CommandLine.ParseResult
Returns a list of matched options and positional parameters, in order they were matched on the command line.
matchedArgsList - Variable in class picocli.CommandLine.ParseResult.Builder
 
matchedFully(boolean) - Method in class picocli.CommandLine.ParseResult.GroupMatch
 
matchedFully(boolean) - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
matchedMaxElements() - Method in class picocli.CommandLine.ParseResult.GroupMatch
Returns true if the maximum number of matches has been reached for this match: all arguments (required or not) have been matched, and for each subgroup, the maximum number of elements have been matched.
matchedMaxElements() - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
Returns true if the maximum number of multiples has been matched for the multiplicity of this group, and the last multiple has matched the maximum number of elements, while all other multiples have matched at least the minimum number of elements.
matchedMinElements() - Method in class picocli.CommandLine.ParseResult.GroupMatch
Returns true if the minimum number of elements have been reached for this match: all required arguments have been matched, and for each subgroup, the minimum number of elements have been matched.
matchedMinElements() - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
Returns true if the minimum number of multiples has been matched for the multiplicity of this group, and each multiple has matched at least the minimum number of elements.
matchedOption(char) - Method in class picocli.CommandLine.ParseResult
Returns the option with the specified short name, or null if no option with that name was matched on the command line.
matchedOption(String) - Method in class picocli.CommandLine.ParseResult
Returns the option with the specified name, or null if no option with that name was matched on the command line.
matchedOptions - Variable in class picocli.CommandLine.ParseResult
 
matchedOptions() - Method in class picocli.CommandLine.ParseResult
Returns a list of matched options, in order they were matched on the command line.
matchedOptionsList - Variable in class picocli.CommandLine.ParseResult.Builder
 
matchedOptionsSet() - Method in class picocli.CommandLine.ParseResult
Returns a set of matched options.
matchedOptionValue(char, T) - Method in class picocli.CommandLine.ParseResult
Returns the command line argument value of the option with the specified name, converted to the type of the option, or the specified default value if no option with the specified name was matched.
matchedOptionValue(String, T) - Method in class picocli.CommandLine.ParseResult
Returns the command line argument value of the option with the specified name, converted to the type of the option, or the specified default value if no option with the specified name was matched.
matchedOptionValue(CommandLine.Model.OptionSpec, T) - Method in class picocli.CommandLine.ParseResult
Returns the command line argument value of the specified option, converted to the type of the option, or the specified default value if the specified option is null.
matchedPositional(int) - Method in class picocli.CommandLine.ParseResult
Returns the first PositionalParamSpec that matched an argument at the specified position, or null if no positional parameters were matched at that position.
matchedPositionalParams - Variable in class picocli.CommandLine.ParseResult
 
matchedPositionals - Variable in class picocli.CommandLine.ParseResult
 
matchedPositionals() - Method in class picocli.CommandLine.ParseResult
Returns a list of matched positional parameters, in order they were matched on the command line.
matchedPositionals(int) - Method in class picocli.CommandLine.ParseResult
Returns all PositionalParamSpec objects that matched an argument at the specified position, or an empty list if no positional parameters were matched at that position.
matchedPositionalsList - Variable in class picocli.CommandLine.ParseResult.Builder
 
matchedPositionalsSet() - Method in class picocli.CommandLine.ParseResult
Returns a set of matched positional parameters.
matchedPositionalValue(int, T) - Method in class picocli.CommandLine.ParseResult
Returns the command line argument value of the positional parameter at the specified position, converted to the type of the positional parameter, or the specified default value if no positional parameter was matched at that position.
matchedPositionalValue(CommandLine.Model.PositionalParamSpec, T) - Method in class picocli.CommandLine.ParseResult
Returns the command line argument value of the specified positional parameter, converted to the type of the positional parameter, or the specified default value if the specified positional parameter is null.
matchedSubgroups - Variable in class picocli.CommandLine.ParseResult.GroupMatch
 
matchedSubgroups() - Method in class picocli.CommandLine.ParseResult.GroupMatch
Returns matches for the subgroups, if any.
matchedUniqueOptions - Variable in class picocli.CommandLine.ParseResult
 
matchedUniquePositionals - Variable in class picocli.CommandLine.ParseResult
 
matchedValues - Variable in class picocli.CommandLine.ParseResult.GroupMatch
 
matchedValues(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.ParseResult.GroupMatch
Returns the values matched for the specified argument, converted to the type of the argument.
matchedValuesAtPosition - Variable in class picocli.CommandLine.ParseResult.GroupMatch
 
matches - Variable in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
matches() - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
Returns the list of GroupMatch instances: ArgGroupSpecs with a multiplicity greater than one may be matched multiple times.
matchKeyChunks(List<String>, List<String>, boolean) - Static method in class picocli.CommandLine.AbbreviationMatcher
 
max - Variable in class picocli.CommandLine.Range
Deprecated.
max() - Method in class picocli.CommandLine.Range
Returns the upper bound of this range (inclusive), or Integer.MAX_VALUE if this range has no upper bound.
max(int) - Method in class picocli.CommandLine.Range
Returns a new Range object with the max value replaced by the specified value.
MAX_SYNOPSIS_AUTO_INDENT_THRESHOLD - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
 
maxLength - Variable in class picocli.CommandLine.Help.Ansi.Text
 
maxLength(Collection<?>) - Static method in class picocli.CommandLine.Help
 
MaxValuesExceededException(CommandLine, String) - Constructor for exception picocli.CommandLine.MaxValuesExceededException
 
maybeThrow(CommandLine.PicocliException) - Method in class picocli.CommandLine.Interpreter
 
messages - Variable in class picocli.CommandLine.Model.ArgGroupSpec
 
messages - Variable in class picocli.CommandLine.Model.ArgSpec
 
messages - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
messages() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the Messages for this argument group specification, or null.
messages() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the Messages for this arg specification, or null.
messages() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the Messages for this usage help message specification, or null.
messages(CommandLine.Model.Messages) - Method in class picocli.CommandLine.Model.ArgGroupSpec
Sets the Messages for this ArgGroupSpec, and returns this ArgGroupSpec.
messages(CommandLine.Model.Messages) - Method in class picocli.CommandLine.Model.ArgSpec
Sets the Messages for this ArgSpec, and returns this ArgSpec.
messages(CommandLine.Model.Messages) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the Messages for this usageMessage specification, and returns this UsageMessageSpec.
Messages(CommandLine.Model.CommandSpec, String) - Constructor for class picocli.CommandLine.Model.Messages
 
Messages(CommandLine.Model.CommandSpec, String, ResourceBundle) - Constructor for class picocli.CommandLine.Model.Messages
 
Messages(CommandLine.Model.CommandSpec, ResourceBundle) - Constructor for class picocli.CommandLine.Model.Messages
 
method - Variable in class picocli.CommandLine.BuiltIn.ReflectionConverter
 
method - Variable in class picocli.CommandLine.Model.MethodBinding
 
method - Variable in class picocli.CommandLine.Model.MethodParam
 
method - Variable in class picocli.CommandLine.Model.PicocliInvocationHandler.ProxyBinding
 
MethodBinding(CommandLine.Model.IScope, Method, CommandLine.Model.CommandSpec) - Constructor for class picocli.CommandLine.Model.MethodBinding
 
MethodParam(Method, int) - Constructor for class picocli.CommandLine.Model.MethodParam
 
methodParams - Variable in class picocli.CommandLine.Model.CommandSpec
 
methods - Variable in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedClass
 
min - Variable in class picocli.CommandLine.Range
Deprecated.
min() - Method in class picocli.CommandLine.Range
Returns the lower bound of this range (inclusive).
min(int) - Method in class picocli.CommandLine.Range
Returns a new Range object with the min value replaced by the specified value.
MinimalOptionRenderer() - Constructor for class picocli.CommandLine.Help.MinimalOptionRenderer
 
MinimalParameterRenderer() - Constructor for class picocli.CommandLine.Help.MinimalParameterRenderer
 
MINIMUM_USAGE_WIDTH - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
 
missing - Variable in exception picocli.CommandLine.MissingParameterException
 
MissingParameterException(CommandLine, Collection<CommandLine.Model.ArgSpec>, String) - Constructor for exception picocli.CommandLine.MissingParameterException
 
MissingParameterException(CommandLine, CommandLine.Model.ArgSpec, String) - Constructor for exception picocli.CommandLine.MissingParameterException
 
MissingTypeConverterException(CommandLine, String) - Constructor for exception picocli.CommandLine.MissingTypeConverterException
 
MIXEE - picocli.CommandLine.Spec.Target
Injects the CommandSpec of the "mixee" command that receives the options and other command elements defined here, or null if this commands is not mixed into another command.
mixin - Variable in class picocli.codegen.annotation.processing.MixinInfo
 
mixin() - Method in class picocli.codegen.annotation.processing.MixinInfo
 
mixinAnnotatedElements - Variable in class picocli.CommandLine.Model.CommandSpec
 
mixinAnnotatedElements() - Method in class picocli.CommandLine.Model.CommandSpec
Returns a map of the mixin names to mixin IAnnotatedElement objects for this command.
MixinInfo - Class in picocli.codegen.annotation.processing
Holds information on the `@Mixin`-annotated program element.
MixinInfo(VariableElement, CommandLine.Model.CommandSpec) - Constructor for class picocli.codegen.annotation.processing.MixinInfo
 
mixinInfoMap - Variable in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Context
 
mixinName - Variable in class picocli.codegen.annotation.processing.MixinInfo
 
mixinName() - Method in class picocli.codegen.annotation.processing.MixinInfo
 
mixins - Variable in class picocli.CommandLine.Model.CommandSpec
 
mixins() - Method in class picocli.CommandLine.Model.CommandSpec
Returns a map of the mixin names to mixin CommandSpec objects configured for this command.
mixinStandardHelpOptions() - Method in annotation type picocli.CommandLine.Command
Adds the standard -h and --help usageHelp options and -V and --version versionHelp options to the options of this command.
mixinStandardHelpOptions() - Method in class picocli.CommandLine.Model.CommandSpec
Returns true if the standard help options have been mixed in with this command, false otherwise.
mixinStandardHelpOptions(boolean) - Method in class picocli.CommandLine.Model.CommandSpec
Sets whether the standard help options should be mixed in with this command.
mkdirs(ManPageGenerator.Config, File) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
Model() - Constructor for class picocli.CommandLine.Model
 
modelTransformer - Variable in class picocli.CommandLine.Model.CommandSpec
 
modelTransformer() - Method in annotation type picocli.CommandLine.Command
Returns the model transformer for this command.
modelTransformer() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the model transformer for this CommandSpec instance.
modelTransformer(CommandLine.IModelTransformer) - Method in class picocli.CommandLine.Model.CommandSpec
Sets the model transformer for this CommandSpec instance.
mostSimilar(String, Iterable<String>) - Static method in class picocli.CommandLine.CosineSimilarity
 
mostSimilar(String, Iterable<String>, double) - Static method in class picocli.CommandLine.CosineSimilarity
 
multiplicity - Variable in class picocli.CommandLine.Model.ArgGroupSpec.Builder
 
multiplicity - Variable in class picocli.CommandLine.Model.ArgGroupSpec
 
multiplicity() - Method in annotation type picocli.CommandLine.ArgGroup
Determines how often this group can be specified on the command line; "0..1" (optional) by default.
multiplicity() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the multiplicity of this group: how many occurrences it may have on the command line; "0..1" (optional) by default.
multiplicity() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the multiplicity of this group: how many occurrences it may have on the command line; "0..1" (optional) by default.
multiplicity(String) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets the multiplicity of this group: how many occurrences it may have on the command line; "0..1" (optional) by default.
multiplicity(CommandLine.Range) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets the multiplicity of this group: how many occurrences it may have on the command line; "0..1" (optional) by default.
MutuallyExclusiveArgsException(CommandLine, String) - Constructor for exception picocli.CommandLine.MutuallyExclusiveArgsException
 

N

name - Variable in class picocli.codegen.annotation.processing.TypedMember
 
name - Variable in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedClass
 
name - Variable in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedField
 
name - Variable in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedMethod
 
name - Variable in class picocli.CommandLine.Model.CommandSpec
 
name - Variable in class picocli.CommandLine.Model.MethodParam
 
name - Variable in class picocli.CommandLine.Model.TypedMember
 
name() - Method in annotation type picocli.CommandLine.Command
Program name to show in the synopsis.
name() - Method in annotation type picocli.CommandLine.Mixin
Optionally specify a name that the mixin object can be retrieved with from the CommandSpec.
name() - Method in class picocli.CommandLine.Model.CommandSpec
Returns name of this command.
name(String) - Method in class picocli.CommandLine.Model.CommandSpec
Sets the String to use as the program name in the synopsis line of the help message.
names - Variable in class picocli.CommandLine.Model.OptionSpec.Builder
 
names - Variable in class picocli.CommandLine.Model.OptionSpec
 
names() - Method in class picocli.CommandLine.Model.CommandSpec
Returns all names of this command, including CommandLine.Model.CommandSpec.name() and CommandLine.Model.CommandSpec.aliases().
names() - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Returns one or more option names.
names() - Method in class picocli.CommandLine.Model.OptionSpec
Returns one or more option names.
names() - Method in annotation type picocli.CommandLine.Option
One or more option names.
names(String...) - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Replaces the option names with the specified values.
NativeImageConfigGeneratorProcessor - Class in picocli.codegen.aot.graalvm.processor
 
NativeImageConfigGeneratorProcessor() - Constructor for class picocli.codegen.aot.graalvm.processor.NativeImageConfigGeneratorProcessor
 
negatable - Variable in class picocli.CommandLine.Model.OptionSpec.Builder
 
negatable - Variable in class picocli.CommandLine.Model.OptionSpec
 
negatable() - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Returns whether a negative version for this boolean option is automatically added.
negatable() - Method in class picocli.CommandLine.Model.OptionSpec
Returns whether a negative version for this boolean option is automatically added.
negatable() - Method in annotation type picocli.CommandLine.Option
(Only for boolean options): set this to automatically add a negative version for this boolean option.
negatable(boolean) - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Sets whether a negative version for this boolean option is automatically added, and returns this builder.
negatableOptionTransformer - Variable in class picocli.CommandLine.Model.CommandSpec
 
negatableOptionTransformer() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the INegatableOptionTransformer used to create the negative form of negatable options.
negatableOptionTransformer(CommandLine.INegatableOptionTransformer) - Method in class picocli.CommandLine.Model.CommandSpec
Sets the INegatableOptionTransformer used to create the negative form of negatable options.
negate(AutoComplete.Predicate<T>) - Static method in class picocli.AutoComplete
 
negatedOptionsByNameMap - Variable in class picocli.CommandLine.Model.CommandSpec
 
negatedOptionsMap() - Method in class picocli.CommandLine.Model.CommandSpec
Returns a map of the negated option names to option spec objects configured for this command.
NetworkInterfaceConverter() - Constructor for class picocli.CommandLine.BuiltIn.NetworkInterfaceConverter
 
NEVER - picocli.CommandLine.Help.Visibility
 
NO_DEFAULT_VALUE - Static variable in class picocli.CommandLine.Model.ArgSpec
 
NO_HEADING - Static variable in class picocli.CommandLine.Model.ArgGroupSpec
 
NO_HEADING_KEY - Static variable in class picocli.CommandLine.Model.ArgGroupSpec
 
NoCompletionCandidates() - Constructor for class picocli.CommandLine.NoCompletionCandidates
 
NoDefaultProvider() - Constructor for class picocli.CommandLine.NoDefaultProvider
 
NoOpModelTransformer() - Constructor for class picocli.CommandLine.NoOpModelTransformer
 
NoOpParameterPreprocessor() - Constructor for class picocli.CommandLine.NoOpParameterPreprocessor
 
notNull(T, String) - Static method in class picocli.codegen.util.Assert
Throws a NullPointerException if the specified object is null.
notNull(T, String) - Static method in class picocli.CommandLine.Assert
Throws a NullPointerException if the specified object is null.
NoVersionProvider() - Constructor for class picocli.CommandLine.NoVersionProvider
 
nowProcessing - Variable in class picocli.CommandLine.ParseResult.Builder
 
nowProcessing(CommandLine.Model.ArgSpec, Object) - Method in class picocli.CommandLine.ParseResult.Builder
 
NULL_VALUE - Static variable in class picocli.CommandLine.Model.ArgSpec
Special value that can be used to designate null.
NULL_VALUE - Static variable in annotation type picocli.CommandLine.Option
Special value that can be used in some annotation attributes to designate null.
NULL_VALUE - Static variable in annotation type picocli.CommandLine.Parameters
Special value that can be used in some annotation attributes to designate null.
NullFactory() - Constructor for class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.NullFactory
 
NullFunction() - Constructor for class picocli.AutoComplete.NullFunction
 
NullParameterConsumer() - Constructor for class picocli.CommandLine.NullParameterConsumer
 

O

ObjectBinding() - Constructor for class picocli.CommandLine.Model.ObjectBinding
 
ObjectScope(Object) - Constructor for class picocli.CommandLine.Model.ObjectScope
 
off() - Method in interface picocli.CommandLine.Help.Ansi.IStyle
Returns the ANSI escape code for turning this style off.
off() - Method in class picocli.CommandLine.Help.Ansi.Palette256Color
 
off() - Method in enum picocli.CommandLine.Help.Ansi.Style
 
off(CommandLine.Help.Ansi.IStyle...) - Static method in enum picocli.CommandLine.Help.Ansi.Style
Returns the concatenated ANSI escape codes for turning all specified styles off.
OFF - picocli.CommandLine.Help.Ansi
Forced OFF: never emit ANSI escape code regardless of the platform.
OFF - picocli.CommandLine.TraceLevel
 
OK - Static variable in class picocli.CommandLine.ExitCode
Return value from the execute and executeHelpRequest methods signifying successful termination.
on() - Method in interface picocli.CommandLine.Help.Ansi.IStyle
Returns the ANSI escape code for turning this style on.
on() - Method in class picocli.CommandLine.Help.Ansi.Palette256Color
 
on() - Method in enum picocli.CommandLine.Help.Ansi.Style
 
on(CommandLine.Help.Ansi.IStyle...) - Static method in enum picocli.CommandLine.Help.Ansi.Style
Returns the concatenated ANSI escape codes for turning all specified styles on.
ON - picocli.CommandLine.Help.Ansi
Forced ON: always emit ANSI escape code regardless of the platform.
ON_DEMAND - picocli.CommandLine.Help.Visibility
 
OPTION_BUNDLES - Static variable in class picocli.codegen.aot.graalvm.processor.ResourceConfigGen
Name of the processor option that can be used to specify a comma-separated list of additional resource bundles to include in the native image.
OPTION_DISABLE - Static variable in class picocli.codegen.aot.graalvm.processor.ProxyConfigGen
Name of the processor option that can be used to disable generation of the proxy-config.json file.
OPTION_DISABLE - Static variable in class picocli.codegen.aot.graalvm.processor.ReflectConfigGen
Name of the processor option that can be used to disable generation of the reflect-config.json file.
OPTION_DISABLE - Static variable in class picocli.codegen.aot.graalvm.processor.ResourceConfigGen
Name of the processor option that can be used to disable generation of the resource-config.json file.
OPTION_INDEX - Static variable in class picocli.CommandLine.PositionalParametersSorter
 
OPTION_INTERFACE_CLASSES - Static variable in class picocli.codegen.aot.graalvm.processor.ProxyConfigGen
Name of the processor option that can be used to specify a comma-separated list of interface classes requiring a dynamic proxy to include in the native image.
OPTION_PROJECT - Static variable in class picocli.codegen.aot.graalvm.processor.NativeImageConfigGeneratorProcessor
Name of the annotation processor option that can be used to control the actual location where the generated file(s) are to be written to, relative to the NativeImageConfigGeneratorProcessor.BASE_PATH.
OPTION_RESOURCE_REGEX - Static variable in class picocli.codegen.aot.graalvm.processor.ResourceConfigGen
Name of the processor option that can be used to specify a comma-separated list of regular expressions pointing to additional resource to include in the native image.
OPTION_SEPARATOR_COLUMN - Static variable in class picocli.CommandLine.Help.TextTable
 
OPTION_VERBOSE - Static variable in class picocli.codegen.aot.graalvm.processor.AbstractGenerator
 
optionArity(Field) - Static method in class picocli.CommandLine.Range
Returns a new Range based on the CommandLine.Option.arity() annotation on the specified field, or the field type's default arity if no arity was specified.
optionArity(CommandLine.Model.IAnnotatedElement) - Static method in class picocli.CommandLine.Range
 
optionDefaultValue(CommandLine.Model.OptionSpec) - Method in class picocli.CommandLine.PropertiesDefaultProvider
 
optionDescription(String, CommandLine.Model.ArgSpec, int) - Static method in class picocli.CommandLine
 
optionList() - Method in class picocli.CommandLine.Help
Returns a description of all options in this command, including any argument groups.
optionList(CommandLine.Help.Layout, Comparator<CommandLine.Model.OptionSpec>, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help
Sorts all Options with the specified comparator (if the comparator is non-null), then adds all non-hidden options to the specified TextTable and returns the result of TextTable.toString().
optionListExcludingGroups(List<CommandLine.Model.OptionSpec>) - Method in class picocli.CommandLine.Help
Returns a description of the specified list of options.
optionListExcludingGroups(List<CommandLine.Model.OptionSpec>, CommandLine.Help.Layout, Comparator<CommandLine.Model.OptionSpec>, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help
Sorts all Options with the specified comparator (if the comparator is non-null), then adds the specified options to the specified TextTable and returns the result of TextTable.toString().
optionListGroups(List<CommandLine.Model.ArgGroupSpec>, List<CommandLine.Model.ArgGroupSpec>) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
optionListGroups(CommandLine.Model.CommandSpec) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
Returns the list of ArgGroupSpecs with a non-null heading.
optionListGroupSections() - Method in class picocli.CommandLine.Help
Returns a rendered section of the usage help message that contains the argument groups that have a non-null heading.
optionListGroupSections(List<CommandLine.Model.ArgGroupSpec>, Comparator<CommandLine.Model.OptionSpec>, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help
 
optionListHeading - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
optionListHeading() - Method in annotation type picocli.CommandLine.Command
Set the heading preceding the options list.
optionListHeading() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional heading preceding the options list.
optionListHeading(Object...) - Method in class picocli.CommandLine.Help
Returns the text displayed before the option list; an empty string if there are no options, otherwise the result of String.format(optionListHeading, params).
optionListHeading(String) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the heading preceding the options list.
optionNames(List<CommandLine.Model.OptionSpec>) - Static method in class picocli.AutoComplete
 
optionParams(CommandLine.Help.Ansi.IStyle...) - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Adds the specified styles to the registered styles for option parameters in this color scheme builder and returns this builder.
optionParamStyles - Variable in class picocli.CommandLine.Help.ColorScheme.Builder
 
optionParamStyles - Variable in class picocli.CommandLine.Help.ColorScheme
 
optionParamStyles() - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Returns the registered styles for option parameters in this color scheme builder.
optionParamStyles() - Method in class picocli.CommandLine.Help.ColorScheme
Returns the registered styles for option parameters in this color scheme.
optionParamText(String) - Method in class picocli.CommandLine.Help.ColorScheme
Returns a Text with all optionParam styles applied to the specified optionParam string.
optionRenderer - Variable in class picocli.CommandLine.Help.Layout
 
optionRenderer() - Method in class picocli.CommandLine.Help.Layout
Returns the IOptionRenderer used to render options to Text before adding this text to the TextTable in this layout.
options - Variable in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Context
 
options - Variable in class picocli.CommandLine.Model.CommandSpec
 
options - Variable in class picocli.CommandLine.ParseResult.Builder
 
options() - Method in class picocli.CommandLine.Help
 
options() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the list of options configured for this group.
options() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the list of options configured for this command.
options(CommandLine.Help.Ansi.IStyle...) - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Adds the specified styles to the registered styles for options in this color scheme and returns this color scheme.
optionsByNameMap - Variable in class picocli.CommandLine.Model.CommandSpec
 
optionsCaseInsensitive() - Method in class picocli.CommandLine.Model.CommandSpec
Returns whether the options are case-insensitive.
optionsCaseInsensitive(boolean) - Method in class picocli.CommandLine.Model.CommandSpec
Sets the case-insensitivity of options.
optionSectionGroups() - Method in class picocli.CommandLine.Help
Returns the list of ArgGroupSpec instances in this command that have a non-null heading, most deeply nested argument groups first.
optionSectionGroups(List<CommandLine.Model.ArgGroupSpec>, List<CommandLine.Model.ArgGroupSpec>) - Static method in class picocli.CommandLine.Help
 
optionsMap() - Method in class picocli.CommandLine.Model.CommandSpec
Returns a map of the option names to option spec objects configured for this command.
OptionSpec(CommandLine.Model.OptionSpec.Builder) - Constructor for class picocli.CommandLine.Model.OptionSpec
Ensures all attributes of this OptionSpec have a valid value; throws an CommandLine.InitializationException if this cannot be achieved.
optionStyles - Variable in class picocli.CommandLine.Help.ColorScheme.Builder
 
optionStyles - Variable in class picocli.CommandLine.Help.ColorScheme
 
optionStyles() - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Returns the registered styles for options in this color scheme builder.
optionStyles() - Method in class picocli.CommandLine.Help.ColorScheme
Returns the registered styles for options in this color scheme.
optionText(String) - Method in class picocli.CommandLine.Help.ColorScheme
Returns a Text with all option styles applied to the specified option string.
order - Variable in class picocli.CommandLine.Model.ArgGroupSpec.Builder
 
order - Variable in class picocli.CommandLine.Model.ArgGroupSpec
 
order - Variable in class picocli.CommandLine.Model.OptionSpec.Builder
 
order - Variable in class picocli.CommandLine.Model.OptionSpec
 
order() - Method in annotation type picocli.CommandLine.ArgGroup
Determines the position in the options list in the usage help message at which this group should be shown.
order() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the position in the options list in the usage help message at which this group should be shown.
order() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the position in the options list in the usage help message at which this group should be shown.
order() - Method in interface picocli.CommandLine.Model.IOrdered
Returns the position in the options list in the usage help message at which this element should be shown.
order() - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Returns the position in the options list in the usage help message at which this option should be shown.
order() - Method in class picocli.CommandLine.Model.OptionSpec
Returns the position in the options list in the usage help message at which this option should be shown.
order() - Method in annotation type picocli.CommandLine.Option
When @Command(sortOptions = false) is specified, this attribute can be used to control the order in which options are listed in the usage help message.
order(int) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets the position in the options list in the usage help message at which this group should be shown, and returns this builder.
order(int) - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Sets the position in the options list in the usage help message at which this option should be shown, and returns this builder.
originalArgList - Variable in class picocli.CommandLine.ParseResult.Builder
 
originalArgs - Variable in class picocli.CommandLine.ParseResult
 
originalArgs() - Method in class picocli.CommandLine.ParseResult
Returns the original command line arguments that were passed to the CommandLine.parseArgs(String...) method, before @-file expansion.
originalArgs(String[]) - Method in class picocli.CommandLine.ParseResult.Builder
Sets the specified original command line arguments that were passed to the CommandLine.parseArgs(String...) method, before @-file expansion.
originalStringValues - Variable in class picocli.CommandLine.Model.ArgSpec
 
originalStringValues - Variable in class picocli.CommandLine.ParseResult.GroupMatch
 
originalStringValues() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the original command line arguments matched by this option or positional parameter spec.
originalValue - Variable in class picocli.CommandLine.Range
 
originalValue() - Method in class picocli.CommandLine.Range
Returns the original String value that this range was constructed with.
out - Variable in class picocli.CommandLine.AbstractHandler
Deprecated.
 
out - Variable in class picocli.CommandLine.HelpCommand
 
out - Variable in class picocli.CommandLine
 
out() - Method in class picocli.CommandLine.AbstractHandler
Deprecated.
Returns the stream to print command output to.
outputFile - Variable in class picocli.codegen.aot.graalvm.DynamicProxyConfigGenerator.App
 
outputFile - Variable in class picocli.codegen.aot.graalvm.JniConfigGenerator.App
 
outputFile - Variable in class picocli.codegen.aot.graalvm.OutputFileMixin
 
outputFile - Variable in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.App
 
outputFile - Variable in class picocli.codegen.aot.graalvm.ResourceConfigGenerator.App
 
OutputFileMixin - Class in picocli.codegen.aot.graalvm
 
OutputFileMixin() - Constructor for class picocli.codegen.aot.graalvm.OutputFileMixin
 
outWriter - Variable in class picocli.CommandLine.HelpCommand
 
overflow - Variable in class picocli.CommandLine.Help.Column
Policy that determines how to handle values larger than the column width.
Overflow() - Constructor for enum picocli.CommandLine.Help.Column.Overflow
 
overlaps(CommandLine.Range) - Method in class picocli.CommandLine.Range
 
overwriteIfExists - Variable in class picocli.AutoComplete.App
 
overwrittenArg - Variable in exception picocli.CommandLine.OverwrittenOptionException
 
OverwrittenOptionException(CommandLine, CommandLine.Model.ArgSpec, String) - Constructor for exception picocli.CommandLine.OverwrittenOptionException
 
overwrittenOptionsAllowed - Variable in class picocli.CommandLine.Model.ParserSpec
 
overwrittenOptionsAllowed() - Method in class picocli.CommandLine.Model.ParserSpec
 
overwrittenOptionsAllowed(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 

P

Palette256Color(boolean, String) - Constructor for class picocli.CommandLine.Help.Ansi.Palette256Color
 
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.
parameterArity(CommandLine.Model.IAnnotatedElement) - Static method in class picocli.CommandLine.Range
 
parameterCapacity(CommandLine.Model.IAnnotatedElement) - Static method in class picocli.CommandLine.Range
 
parameterCapacity(CommandLine.Range, CommandLine.Range) - Static method in class picocli.CommandLine.Range
 
parameterConsumer - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
parameterConsumer - Variable in class picocli.CommandLine.Model.ArgSpec
 
parameterConsumer() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns the custom parameter handler for this option or positional parameter, or null.
parameterConsumer() - Method in class picocli.CommandLine.Model.ArgSpec
Returns a custom IParameterConsumer to temporarily suspend picocli's parsing logic and process one or more command line arguments in a custom manner, or null.
parameterConsumer() - Method in annotation type picocli.CommandLine.Option
Optionally specify a custom IParameterConsumer to temporarily suspend picocli's parsing logic and process one or more command line arguments in a custom manner.
parameterConsumer() - Method in annotation type picocli.CommandLine.Parameters
Optionally specify a custom IParameterConsumer to temporarily suspend picocli's parsing logic and process one or more command line arguments in a custom manner.
parameterConsumer(CommandLine.IParameterConsumer) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets the parameterConsumer for this option or positional parameter, and returns this builder.
ParameterConsumerMetaData - Class in picocli.codegen.annotation.processing
Implementation of the CommandLine.IParameterConsumer interface that provides metadata on the @Option(parameterConsumer = xxx.class) annotation.
ParameterConsumerMetaData(TypeMirror) - Constructor for class picocli.codegen.annotation.processing.ParameterConsumerMetaData
 
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.
parameterExceptionHandler - Variable in class picocli.CommandLine
 
parameterIndex(Field) - Static method in class picocli.CommandLine.Range
Returns a new Range based on the CommandLine.Parameters.index() annotation on the specified field.
parameterIndex(CommandLine.Model.IAnnotatedElement) - Static method in class picocli.CommandLine.Range
 
ParameterIndexGapException(String) - Constructor for exception picocli.CommandLine.ParameterIndexGapException
 
parameterLabelRenderer - Variable in class picocli.CommandLine.Help
 
parameterLabelRenderer() - Method in class picocli.CommandLine.Help
Option and positional parameter value label renderer used for the synopsis line(s) and the option list.
parameterList() - Method in class picocli.CommandLine.Help
Returns the rendered positional parameters section of the usage help message for all positional parameters in this command.
parameterList(List<CommandLine.Model.PositionalParamSpec>) - Method in class picocli.CommandLine.Help
Returns the rendered positional parameters section of the usage help message for the specified positional parameters.
parameterList(List<CommandLine.Model.PositionalParamSpec>, CommandLine.Help.Layout, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help
Returns the rendered section of the usage help message that lists the specified parameters with their descriptions.
parameterList(CommandLine.Help.Layout, CommandLine.Help.IParamLabelRenderer) - Method in class picocli.CommandLine.Help
Returns the rendered section of the usage help message that lists all positional parameters in this command with their descriptions.
parameterListHeading - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
parameterListHeading() - Method in annotation type picocli.CommandLine.Command
Set the heading preceding the parameters list.
parameterListHeading() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional heading preceding the parameter list.
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(String) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the optional heading preceding the parameter list.
parameterRenderer - Variable in class picocli.CommandLine.Help.Layout
 
parameterRenderer() - Method in class picocli.CommandLine.Help.Layout
Returns the IParameterRenderer used to render positional params to Text before adding this text to the TextTable in this layout.
parameters - Variable in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Context
 
parameters(CommandLine.Help.Ansi.IStyle...) - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Adds the specified styles to the registered styles for positional parameters in this color scheme builder and returns this builder.
parameterStyles - Variable in class picocli.CommandLine.Help.ColorScheme.Builder
 
parameterStyles - Variable in class picocli.CommandLine.Help.ColorScheme
 
parameterStyles() - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Returns the registered styles for positional parameters in this color scheme builder.
parameterStyles() - Method in class picocli.CommandLine.Help.ColorScheme
Returns the registered styles for positional parameters in this color scheme.
parameterText(String) - Method in class picocli.CommandLine.Help.ColorScheme
Returns a Text with all parameter styles applied to the specified parameter string.
paramIndex - Variable in class picocli.CommandLine.Model.MethodParam
 
paramLabel - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
paramLabel - Variable in class picocli.CommandLine.Model.ArgSpec
 
paramLabel() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns the name of the option or positional parameter used in the usage help message.
paramLabel() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the name of the option or positional parameter used in the usage help message.
paramLabel() - Method in annotation type picocli.CommandLine.Option
Specify a paramLabel for the option parameter to be used in the usage help message.
paramLabel() - Method in annotation type picocli.CommandLine.Parameters
Specify a paramLabel for the parameter to be used in the usage help message.
paramLabel(String) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets the name of the option or positional parameter used in the usage help message, and returns this builder.
paramTypes - Variable in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedMethod
 
paramTypes - Variable in class picocli.CommandLine.BuiltIn.ReflectionConverter
 
parent - Variable in class picocli.AutoComplete.CommandDescriptor
 
parent - Variable in class picocli.CommandLine.Model.CommandSpec
 
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.
parentCommandElements - Variable in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Context
 
parentCommandElements - Variable in class picocli.CommandLine.Model.CommandSpec
 
parentCommandElements() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the list of program elements annotated with {@literal @}ParentCommand configured for this command.
parentContainer - Variable in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
parentGroup - Variable in class picocli.CommandLine.Model.ArgGroupSpec
 
parentGroup() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the parent group that this group is part of, or null if this group is not part of a composite.
parse(String) - Static method in enum picocli.CommandLine.Help.Ansi.Style
Parses the specified comma-separated sequence of style descriptors and returns the associated styles.
parse(String) - Method in class picocli.CommandLine.Help.ColorScheme
Converts the specified markup styles to an array of CommandLine.Help.Ansi.IStyle objects.
parse(String) - Static method in enum picocli.CommandLine.LookBehind
 
parse(String...) - Method in class picocli.CommandLine.Interpreter
Entry point into parsing command line arguments.
parse(String...) - Method in class picocli.CommandLine
Deprecated.
parse(List<CommandLine>, Stack<String>, String[], List<Object>, Collection<CommandLine.Model.ArgSpec>) - Method in class picocli.CommandLine.Interpreter
 
parse(List<CommandLine>, Stack<String>, String[], List<Object>, Collection<CommandLine.Model.ArgSpec>, Set<CommandLine.Model.ArgSpec>) - Method in class picocli.CommandLine.Interpreter
 
parseArgs(String...) - Method in class picocli.CommandLine
Expands any @-files in the specified command line arguments, then parses the arguments and returns a ParseResult with the options, positional parameters, and subcommands (if any) that were recognized and initialized during the parsing process.
parseInt(String, int) - Static method in class picocli.CommandLine.Range
 
parser - Variable in class picocli.CommandLine.Model.CommandSpec
 
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.
ParseResult(CommandLine.ParseResult.Builder) - Constructor for class picocli.CommandLine.ParseResult
 
parseResultBuilder - Variable in class picocli.CommandLine.Interpreter
 
ParserSpec() - Constructor for class picocli.CommandLine.Model.ParserSpec
 
parseWithHandler(CommandLine.IParseResultHandler2<R>, String[]) - Method in class picocli.CommandLine
parseWithHandler(CommandLine.IParseResultHandler, PrintStream, String...) - Method in class picocli.CommandLine
parseWithHandlers(CommandLine.IParseResultHandler2<R>, CommandLine.IExceptionHandler2<R>, String...) - Method in class picocli.CommandLine
parseWithHandlers(CommandLine.IParseResultHandler, PrintStream, CommandLine.Help.Ansi, CommandLine.IExceptionHandler, String...) - Method in class picocli.CommandLine
PatternConverter() - Constructor for class picocli.CommandLine.BuiltIn.PatternConverter
 
picocli - package picocli
Provides classes and interfaces for the main picocli command line parsing and autocompletion functionality.
picocli.codegen.annotation.processing - package picocli.codegen.annotation.processing
 
picocli.codegen.aot.graalvm - package picocli.codegen.aot.graalvm
 
picocli.codegen.aot.graalvm.processor - package picocli.codegen.aot.graalvm.processor
 
picocli.codegen.docgen.manpage - package picocli.codegen.docgen.manpage
 
picocli.codegen.util - package picocli.codegen.util
 
picocli.shell.jline2 - package picocli.shell.jline2
 
PicocliException(String) - Constructor for exception picocli.CommandLine.PicocliException
 
PicocliException(String, Throwable) - Constructor for exception picocli.CommandLine.PicocliException
 
PicocliInvocationHandler() - Constructor for class picocli.CommandLine.Model.PicocliInvocationHandler
 
PicocliJLineCompleter - Class in picocli.shell.jline2
Implementation of the JLine 2 Completer interface that generates completion candidates for the specified command line based on the CommandLine.Model.CommandSpec that this PicocliJLineCompleter was constructed with.
PicocliJLineCompleter(CommandLine.Model.CommandSpec) - Constructor for class picocli.shell.jline2.PicocliJLineCompleter
Constructs a new PicocliJLineCompleter for the given command spec.
plain - Variable in class picocli.CommandLine.Help.Ansi.Text
 
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.
position - Variable in class picocli.codegen.annotation.processing.TypedMember
 
position - Variable in class picocli.CommandLine.Interpreter
 
position - Variable in class picocli.CommandLine.Model.MethodParam
 
position - Variable in class picocli.CommandLine.ParseResult.GroupMatch
 
positionalDefaultValue(CommandLine.Model.PositionalParamSpec) - Method in class picocli.CommandLine.PropertiesDefaultProvider
 
positionalParameters - Variable in class picocli.CommandLine.Model.CommandSpec
 
positionalParameters() - Method in class picocli.CommandLine.Help
 
positionalParameters() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the list of positional parameters configured for this group.
positionalParameters() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the list of positional parameters configured for this command.
PositionalParametersSorter() - Constructor for class picocli.CommandLine.PositionalParametersSorter
 
positionalParams - Variable in class picocli.CommandLine.ParseResult.Builder
 
PositionalParamSpec(CommandLine.Model.PositionalParamSpec.Builder) - Constructor for class picocli.CommandLine.Model.PositionalParamSpec
Ensures all attributes of this PositionalParamSpec have a valid value; throws an CommandLine.InitializationException if this cannot be achieved.
positionals - Variable in class picocli.CommandLine.ParseResult.Builder
 
positionDesc(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.Interpreter
 
posixClusteredShortOptionsAllowed - Variable in class picocli.CommandLine.Model.ParserSpec
 
posixClusteredShortOptionsAllowed() - Method in class picocli.CommandLine.Model.ParserSpec
 
posixClusteredShortOptionsAllowed(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
posixOptionsByKeyMap - Variable in class picocli.CommandLine.Model.CommandSpec
 
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.
POSTPONED - picocli.CommandLine.Model.InitialValueState
 
prefix(String) - Method in enum picocli.CommandLine.TraceLevel
 
preprocess(Stack<String>, CommandLine.Model.CommandSpec, CommandLine.Model.ArgSpec, Map<String, Object>) - Method in interface picocli.CommandLine.IParameterPreprocessor
Called when either the command, option or positional parameter that has this preprocessor configured was recognized by the picocli parser.
preprocess(Stack<String>, CommandLine.Model.CommandSpec, CommandLine.Model.ArgSpec, Map<String, Object>) - Method in class picocli.CommandLine.NoOpParameterPreprocessor
 
preprocessor - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
preprocessor - Variable in class picocli.CommandLine.Model.ArgSpec
 
preprocessor - Variable in class picocli.CommandLine.Model.CommandSpec
 
preprocessor() - Method in annotation type picocli.CommandLine.Command
Returns the preprocessor for this command.
preprocessor() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns the custom IParameterPreprocessor to either replace or complement picocli's parsing logic for the parameter(s) of this option or position, or null.
preprocessor() - Method in class picocli.CommandLine.Model.ArgSpec
Returns a custom IParameterPreprocessor to either replace or complement picocli's parsing logic for the parameter(s) of this option or position.
preprocessor() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the preprocessor for this CommandSpec instance.
preprocessor() - Method in annotation type picocli.CommandLine.Option
Returns the preprocessor for this option.
preprocessor() - Method in annotation type picocli.CommandLine.Parameters
Returns the preprocessor for this positional parameter.
preprocessor(CommandLine.IParameterPreprocessor) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets the custom IParameterPreprocessor for this option or position, and returns this builder.
preprocessor(CommandLine.IParameterPreprocessor) - Method in class picocli.CommandLine.Model.CommandSpec
Sets the preprocessor for this CommandSpec instance.
present() - Method in class picocli.CommandLine.ParseResult.GroupValidationResult
 
PRIMITIVES - Static variable in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
print(CommandLine.Tracer, String, Object...) - Method in enum picocli.CommandLine.TraceLevel
 
printHelpIfRequested(List<CommandLine>, PrintStream, PrintStream, CommandLine.Help.Ansi) - Static method in class picocli.CommandLine
printHelpIfRequested(List<CommandLine>, PrintStream, PrintStream, CommandLine.Help.ColorScheme) - Static method in class picocli.CommandLine
printHelpIfRequested(List<CommandLine>, PrintStream, CommandLine.Help.Ansi) - Static method in class picocli.CommandLine
printHelpIfRequested(CommandLine.ParseResult) - Static method in class picocli.CommandLine
printSuggestions(PrintStream) - Method in exception picocli.CommandLine.UnmatchedArgumentException
Returns true and prints suggested solutions to the specified stream if such solutions exist, otherwise returns false.
printSuggestions(PrintWriter) - Method in exception picocli.CommandLine.UnmatchedArgumentException
Returns true and prints suggested solutions to the specified stream if such solutions exist, otherwise returns false.
printSuggestions(CommandLine.ParameterException, PrintStream) - Static method in exception picocli.CommandLine.UnmatchedArgumentException
Returns true and prints suggested solutions to the specified stream if such solutions exist, otherwise returns false.
printSuggestions(CommandLine.ParameterException, PrintWriter) - Static method in exception picocli.CommandLine.UnmatchedArgumentException
Returns true and prints suggested solutions to the specified writer if such solutions exist, otherwise returns false.
printVersionHelp(PrintStream) - Method in class picocli.CommandLine
Delegates to CommandLine.printVersionHelp(PrintStream, Help.Ansi) with the ANSI setting of the configured color scheme.
printVersionHelp(PrintStream, CommandLine.Help.Ansi) - Method in class picocli.CommandLine
Prints version information from the CommandLine.Command.version() annotation to the specified PrintStream.
printVersionHelp(PrintStream, CommandLine.Help.Ansi, Object...) - Method in class picocli.CommandLine
Prints version information from the CommandLine.Command.version() annotation to the specified PrintStream.
printVersionHelp(PrintWriter) - Method in class picocli.CommandLine
Delegates to CommandLine.printVersionHelp(PrintWriter, Help.Ansi, Object...) with the ANSI setting of the configured color scheme.
printVersionHelp(PrintWriter, CommandLine.Help.Ansi, Object...) - Method in class picocli.CommandLine
Prints version information from the CommandLine.Command.version() annotation to the specified PrintWriter.
process(Set<? extends TypeElement>, RoundEnvironment) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
processArguments(List<CommandLine>, Stack<String>, Collection<CommandLine.Model.ArgSpec>, Set<CommandLine.Model.ArgSpec>, String[], List<Object>) - Method in class picocli.CommandLine.Interpreter
 
processClusteredShortOptions(Collection<CommandLine.Model.ArgSpec>, Set<CommandLine.Model.ArgSpec>, String, boolean, Stack<String>) - Method in class picocli.CommandLine.Interpreter
 
processEnclosedElements(AbstractCommandSpecProcessor.Context, RoundEnvironment, List<? extends Element>) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
processingEnv - Variable in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
The ProcessingEnvironment set by the AbstractCommandSpecProcessor.init(ProcessingEnvironment) method.
processingEnv - Variable in class picocli.codegen.annotation.processing.AnnotationValidator
 
processingEnv - Variable in class picocli.codegen.aot.graalvm.processor.AbstractGenerator
 
ProcessorUtil - Class in picocli.codegen.aot.graalvm.processor
 
ProcessorUtil() - Constructor for class picocli.codegen.aot.graalvm.processor.ProcessorUtil
 
processPositionalParameter(Collection<CommandLine.Model.ArgSpec>, Set<CommandLine.Model.ArgSpec>, boolean, Stack<String>) - Method in class picocli.CommandLine.Interpreter
 
processRemainderAsPositionalParameters(Collection<CommandLine.Model.ArgSpec>, Set<CommandLine.Model.ArgSpec>, Stack<String>) - Method in class picocli.CommandLine.Interpreter
 
processStandaloneOption(Collection<CommandLine.Model.ArgSpec>, Set<CommandLine.Model.ArgSpec>, String, boolean, Stack<String>, CommandLine.LookBehind) - Method in class picocli.CommandLine.Interpreter
 
processSubcommand(CommandLine, CommandLine.ParseResult.Builder, List<CommandLine>, Stack<String>, Collection<CommandLine.Model.ArgSpec>, Set<CommandLine.Model.ArgSpec>, String[], List<Object>, String, String) - Method in class picocli.CommandLine.Interpreter
 
prompt - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
prompt - Variable in class picocli.CommandLine.Model.ArgSpec
 
prompt() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns the text displayed to the end user for an interactive option or positional parameter when asking for user input.
prompt() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the text displayed to the end user for an interactive option or positional parameter when asking for user input.
prompt() - Method in annotation type picocli.CommandLine.Option
Use this attribute to customize the text displayed to the end user for an interactive option when asking for user input.
prompt() - Method in annotation type picocli.CommandLine.Parameters
Use this attribute to customize the text displayed to the end user for an interactive positional parameter when asking for user input.
prompt(String) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets the text displayed to the end user for an interactive option or positional parameter when asking for user input.
properties - Variable in class picocli.CommandLine.PropertiesDefaultProvider
 
PropertiesDefaultProvider() - Constructor for class picocli.CommandLine.PropertiesDefaultProvider
Default constructor, used when this default value provider is specified in the annotations:
PropertiesDefaultProvider(File) - Constructor for class picocli.CommandLine.PropertiesDefaultProvider
This constructor loads default values from the specified properties file.
PropertiesDefaultProvider(Properties) - Constructor for class picocli.CommandLine.PropertiesDefaultProvider
This constructor loads default values from the specified properties object.
propertyName(String) - Static method in class picocli.codegen.annotation.processing.TypedMember
 
propertyName(String) - Static method in class picocli.CommandLine.Model.TypedMember
 
ProxyBinding(Method) - Constructor for class picocli.CommandLine.Model.PicocliInvocationHandler.ProxyBinding
 
ProxyConfigGen - Class in picocli.codegen.aot.graalvm.processor
 
ProxyConfigGen(ProcessingEnvironment) - Constructor for class picocli.codegen.aot.graalvm.processor.ProxyConfigGen
 
put(K, V) - Method in class picocli.CommandLine.Model.CaseAwareLinkedMap
 
putValue(int, int, CommandLine.Help.Ansi.Text) - Method in class picocli.CommandLine.Help.TextTable
Writes the specified value into the cell at the specified row and column and returns the last row and column written to.

Q

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

R

Range(int, int, boolean, boolean, String) - Constructor for class picocli.CommandLine.Range
Constructs a new Range object with the specified parameters.
rawSynopsisUnitText(CommandLine.Help.ColorScheme, Set<CommandLine.Model.ArgSpec>) - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
rb - Variable in class picocli.CommandLine.Model.Messages
 
readPassword(String) - Method in class picocli.CommandLine.Interpreter
 
readUserInput(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.Interpreter
 
readUserInputWithEchoing(String) - Method in class picocli.CommandLine.Interpreter
 
recursivelyAddCommandLineTo(List<CommandLine>) - Method in class picocli.CommandLine.ParseResult
 
recursivelyExecuteUserObject(CommandLine.ParseResult, List<Object>) - Method in class picocli.CommandLine.RunAll
 
recursivelyExtractExitCodeGenerators(CommandLine.ParseResult, List<CommandLine.IExitCodeGenerator>) - Method in class picocli.CommandLine.RunAll
 
ReflectConfigGen - Class in picocli.codegen.aot.graalvm.processor
 
ReflectConfigGen(ProcessingEnvironment) - Constructor for class picocli.codegen.aot.graalvm.processor.ReflectConfigGen
 
REFLECTED_BINDING_FIELD_SCOPE - Static variable in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator
 
REFLECTED_FIELD_BINDING_CLASS - Static variable in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator
 
REFLECTED_FIELD_BINDING_FIELD - Static variable in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator
 
REFLECTED_METHOD_BINDING_CLASS - Static variable in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator
 
REFLECTED_METHOD_BINDING_METHOD - Static variable in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator
 
REFLECTED_PROXY_METHOD_BINDING_CLASS - Static variable in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator
 
ReflectedClass(Class<?>) - Constructor for class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedClass
 
ReflectedClass(String) - Constructor for class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedClass
 
ReflectedField(String, boolean) - Constructor for class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedField
 
ReflectedMethod(String, String...) - Constructor for class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedMethod
 
ReflectionConfigGenerator - Class in picocli.codegen.aot.graalvm
ReflectionConfigGenerator generates a JSON String with the program elements that will be accessed reflectively in a picocli-based application, in order to compile this application ahead-of-time into a native executable with GraalVM.
ReflectionConfigGenerator() - Constructor for class picocli.codegen.aot.graalvm.ReflectionConfigGenerator
 
ReflectionConfigGenerator.App - Class in picocli.codegen.aot.graalvm
 
ReflectionConfigGenerator.ReflectedClass - Class in picocli.codegen.aot.graalvm
 
ReflectionConfigGenerator.ReflectedField - Class in picocli.codegen.aot.graalvm
 
ReflectionConfigGenerator.ReflectedMethod - Class in picocli.codegen.aot.graalvm
 
ReflectionConfigGenerator.Visitor - Class in picocli.codegen.aot.graalvm
 
ReflectionConverter(Method, Class<?>...) - Constructor for class picocli.CommandLine.BuiltIn.ReflectionConverter
 
reg(Class<?>, Method, Class<?>...) - Method in class picocli.CommandLine.Interpreter
 
reg(Class<?>, CommandLine.BuiltIn.ISO8601TimeConverter) - Method in class picocli.CommandLine.Interpreter
 
RegexTransformer(CommandLine.RegexTransformer.Builder) - Constructor for class picocli.CommandLine.RegexTransformer
 
registerBuiltInConverters() - Method in class picocli.CommandLine.Interpreter
 
registerCommandType(CommandLine.Model.CommandSpec, TypeElement) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Context
 
registerConverter(Class<K>, CommandLine.ITypeConverter<K>) - Method in class picocli.CommandLine
Registers the specified type converter for the specified class.
registerSubcommands(List<AnnotationValue>, List<CommandLine.Model.CommandSpec>, AbstractCommandSpecProcessor.Context, RoundEnvironment) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
registerSubcommands(Map<String, CommandLine>) - Method in class picocli.CommandLine.Help
 
reindent(int) - Method in class picocli.CommandLine.Help.TextTable
 
relative - Variable in class picocli.CommandLine.Range
 
remove(Object) - Method in class picocli.CommandLine.Model.CaseAwareLinkedMap
 
remove(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.Model.CommandSpec
(INCUBATING) Removes the specified option spec or positional parameter spec from the list of configured arguments to expect.
remove(CommandLine.Model.ArgSpec, Map<T, CommandLine.Model.OptionSpec>) - Static method in class picocli.CommandLine.Model.CommandSpec
 
removePattern(String) - Method in class picocli.CommandLine.RegexTransformer.Builder
Removes the negative replacement and synopsis replacement for the specified regular expression.
removeSubcommand(String) - Method in class picocli.CommandLine.Model.CommandSpec
Removes the subcommand with the specified name or alias from this CommandSpec and returns the CommandLine instance that was associated with the specified name, or null of the specified name was not associated with a subcommand.
render(CommandLine.Help) - Method in interface picocli.CommandLine.IHelpSectionRenderer
Renders a section of the usage help, like header heading, header, synopsis heading, synopsis, description heading, description, etc.
render(CommandLine.Model.OptionSpec, CommandLine.Help.IParamLabelRenderer, CommandLine.Help.ColorScheme) - Method in class picocli.CommandLine.Help.DefaultOptionRenderer
 
render(CommandLine.Model.OptionSpec, CommandLine.Help.IParamLabelRenderer, CommandLine.Help.ColorScheme) - Method in interface picocli.CommandLine.Help.IOptionRenderer
Returns a text representation of the specified option and its parameter(s) if any.
render(CommandLine.Model.OptionSpec, CommandLine.Help.IParamLabelRenderer, CommandLine.Help.ColorScheme) - Method in class picocli.CommandLine.Help.MinimalOptionRenderer
 
render(CommandLine.Model.PositionalParamSpec, CommandLine.Help.IParamLabelRenderer, CommandLine.Help.ColorScheme) - Method in class picocli.CommandLine.Help.DefaultParameterRenderer
 
render(CommandLine.Model.PositionalParamSpec, CommandLine.Help.IParamLabelRenderer, CommandLine.Help.ColorScheme) - Method in interface picocli.CommandLine.Help.IParameterRenderer
Returns a text representation of the specified positional parameter.
render(CommandLine.Model.PositionalParamSpec, CommandLine.Help.IParamLabelRenderer, CommandLine.Help.ColorScheme) - Method in class picocli.CommandLine.Help.MinimalParameterRenderer
 
renderDescriptionLines(CommandLine.Model.OptionSpec, CommandLine.Help.ColorScheme, String, String, CommandLine.Help.Ansi.Text) - Method in class picocli.CommandLine.Help.DefaultOptionRenderer
 
renderedDescription() - Method in class picocli.CommandLine.Model.ArgSpec
renderParameterLabel(CommandLine.Model.ArgSpec, CommandLine.Help.Ansi, List<CommandLine.Help.Ansi.IStyle>) - Method in class picocli.CommandLine.Help.DefaultParamLabelRenderer
 
renderParameterLabel(CommandLine.Model.ArgSpec, CommandLine.Help.Ansi, List<CommandLine.Help.Ansi.IStyle>) - Method in interface picocli.CommandLine.Help.IParamLabelRenderer
Returns a text rendering of the option parameter or positional parameter; returns an empty string "" if the option is a boolean and does not take a parameter.
replace(List<CommandLine.Help.Ansi.IStyle>, String) - Method in class picocli.CommandLine.Help.ColorScheme.Builder
 
replacements - Variable in class picocli.CommandLine.RegexTransformer.Builder
 
replacements - Variable in class picocli.CommandLine.RegexTransformer
 
required - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
required - Variable in class picocli.CommandLine.Model.ArgSpec
 
required() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns whether this is a required option or positional parameter.
required() - Method in class picocli.CommandLine.Model.ArgSpec
Returns whether this is a required option or positional parameter without a default value.
required() - Method in annotation type picocli.CommandLine.Option
Indicates whether this option is required.
required(boolean) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets whether this is a required option or positional parameter, and returns this builder.
requiredArgs - Variable in class picocli.CommandLine.Model.CommandSpec
 
requiredArgs() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the required options and positional parameters in this group; may be empty but not null.
requiredArgs() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the list of required options and positional parameters configured for this command.
requiredMarker - Variable in class picocli.CommandLine.Help.DefaultOptionRenderer
 
requiredMarker - Variable in class picocli.CommandLine.Help.DefaultParameterRenderer
 
requiredOptionMarker - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
requiredOptionMarker() - Method in annotation type picocli.CommandLine.Command
Prefix required options with this character in the options list.
requiredOptionMarker() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the character used to prefix required options in the options list.
requiredOptionMarker(char) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the character used to prefix required options in the options list.
resemblesOption(String, CommandLine.Tracer) - Method in class picocli.CommandLine.Model.CommandSpec
 
reset - picocli.CommandLine.Help.Ansi.Style
 
resetNegativeOptionNames() - Method in class picocli.CommandLine.Model.CommandSpec
 
resetOriginalStringValues() - Method in class picocli.CommandLine.Model.ArgSpec
Sets the originalStringValues to a new list instance.
resetStringValues() - Method in class picocli.CommandLine.Model.ArgSpec
Sets the stringValues to a new list instance.
resetStyle() - Method in class picocli.CommandLine.Help.ColorScheme
Returns the style that "resets" the style state to neutral.
resolveExitCode(int, R, List<CommandLine.IExitCodeGenerator>) - Method in class picocli.CommandLine.AbstractParseResultHandler
Deprecated.
 
resolveLookups(String, Set<String>, Map<String, String>) - Method in class picocli.CommandLine.Model.Interpolator
 
resourceArr(String) - Method in class picocli.CommandLine.Model.UsageMessageSpec
 
resourceBundle() - Method in annotation type picocli.CommandLine.Command
Set the base name of the ResourceBundle to find option and positional parameters descriptions, as well as usage help message sections and section headings.
resourceBundle() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the resource bundle for this command.
resourceBundle() - Method in class picocli.CommandLine.Model.Messages
Returns the ResourceBundle of this object or null.
resourceBundle(ResourceBundle) - Method in class picocli.CommandLine.Model.CommandSpec
Initializes the resource bundle for this command: sets the UsageMessageSpec.messages to a Messages object created from this command spec and the specified bundle, and then sets the ArgSpec.messages of all options and positional parameters in this command to the same Messages instance.
resourceBundle(CommandLine.Model.Messages) - Static method in class picocli.CommandLine.Model.Messages
Returns the ResourceBundle of the specified Messages object or null if the specified Messages object is null.
resourceBundleBaseName() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the resource bundle base name for this command.
resourceBundleBaseName() - Method in class picocli.CommandLine.Model.Messages
Returns the base name of the ResourceBundle of this object or null.
resourceBundleBaseName(String) - Method in class picocli.CommandLine.Model.CommandSpec
Initializes the resource bundle for this command: sets the UsageMessageSpec.messages to a Messages object created from this command spec and the specified bundle, and then sets the ArgSpec.messages of all options and positional parameters in this command to the same Messages instance.
resourceBundleBaseName(CommandLine.Model.Messages) - Static method in class picocli.CommandLine.Model.Messages
Returns the ResourceBundle of the specified Messages object or null if the specified Messages object is null.
ResourceConfigGen - Class in picocli.codegen.aot.graalvm.processor
 
ResourceConfigGen(ProcessingEnvironment) - Constructor for class picocli.codegen.aot.graalvm.processor.ResourceConfigGen
 
ResourceConfigGenerator - Class in picocli.codegen.aot.graalvm
ResourceConfigGenerator generates a JSON String with the resource bundles and other classpath resources that should be included in the Substrate VM native image.
ResourceConfigGenerator() - Constructor for class picocli.codegen.aot.graalvm.ResourceConfigGenerator
 
ResourceConfigGenerator.App - Class in picocli.codegen.aot.graalvm
 
ResourceConfigGenerator.Visitor - Class in picocli.codegen.aot.graalvm
 
resourceRegex - Variable in class picocli.codegen.aot.graalvm.ResourceConfigGenerator.App
 
resources - Variable in class picocli.codegen.aot.graalvm.ResourceConfigGenerator.Visitor
 
resourcesJson() - Method in class picocli.codegen.aot.graalvm.ResourceConfigGenerator.Visitor
 
resourceStr(String) - Method in class picocli.CommandLine.Model.UsageMessageSpec
 
restoreQuotedValues(String, Queue<String>, CommandLine.Model.ParserSpec) - Static method in class picocli.CommandLine.Model.ArgSpec
 
returnResultOrExit(R) - Method in class picocli.CommandLine.AbstractHandler
Deprecated.
Convenience method for subclasses that returns the specified result object if no exit code was set, or otherwise, if an exit code was set, calls System.exit with the configured exit code to terminate the currently running Java virtual machine.
reverse - picocli.CommandLine.Help.Ansi.Style
 
reverse(Stack<T>) - Static method in class picocli.CommandLine
 
reverseArray(T[]) - Static method in class picocli.CommandLine
 
reverseList(List<T>) - Static method in class picocli.CommandLine
 
richStackTraceString(Throwable) - Method in class picocli.CommandLine.Help.ColorScheme
Returns a String with the error styles applied to the stack trace lines showing the throwable class name and error message (including "Caused by:..." lines), and the stack trace styles applied to the remaining stack trace of lines the specified Throwable.
root - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
root - Variable in class picocli.CommandLine.Model.ArgSpec
 
root() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns the root option or positional parameter (on the parent command), if this option or positional parameter was inherited; or null if it was not.
root() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the root option or positional parameter (on the parent command), if this option or positional parameter was inherited; or null if it was not.
root() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the root command: the top-level command of the hierarchy, never null.
root(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets the root object for this inherited option, and returns this builder.
row - Variable in class picocli.CommandLine.Help.TextTable.Cell
Table row index (zero based).
rowCount() - Method in class picocli.CommandLine.Help.TextTable
Returns the current number of rows of this TextTable.
run() - Method in class picocli.AutoComplete.GenerateCompletion
 
run() - Method in class picocli.CommandLine.HelpCommand
Invokes usage for the specified command, or for the parent command.
run(Class<R>, CommandLine.IFactory, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
Deprecated.
run(Class<R>, CommandLine.IFactory, PrintStream, String...) - Static method in class picocli.CommandLine
Deprecated.
run(Class<R>, CommandLine.IFactory, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
Deprecated.
run(Class<R>, CommandLine.IFactory, String...) - Static method in class picocli.CommandLine
Deprecated.
run(R, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
Deprecated.
run(R, PrintStream, String...) - Static method in class picocli.CommandLine
Deprecated.
run(R, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
Deprecated.
run(R, String...) - Static method in class picocli.CommandLine
Deprecated.
RunAll() - Constructor for class picocli.CommandLine.RunAll
 
RunFirst() - Constructor for class picocli.CommandLine.RunFirst
 
RunLast() - Constructor for class picocli.CommandLine.RunLast
 
RuntimeTypeInfo(Class<?>, Class<?>[], List<String>) - Constructor for class picocli.CommandLine.Model.RuntimeTypeInfo
 

S

scope - Variable in class picocli.CommandLine.Model.ArgGroupSpec.Builder
 
scope - Variable in class picocli.CommandLine.Model.ArgGroupSpec
 
scope - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
scope - Variable in class picocli.CommandLine.Model.ArgSpec
 
scope - Variable in class picocli.CommandLine.Model.FieldBinding
 
scope - Variable in class picocli.CommandLine.Model.MethodBinding
 
scope - Variable in class picocli.CommandLine.Model.TypedMember
 
scope() - Method in class picocli.codegen.annotation.processing.TypedMember
 
scope() - Method in annotation type picocli.CommandLine.Command
Returns whether subcommands inherit their attributes from this parent command.
scope() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the CommandLine.Model.IScope that determines where the setter sets the value (or the getter gets the value) of the annotated program element associated with this group.
scope() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the CommandLine.Model.IScope that determines where the setter sets the value (or the getter gets the value) of the annotated program element associated with this group.
scope() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns the binding CommandLine.Model.IScope that determines the instance of the enclosing element where the setter sets the value (or the getter gets the value) of this argument.
scope() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the binding CommandLine.Model.IScope that determines on which object to set the value (or from which object to get the value) of this argument.
scope() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
scope() - Method in class picocli.CommandLine.Model.TypedMember
 
scope() - Method in annotation type picocli.CommandLine.Option
Determines on which command(s) this option exists: on this command only (the default), or whether this is a "global" option that is applied to this command and all subcommands, sub-subcommands, etc.
scope() - Method in annotation type picocli.CommandLine.Parameters
Determines on which command(s) this positional parameter exists: on this command only (the default), or whether this is a "global" parameter that is applied to this command and all subcommands, sub-subcommands, etc.
scope(CommandLine.Model.IScope) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets the CommandLine.Model.IScope that targets where the setter sets the value of the annotated program element associated with this group, and returns this builder.
scope(CommandLine.Model.IScope) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets the binding CommandLine.Model.IScope that targets where the setter sets the value, and returns this builder.
scopeString() - Method in class picocli.CommandLine.Model.ArgSpec
 
scopeType - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
scopeType - Variable in class picocli.CommandLine.Model.ArgSpec
 
scopeType - Variable in class picocli.CommandLine.Model.CommandSpec
 
scopeType() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns the scope of this argument.
scopeType() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the scope of this argument; it it local, or inherited (it applies to this command as well as all sub- and sub-subcommands).
scopeType() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the scope of this argument; it it local, or inherited (it applies to this command as well as all sub- and sub-subcommands).
scopeType(CommandLine.ScopeType) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets the scope of where this argument applies: only this command, or also all sub (and sub-sub) commands, and returns this builder.
scopeType(CommandLine.ScopeType) - Method in class picocli.CommandLine.Model.CommandSpec
Sets the scope of where this argument applies: only this command, or also all sub (and sub-sub) commands, and returns this builder.
ScopeType() - Constructor for enum picocli.CommandLine.ScopeType
 
SCRIPT_FOOTER - Static variable in class picocli.AutoComplete
 
SCRIPT_HEADER - Static variable in class picocli.AutoComplete
 
sdf - Variable in class picocli.codegen.util.JulLogFormatter
 
SECTION_KEY_AT_FILE_PARAMETER - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the @-file parameter list section.
SECTION_KEY_COMMAND_LIST - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Subcommand List section.
SECTION_KEY_COMMAND_LIST_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Subcommand List Heading section.
SECTION_KEY_DESCRIPTION - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Description section.
SECTION_KEY_DESCRIPTION_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Description Heading section.
SECTION_KEY_END_OF_OPTIONS - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the -- End of Options list section.
SECTION_KEY_EXIT_CODE_LIST - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Exit Code List section.
SECTION_KEY_EXIT_CODE_LIST_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Exit Code List Heading section.
SECTION_KEY_FOOTER - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Footer section.
SECTION_KEY_FOOTER_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Footer Heading section.
SECTION_KEY_HEADER - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Header section.
SECTION_KEY_HEADER_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Header Heading section.
SECTION_KEY_OPTION_LIST - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Option List section.
SECTION_KEY_OPTION_LIST_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Option List Heading section.
SECTION_KEY_PARAMETER_LIST - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Parameter List section.
SECTION_KEY_PARAMETER_LIST_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Parameter List Heading section.
SECTION_KEY_SYNOPSIS - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Synopsis section.
SECTION_KEY_SYNOPSIS_HEADING - Static variable in class picocli.CommandLine.Model.UsageMessageSpec
Section key to control the section renderer for the Synopsis Heading section.
sectionKeys - 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.
sections - Variable in class picocli.CommandLine.Help.Ansi.Text
 
self - Variable in class picocli.CommandLine.HelpCommand
 
self() - Method in class picocli.CommandLine.AbstractHandler
Deprecated.
Returns this to allow method chaining when calling the setters for a fluent API.
self() - Method in class picocli.CommandLine.DefaultExceptionHandler
Deprecated.
 
self() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
 
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
 
SELF - picocli.CommandLine.Spec.Target
Injects the CommandSpec of the command where this @Spec-annotated program element is declared.
sep - Variable in class picocli.CommandLine.Help.DefaultOptionRenderer
 
SEPARATE - picocli.CommandLine.LookBehind
 
separator - Variable in class picocli.CommandLine.Model.ParserSpec
 
separator() - Method in annotation type picocli.CommandLine.Command
String that separates options from option parameters.
separator() - Method in class picocli.CommandLine.Help.DefaultParamLabelRenderer
 
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.
serialVersionUID - Static variable in exception picocli.CommandLine.DuplicateNameException
 
serialVersionUID - Static variable in exception picocli.CommandLine.DuplicateOptionAnnotationsException
 
serialVersionUID - Static variable in exception picocli.CommandLine.ExecutionException
 
serialVersionUID - Static variable in exception picocli.CommandLine.InitializationException
 
serialVersionUID - Static variable in exception picocli.CommandLine.MaxValuesExceededException
 
serialVersionUID - Static variable in exception picocli.CommandLine.MissingParameterException
 
serialVersionUID - Static variable in exception picocli.CommandLine.MissingTypeConverterException
 
serialVersionUID - Static variable in exception picocli.CommandLine.MutuallyExclusiveArgsException
 
serialVersionUID - Static variable in exception picocli.CommandLine.OverwrittenOptionException
 
serialVersionUID - Static variable in exception picocli.CommandLine.ParameterException
 
serialVersionUID - Static variable in exception picocli.CommandLine.ParameterIndexGapException
 
serialVersionUID - Static variable in exception picocli.CommandLine.PicocliException
 
serialVersionUID - Static variable in exception picocli.CommandLine.TypeConversionException
 
serialVersionUID - Static variable in exception picocli.CommandLine.UnmatchedArgumentException
 
set(T) - Method in class picocli.codegen.annotation.processing.AnnotatedElementHolder
This implementation does nothing.
set(T) - Method in class picocli.CommandLine.Model.CommandUserObject
 
set(T) - Method in class picocli.CommandLine.Model.FieldBinding
 
set(T) - Method in interface picocli.CommandLine.Model.ISetter
Sets the new value of the option or positional parameter.
set(T) - Method in class picocli.CommandLine.Model.MethodBinding
 
set(T) - Method in class picocli.CommandLine.Model.ObjectBinding
 
set(T) - Method in class picocli.CommandLine.Model.ObjectScope
 
set(T) - Method in class picocli.CommandLine.Model.PicocliInvocationHandler.ProxyBinding
 
setAbbreviatedOptionsAllowed(boolean) - Method in class picocli.CommandLine
Sets whether abbreviated option names should be matched.
setAbbreviatedSubcommandsAllowed(boolean) - Method in class picocli.CommandLine
Sets whether abbreviated subcommands should be matched.
setAccessible(boolean) - Method in class picocli.CommandLine.Model.MethodParam
 
setAddMethodSubcommands(Boolean) - Method in class picocli.CommandLine.Model.CommandSpec
Sets whether method commands should be added as subcommands.
setAdjustLineBreaksForWideCJKCharacters(boolean) - Method in class picocli.CommandLine.Help.TextTable
 
setAdjustLineBreaksForWideCJKCharacters(boolean) - Method in class picocli.CommandLine
Sets whether line breaks should take wide Chinese, Japanese and Korean characters into account, and returns this UsageMessageSpec.
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).
setBundle(String, ResourceBundle) - Method in class picocli.CommandLine.Model.CommandSpec
 
setCaseInsensitive(boolean) - Method in class picocli.CommandLine.Model.CaseAwareLinkedMap
Sets the case-insensitivity of the map.
setCaseInsensitiveEnumValuesAllowed(boolean) - Method in class picocli.CommandLine
Sets whether the parser should ignore case when converting arguments to enum values.
setColorScheme(CommandLine.Help.ColorScheme) - Method in class picocli.CommandLine
Sets the color scheme to use when printing help.
setCommandName(String) - Method in class picocli.CommandLine
Sets the command name (also called program name) displayed in the usage help synopsis to the specified value.
setDefaultValueProvider(CommandLine.IDefaultValueProvider) - Method in class picocli.CommandLine
Sets a default value provider for the command and sub-commands
setEndOfOptionsDelimiter(String) - Method in class picocli.CommandLine
Sets the end-of-options delimiter that signals that the remaining command line arguments should be treated as positional parameters.
setErr(PrintWriter) - Method in class picocli.CommandLine
Sets the writer to use when printing diagnostic (error) messages during command execution.
setExecutionExceptionHandler(CommandLine.IExecutionExceptionHandler) - Method in class picocli.CommandLine
Sets a custom handler for dealing with exceptions that occurred in the Callable, Runnable or Method user object of a command when the command was executed via the execute method.
setExecutionResult(Object) - Method in class picocli.CommandLine
Sets the result of calling the business logic on the command's user object.
setExecutionStrategy(CommandLine.IExecutionStrategy) - Method in class picocli.CommandLine
Sets the execution strategy that the execute method should use to invoke the business logic on the user objects of this command and/or the user-specified subcommand(s).
setExitCodeExceptionMapper(CommandLine.IExitCodeExceptionMapper) - Method in class picocli.CommandLine
Sets the mapper used by the execute method to map exceptions to exit codes.
setExpandAtFiles(boolean) - Method in class picocli.CommandLine
Sets whether arguments starting with '@' should be treated as the path to an argument file and its contents should be expanded into separate arguments for each line in the specified file.
setHelpFactory(CommandLine.IHelpFactory) - Method in class picocli.CommandLine
Sets a new IHelpFactory to customize the usage help message.
setHelpSectionKeys(List<String>) - Method in class picocli.CommandLine
Sets the section keys in the order that the usage help message should render the sections.
setHelpSectionMap(Map<String, CommandLine.IHelpSectionRenderer>) - Method in class picocli.CommandLine
Sets the map of section keys and renderers used to construct the usage help message.
setInterpolateVariables(boolean) - Method in class picocli.CommandLine
Sets whether whether variables should be interpolated in String values.
setNegatableOptionTransformer(CommandLine.INegatableOptionTransformer) - Method in class picocli.CommandLine
Sets the INegatableOptionTransformer used to create the negative form of negatable options.
setOptionsCaseInsensitive(boolean) - Method in class picocli.CommandLine
Sets whether upper case and lower case should be ignored when matching option names.
setOut(PrintWriter) - Method in class picocli.CommandLine
Sets the writer to use when printing user-requested usage help or version help during command execution.
setOverwrittenOptionsAllowed(boolean) - Method in class picocli.CommandLine
Sets whether options for single-value fields can be specified multiple times on the command line without a CommandLine.OverwrittenOptionException being thrown.
setParameterExceptionHandler(CommandLine.IParameterExceptionHandler) - Method in class picocli.CommandLine
Sets the handler for dealing with invalid user input when the command is executed.
setPosixClusteredShortOptionsAllowed(boolean) - Method in class picocli.CommandLine
Sets whether short options like -x -v -f SomeFile can be clustered together like -xvfSomeFile.
setResourceBundle(ResourceBundle) - Method in class picocli.CommandLine
Sets the ResourceBundle containing usage help message strings.
setSeparator(String) - Method in class picocli.CommandLine
Sets the String the parser uses to separate option names from option values to the specified value.
setSplitQuotedStrings(boolean) - Method in class picocli.CommandLine
Deprecated.
Most applications should not change the default. The rare application that does need to split parameter values without respecting quotes should use CommandLine.Model.ParserSpec.splitQuotedStrings(boolean).
setStopAtPositional(boolean) - Method in class picocli.CommandLine
Sets whether the parser interprets the first positional parameter as "end of options" so the remaining arguments are all treated as positional parameters.
setStopAtUnmatched(boolean) - Method in class picocli.CommandLine
Sets whether the parser should stop interpreting options and positional parameters as soon as it encounters an unmatched option.
setSubcommandsCaseInsensitive(boolean) - Method in class picocli.CommandLine
Sets whether upper case and lower case should be ignored when matching subcommands.
setter - Variable in class picocli.codegen.annotation.processing.TypedMember
 
setter - Variable in class picocli.CommandLine.Model.ArgGroupSpec.Builder
 
setter - Variable in class picocli.CommandLine.Model.ArgGroupSpec
 
setter - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
setter - Variable in class picocli.CommandLine.Model.ArgSpec
 
setter - Variable in class picocli.CommandLine.Model.TypedMember
 
setter - Variable in class picocli.CommandLine.Model.UnmatchedArgsBinding
 
setter() - Method in class picocli.codegen.annotation.processing.TypedMember
 
setter() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the CommandLine.Model.ISetter that is responsible for modifying the value of the annotated program element associated with this group.
setter() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the CommandLine.Model.ISetter that is responsible for modifying the value of the annotated program element associated with this group.
setter() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns the CommandLine.Model.ISetter that is responsible for modifying the value of this argument.
setter() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the CommandLine.Model.ISetter that is responsible for modifying the value of this argument.
setter() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
setter() - Method in class picocli.CommandLine.Model.TypedMember
 
setter() - Method in class picocli.CommandLine.Model.UnmatchedArgsBinding
Returns the setter responsible for consuming the unmatched arguments.
setter(CommandLine.Model.ISetter) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets the CommandLine.Model.ISetter that is responsible for modifying the value of the annotated program element associated with this group, and returns this builder.
setter(CommandLine.Model.ISetter) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets the CommandLine.Model.ISetter that is responsible for modifying the value of this argument, and returns this builder.
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.
setTypeInfo(CommandLine.Model.ITypeInfo) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
 
setUnmatchedArgumentsAllowed(boolean) - Method in class picocli.CommandLine
Sets whether the end user may specify unmatched arguments on the command line without a CommandLine.UnmatchedArgumentException being thrown.
setUnmatchedOptionsAllowedAsOptionParameters(boolean) - Method in class picocli.CommandLine
Sets whether options can have parameter values that resemble an option, or whether such values should be rejected as unknown options.
setUnmatchedOptionsArePositionalParams(boolean) - Method in class picocli.CommandLine
Sets whether arguments on the command line that resemble an option should be treated as positional parameters.
setUsageHelpAutoWidth(boolean) - Method in class picocli.CommandLine
Sets whether picocli should attempt to detect the terminal size and adjust the usage help message width to take the full terminal width.
setUsageHelpLongOptionsMaxWidth(int) - Method in class picocli.CommandLine
Returns the maximum usage help long options column max width to the specified value.
setUsageHelpWidth(int) - Method in class picocli.CommandLine
Sets the maximum width of the usage help message.
setUserObject(Object, CommandLine.IFactory) - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
setUseSimplifiedAtFiles(boolean) - Method in class picocli.CommandLine
Sets whether to use a simplified argument file format that is compatible with JCommander.
setValue(T) - Method in class picocli.CommandLine.Model.ArgSpec
Sets the value of this argument to the specified value and returns the previous value.
setValue(T, CommandLine) - Method in class picocli.CommandLine.Model.ArgSpec
Deprecated.
use CommandLine.Model.ArgSpec.setValue(Object) instead. This was a design mistake.
ShortConverter() - Constructor for class picocli.CommandLine.BuiltIn.ShortConverter
 
shortestFirst() - Static method in class picocli.CommandLine.Help
Sorts short strings before longer strings.
ShortestFirst() - Constructor for class picocli.codegen.docgen.manpage.ManPageGenerator.ShortestFirst
 
ShortestFirst() - Constructor for class picocli.CommandLine.Help.ShortestFirst
 
shortestName() - Method in class picocli.CommandLine.Model.OptionSpec
Returns the shortest option name.
shouldDetectTerminalSize(boolean) - Static method in class picocli.CommandLine.Model.UsageMessageSpec
 
shouldTrimQuotes() - Method in class picocli.CommandLine.Model.ParserSpec
 
showAtFileInUsageHelp - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
showAtFileInUsageHelp() - Method in annotation type picocli.CommandLine.Command
Specify true to show a [@<filename>...] entry in the synopsis and parameter list of the usage help message.
showAtFileInUsageHelp() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets whether to show a [@<filename>...] entry in the synopsis and parameter list of the usage help message.
showAtFileInUsageHelp(boolean) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets whether to show a [@<filename>...] entry in the synopsis and parameter list of the usage help message.
showDefaultValue - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
showDefaultValue - Variable in class picocli.CommandLine.Model.ArgSpec
 
showDefaultValue() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns whether this option or positional parameter's default value should be shown in the usage help.
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.
showDefaultValue() - Method in annotation type picocli.CommandLine.Option
Use this attribute to control for a specific option whether its default value should be shown in the usage help message.
showDefaultValue() - Method in annotation type picocli.CommandLine.Parameters
Use this attribute to control for a specific positional parameter whether its default value should be shown in the usage help message.
showDefaultValue(CommandLine.Help.Visibility) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets whether this option or positional parameter's default value should be shown in the usage help, and returns this builder.
showDefaultValues - Variable in class picocli.CommandLine.Help.DefaultOptionRenderer
 
showDefaultValues - Variable in class picocli.CommandLine.Help.DefaultParameterRenderer
 
showDefaultValues - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
showDefaultValues() - Method in annotation type picocli.CommandLine.Command
Specify true to show default values in the description column of the options list (except for boolean options).
showDefaultValues() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns whether the options list in the usage help message should show default values for all non-boolean options.
showDefaultValues(boolean) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets whether the options list in the usage help message should show default values for all non-boolean options.
showEndOfOptionsDelimiterInUsageHelp - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
showEndOfOptionsDelimiterInUsageHelp() - Method in annotation type picocli.CommandLine.Command
Specify true to show a [--] "End of options" entry in the synopsis and option list of the usage help message.
showEndOfOptionsDelimiterInUsageHelp() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets whether to show a [--] (End of Options) entry in the synopsis and options list of the usage help message.
showEndOfOptionsDelimiterInUsageHelp(boolean) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets whether to show a [--] (End of Options) entry in the synopsis and options list of the usage help message.
similarity(String, String, int) - Static method in class picocli.CommandLine.CosineSimilarity
 
simplifyErrorMessageForSingleGroup(Map<CommandLine.Model.ArgGroupSpec, List<List<CommandLine.ParseResult.GroupMatch>>>, CommandLine) - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
size() - Method in class picocli.CommandLine.Model.CaseAwareLinkedMap.CaseAwareKeySet
 
size() - Method in class picocli.CommandLine.Model.CaseAwareLinkedMap
 
size() - Method in class picocli.CommandLine.Range
 
smartUnquote(String) - Static method in class picocli.CommandLine
 
smartUnquoteIfEnabled(String) - Method in class picocli.CommandLine
Return the unquoted value if the value contains no nested quotes, otherwise, return the value as is.
SOFTWARE - Static variable in class picocli.CommandLine.ExitCode
Return value from the execute method signifying internal software error: an exception occurred when invoking the Runnable, Callable or Method user object of a command.
sort(String[]) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator.ShortestFirst
Sorts the specified array of Strings shortest-first and returns it.
sort(String[]) - Static method in class picocli.CommandLine.Help.ShortestFirst
Sorts the specified array of Strings shortest-first and returns it.
SortByOptionArityAndNameAlphabetically() - Constructor for class picocli.CommandLine.Help.SortByOptionArityAndNameAlphabetically
 
SortByOrder() - Constructor for class picocli.codegen.docgen.manpage.ManPageGenerator.SortByOrder
 
SortByOrder() - Constructor for class picocli.CommandLine.Help.SortByOrder
 
SortByShortestOptionNameAlphabetically() - Constructor for class picocli.codegen.docgen.manpage.ManPageGenerator.SortByShortestOptionNameAlphabetically
 
SortByShortestOptionNameAlphabetically() - Constructor for class picocli.CommandLine.Help.SortByShortestOptionNameAlphabetically
 
sortOptions - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
sortOptions() - Method in annotation type picocli.CommandLine.Command
Specify false to show Options in declaration order.
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.
spaces(int) - Static method in class picocli.CommandLine.Help
 
SPAN - picocli.CommandLine.Help.Column.Overflow
 
spec - Variable in class picocli.AutoComplete.App
 
spec - Variable in class picocli.AutoComplete.GenerateCompletion
 
spec - Variable in class picocli.codegen.docgen.manpage.ManPageGenerator
 
spec - Variable in class picocli.CommandLine.Model.Messages
 
spec - Variable in class picocli.CommandLine.Model.MethodBinding
 
spec - Variable in class picocli.shell.jline2.PicocliJLineCompleter
 
specElements - Variable in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Context
 
specElements - Variable in class picocli.CommandLine.Model.ArgGroupSpec.Builder
 
specElements - Variable in class picocli.CommandLine.Model.ArgGroupSpec
 
specElements - Variable in class picocli.CommandLine.Model.CommandSpec
 
specElements() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the list of program elements annotated with {@literal @}Spec configured for this group.
specElements() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the list of program elements annotated with {@literal @}Spec configured for this group.
specElements() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the list of program elements annotated with {@literal @}Spec configured for this command.
split() - Method in annotation type picocli.CommandLine.Option
Specify a regular expression to use to split option parameter values before applying them to the field.
split() - Method in annotation type picocli.CommandLine.Parameters
Specify a regular expression to use to split positional parameter values before applying them to the field.
splitFirst() - Method in class picocli.CommandLine.Model.ParserSpec
 
splitIntoChunks(String, boolean) - Static method in class picocli.CommandLine.AbbreviationMatcher
 
splitKeyValue(CommandLine.Model.ArgSpec, String) - Method in class picocli.CommandLine.Interpreter
 
splitLines() - Method in class picocli.CommandLine.Help.Ansi.Text
 
splitQuotedStrings - Variable in class picocli.CommandLine.Model.ParserSpec
 
splitQuotedStrings() - Method in class picocli.CommandLine.Model.ParserSpec
 
splitQuotedStrings(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
splitRegex - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
splitRegex - Variable in class picocli.CommandLine.Model.ArgSpec
 
splitRegex() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns a regular expression to split option parameter values or "" if the value should not be split.
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.
splitRegex(String) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets a regular expression to split option parameter values or "" if the value should not be split, and returns this builder.
splitRegexSynopsisLabel - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
splitRegexSynopsisLabel - Variable in class picocli.CommandLine.Model.ArgSpec
 
splitRegexSynopsisLabel() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns a regular expression to split option parameter for usage information.
splitRegexSynopsisLabel() - Method in class picocli.CommandLine.Model.ArgSpec
Returns a regular expression to split option parameter for usage information.
splitRegexSynopsisLabel(String) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets a regular expression to split option parameter for usage information.
splitRespectingQuotedStrings(String, int, CommandLine.Model.ParserSpec, CommandLine.Model.ArgSpec, String) - Static method in class picocli.CommandLine.Model.ArgSpec
 
splitSynopsisLabel() - Method in annotation type picocli.CommandLine.Option
Specify the string to display for the split regular expression in the usage help synopsis.
splitSynopsisLabel() - Method in annotation type picocli.CommandLine.Parameters
Specify a string to show the split option parameter values in usage
splitValue(String, CommandLine.Model.ParserSpec, CommandLine.Range, int) - Method in class picocli.CommandLine.Model.ArgSpec
 
stack(String) - Method in class picocli.CommandLine.Interpreter
 
stacktrace(Exception) - Static method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
stacktrace(Exception) - Static method in class picocli.codegen.aot.graalvm.processor.ProcessorUtil
 
stackTraces(CommandLine.Help.Ansi.IStyle...) - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Adds the specified styles to the registered styles for stack traces in this color scheme builder and returns this builder.
stackTraceStyles - Variable in class picocli.CommandLine.Help.ColorScheme.Builder
 
stackTraceStyles - Variable in class picocli.CommandLine.Help.ColorScheme
 
stackTraceStyles() - Method in class picocli.CommandLine.Help.ColorScheme.Builder
Returns the registered styles for stack traces in this color scheme builder.
stackTraceStyles() - Method in class picocli.CommandLine.Help.ColorScheme
Returns the registered styles for stack traces in this color scheme.
stackTraceText(String) - Method in class picocli.CommandLine.Help.ColorScheme
Returns a Text with all stackTrace styles applied to all lines in the specified stackTrace string.
stackTraceText(Throwable) - Method in class picocli.CommandLine.Help.ColorScheme
Returns a Text with all stackTrace styles applied to all lines in the stack trace of the specified Throwable.
startCode - Variable in enum picocli.CommandLine.Help.Ansi.Style
 
startIndex - Variable in class picocli.CommandLine.Help.Ansi.StyledSection
 
startPosition - Variable in class picocli.CommandLine.ParseResult.GroupMatch
 
startStyles - Variable in class picocli.CommandLine.Help.Ansi.StyledSection
 
startsWith(String, String, boolean) - Static method in class picocli.CommandLine.AbbreviationMatcher
 
stopAtPositional - Variable in class picocli.CommandLine.Model.ParserSpec
 
stopAtPositional() - Method in class picocli.CommandLine.Model.ParserSpec
 
stopAtPositional(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
stopAtUnmatched - Variable in class picocli.CommandLine.Model.ParserSpec
 
stopAtUnmatched() - Method in class picocli.CommandLine.Model.ParserSpec
 
stopAtUnmatched(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
str(String[], int) - Static method in class picocli.CommandLine
 
str(String, String, String) - Method in class picocli.CommandLine.Model.UsageMessageSpec
 
str(List<String>) - Static method in exception picocli.CommandLine.UnmatchedArgumentException
 
stream - Variable in class picocli.CommandLine.Tracer
 
string(String) - Method in enum picocli.CommandLine.Help.Ansi
Returns a String where any markup like @|bg(red),white,underline some text|@ is converted to ANSI escape codes if this Ansi is ON, or suppressed if this Ansi is OFF.
string(String) - Method in class picocli.CommandLine.Help.ColorScheme
Returns a String where any markup like @|bg(red),white,underline some text|@ is converted to the styles defined in this ColorScheme (if its Ansi mode is ON), or to the plain text without the markup (if this ColorScheme's Ansi mode is OFF).
StringBuilderConverter() - Constructor for class picocli.CommandLine.BuiltIn.StringBuilderConverter
 
StringConverter() - Constructor for class picocli.CommandLine.BuiltIn.StringConverter
 
stringOf(char, int) - Static method in class picocli.CommandLine.Help
 
stringValues - Variable in class picocli.CommandLine.Model.ArgSpec
 
stringValues() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the untyped command line arguments matched by this option or positional parameter spec.
stripErrorMessage(List<String>) - Static method in exception picocli.CommandLine.UnmatchedArgumentException
 
stripPrefix(String) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
stripPrefix(String) - Static method in class picocli.CommandLine.Model.CommandSpec
 
stripPrefix(String) - Static method in class picocli.CommandLine.PropertiesDefaultProvider
 
Style(int, int) - Constructor for enum picocli.CommandLine.Help.Ansi.Style
 
StyledSection(int, int, String, String) - Constructor for class picocli.CommandLine.Help.Ansi.StyledSection
 
subcommand() - Method in class picocli.CommandLine.ParseResult
Returns the ParseResult for the last subcommand of this command that was matched on the command line, or null if no subcommand was matched.
subcommand(CommandLine.ParseResult) - Method in class picocli.CommandLine.ParseResult.Builder
Sets the specified ParseResult for a subcommand that was matched on the command line.
subcommandName(Class<?>) - Static method in class picocli.CommandLine.Model.CommandReflection
 
subcommands - Variable in class picocli.CommandLine.ParseResult.Builder
 
subcommands - Variable in class picocli.CommandLine.ParseResult
 
subcommands() - Method in annotation type picocli.CommandLine.Command
A list of classes to instantiate and register as subcommands.
subcommands() - Method in class picocli.CommandLine.Help
Returns the map of non-hidden subcommand Help instances for this command Help.
subcommands() - Method in class picocli.CommandLine.Model.CommandSpec
Returns a read-only view of the subcommand map.
subcommands() - Method in class picocli.CommandLine.ParseResult
Returns a list with the ParseResult objects for each subcommand of this command that was matched on the command line or an empty list if no subcommands were matched.
subcommandsCaseInsensitive() - Method in class picocli.CommandLine.Model.CommandSpec
Returns whether the subcommands are case-insensitive.
subcommandsCaseInsensitive(boolean) - Method in class picocli.CommandLine.Model.CommandSpec
Sets the case-insensitivity of subcommands.
subcommandsRepeatable - Variable in class picocli.CommandLine.Model.CommandSpec
 
subcommandsRepeatable() - Method in annotation type picocli.CommandLine.Command
Returns whether the subcommands of this command are repeatable, that is, whether such subcommands can occur multiple times and may be followed by sibling commands instead of only by child commands of the subcommand.
subcommandsRepeatable() - Method in class picocli.CommandLine.Model.CommandSpec
Returns whether the subcommands of this command are repeatable, that is, whether such subcommands can occur multiple times and may be followed by sibling commands instead of just child commands.
subcommandsRepeatable(boolean) - Method in class picocli.CommandLine.Model.CommandSpec
Sets whether the subcommands of this command are repeatable, that is, whether such subcommands can occur multiple times and may be followed by sibling commands instead of just child commands.
subgroups - Variable in class picocli.CommandLine.Model.ArgGroupSpec.Builder
 
subgroups - Variable in class picocli.CommandLine.Model.ArgGroupSpec
 
subgroups() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the list of subgroups that this group is composed of.
subgroups() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Return the subgroups that this group is composed of; may be empty but not null.
substring(int) - Method in class picocli.CommandLine.Help.Ansi.Text
Returns a new Text instance that is a substring of this Text.
substring(int, int) - Method in class picocli.CommandLine.Help.Ansi.Text
Returns a new Text instance that is a substring of this Text.
success() - Method in class picocli.CommandLine.ParseResult.GroupValidationResult
 
SUCCESS_ABSENT - picocli.CommandLine.ParseResult.GroupValidationResult.Type
 
SUCCESS_ABSENT - Static variable in class picocli.CommandLine.ParseResult.GroupValidationResult
 
SUCCESS_PRESENT - picocli.CommandLine.ParseResult.GroupValidationResult.Type
 
SUCCESS_PRESENT - Static variable in class picocli.CommandLine.ParseResult.GroupValidationResult
 
superClassFor(TypeElement) - Static method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
Obtains the super type element for a given type element.
synopsis - Variable in class picocli.CommandLine.RegexTransformer.Builder
 
synopsis - Variable in class picocli.CommandLine.RegexTransformer
 
synopsis() - Method in class picocli.CommandLine.Help
Deprecated.
synopsis() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the synopsis of this group.
synopsis(int) - Method in class picocli.CommandLine.Help
Returns a synopsis for the command, reserving the specified space for the synopsis heading.
synopsisAutoIndentThreshold - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
synopsisAutoIndentThreshold() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the fraction of the usage help CommandLine.Model.UsageMessageSpec.width() that is the threshold up to which the 2nd line and subsequent lines of a multi-line synopsis should be aligned to the end of the command name.
synopsisAutoIndentThreshold(double) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the fraction of the usage help CommandLine.Model.UsageMessageSpec.width() that is the threshold up to which the 2nd line and subsequent lines of a multi-line synopsis should be aligned to the end of the command name.
synopsisHeading - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
synopsisHeading() - Method in annotation type picocli.CommandLine.Command
Set the heading preceding the synopsis text.
synopsisHeading() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the optional heading preceding the synopsis.
synopsisHeading(Object...) - Method in class picocli.CommandLine.Help
Returns the text displayed before the synopsis text; the result of String.format(synopsisHeading, params).
synopsisHeading(String) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the optional heading preceding the synopsis.
synopsisHeadingLength() - Method in class picocli.CommandLine.Help
Returns the number of characters the synopsis heading will take on the same line as the synopsis.
synopsisIndent - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
synopsisIndent() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the indentation to use on the 2nd line and subsequent lines of a multi-line synopsis when the length of the synopsis heading and the fully qualified command name exceed the CommandLine.Model.UsageMessageSpec.width() times the CommandLine.Model.UsageMessageSpec.synopsisAutoIndentThreshold(), -1 by default.
synopsisIndent(int) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the indentation to use on the 2nd line and subsequent lines of a multi-line synopsis when the length of the synopsis heading and the fully qualified command name exceed the CommandLine.Model.UsageMessageSpec.synopsisAutoIndentThreshold() fraction of the CommandLine.Model.UsageMessageSpec.width(), -1 by default.
synopsisSubcommandLabel - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
synopsisSubcommandLabel() - Method in annotation type picocli.CommandLine.Command
Specify the String to show in the synopsis for the subcommands of this command.
synopsisSubcommandLabel() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the String representing the subcommands in the synopsis.
synopsisSubcommandLabel(String) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the String representing the subcommands in the synopsis.
synopsisText(CommandLine.Help.ColorScheme, Set<CommandLine.Model.ArgSpec>) - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the synopsis of this group.
synopsisUnit() - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
synopsisUnitText(CommandLine.Help.ColorScheme, CommandLine.Help.Ansi.Text) - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
SYSPROP_CODEGEN_EXCLUDES - Static variable in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator
 
syspropDefinedAndNotFalse(String) - Static method in class picocli.AutoComplete
 

T

table - Variable in class picocli.CommandLine.Help.Layout
 
tableWidth - Variable in class picocli.CommandLine.Help.TextTable
 
Target() - Constructor for enum picocli.CommandLine.Spec.Target
 
targetMap - Variable in class picocli.CommandLine.Model.CaseAwareLinkedMap
 
templatesDirectory - Variable in class picocli.codegen.docgen.manpage.ManPageGenerator.Config
 
tentativeMatch - Variable in class picocli.CommandLine.ParseResult
 
test(CommandLine.Model.ArgSpec) - Method in class picocli.AutoComplete.BooleanArgFilter
 
test(T) - Method in interface picocli.AutoComplete.Predicate
 
test(T) - Method in interface picocli.CommandLine.Model.Predicate
 
text(String) - Method in enum picocli.CommandLine.Help.Ansi
Returns a new Text object for this Ansi mode, encapsulating the specified string which may contain markup like @|bg(red),white,underline some text|@.
text(String) - Method in class picocli.CommandLine.Help.ColorScheme
Returns a new Text object for this ColorScheme, encapsulating the specified string which may contain markup like @|bg(red),white,underline some text|@.
Text(int) - Constructor for class picocli.CommandLine.Help.Ansi.Text
Constructs a Text with the specified max length (for use in a TextTable Column).
Text(int, CommandLine.Help.ColorScheme) - Constructor for class picocli.CommandLine.Help.Ansi.Text
Constructs a Text with the specified max length (for use in a TextTable Column).
Text(String) - Constructor for class picocli.CommandLine.Help.Ansi.Text
Constructs a Text with the specified String, which may contain markup like @|bg(red),white,underline some text|@.
Text(String, CommandLine.Help.ColorScheme) - Constructor for class picocli.CommandLine.Help.Ansi.Text
Constructs a Text with the specified String (which may contain markup), and ColorScheme.
Text(CommandLine.Help.Ansi.Text) - Constructor for class picocli.CommandLine.Help.Ansi.Text
Copy constructor.
textAt(int, int) - Method in class picocli.CommandLine.Help.TextTable
Returns the Text slot at the specified row and column to write a text value into.
textTable() - Method in class picocli.CommandLine.Help.Layout
Returns the TextTable used in this layout.
TextTable(CommandLine.Help.Ansi, CommandLine.Help.Column[]) - Constructor for class picocli.CommandLine.Help.TextTable
TextTable(CommandLine.Help.ColorScheme, CommandLine.Help.Column[]) - Constructor for class picocli.CommandLine.Help.TextTable
 
throwableToColorString(Throwable, CommandLine.Help.ColorScheme) - Static method in class picocli.CommandLine
Convert a Throwable to a String , with message and stack traces extracted and colored according to ColorScheme.
throwOrExit(CommandLine.ExecutionException) - Method in class picocli.CommandLine.AbstractHandler
Deprecated.
Convenience method for subclasses that throws the specified ExecutionException if no exit code was set, or otherwise, if an exit code was set, prints the stacktrace of the specified exception to the diagnostic error stream and calls System.exit with the configured exit code to terminate the currently running Java virtual machine.
TimeZoneConverter() - Constructor for class picocli.CommandLine.BuiltIn.TimeZoneConverter
 
toBuilder() - Method in class picocli.CommandLine.Model.OptionSpec
Returns a new Builder initialized with the attributes from this OptionSpec.
toBuilder() - Method in class picocli.CommandLine.Model.PositionalParamSpec
Returns a new Builder initialized with the attributes from this PositionalParamSpec.
toCommandLine(Object, CommandLine.IFactory) - Static method in class picocli.CommandLine
 
toGenericString() - Method in class picocli.codegen.annotation.processing.TypedMember
 
toGenericString() - Method in class picocli.CommandLine.Model.TypedMember
 
toggleBooleanFlags - Variable in class picocli.CommandLine.Model.ParserSpec
 
toggleBooleanFlags() - Method in class picocli.CommandLine.Model.ParserSpec
 
toggleBooleanFlags(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
toLowerCase(Object) - Method in class picocli.CommandLine.Model.CaseAwareLinkedMap
 
topologicalSort() - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Graph
 
topologicalSortDone - Variable in class picocli.CommandLine.Model.ArgGroupSpec.Builder
 
topologicalSortUtil(int, boolean[], Stack<Integer>) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Graph
 
toString - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
toString - Variable in class picocli.CommandLine.Model.ArgSpec
 
toString - Variable in class picocli.CommandLine.Model.CommandSpec
 
toString() - Method in class picocli.codegen.annotation.processing.AnnotatedElementHolder
Returns a string representation of this binding, for debugging purposes.
toString() - Method in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
toString() - Method in class picocli.codegen.annotation.processing.CompletionCandidatesMetaData
Returns a string representation of this object, for debugging purposes.
toString() - Method in class picocli.codegen.annotation.processing.DefaultValueProviderMetaData
Returns a string representation of this object, for debugging purposes.
toString() - Method in class picocli.codegen.annotation.processing.ParameterConsumerMetaData
Returns a string representation of this object, for debugging purposes.
toString() - Method in class picocli.codegen.annotation.processing.TypeConverterMetaData
Returns a string representation of this object, for debugging purposes.
toString() - Method in class picocli.codegen.annotation.processing.TypedMember
 
toString() - Method in class picocli.codegen.annotation.processing.VersionProviderMetaData
Returns a string representation of this object, for debugging purposes.
toString() - Method in class picocli.codegen.aot.graalvm.DynamicProxyConfigGenerator.Visitor
 
toString() - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedClass
 
toString() - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedField
 
toString() - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.ReflectedMethod
 
toString() - Method in class picocli.codegen.aot.graalvm.ResourceConfigGenerator.Visitor
 
toString() - Method in class picocli.CommandLine.Help.Ansi.Text
Returns a String representation of the text with ANSI escape codes embedded, unless ANSI is CommandLine.Help.Ansi.enabled() not enabled}, in which case the plain text is returned.
toString() - Method in class picocli.CommandLine.Help.ColorScheme
 
toString() - Method in class picocli.CommandLine.Help.Column
 
toString() - Method in class picocli.CommandLine.Help.Layout
Returns the section of the usage help message accumulated in the TextTable owned by this layout.
toString() - Method in class picocli.CommandLine.Help.TextTable
 
toString() - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
toString() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
 
toString() - Method in class picocli.CommandLine.Model.ArgSpec
Returns a string respresentation of this option or positional parameter.
toString() - Method in class picocli.CommandLine.Model.CommandSpec
Returns a string representation of this command, used in error messages and trace messages.
toString() - Method in class picocli.CommandLine.Model.CommandUserObject
 
toString() - Method in class picocli.CommandLine.Model.FieldBinding
 
toString() - Method in class picocli.CommandLine.Model.MethodBinding
 
toString() - Method in class picocli.CommandLine.Model.MethodParam
 
toString() - Method in class picocli.CommandLine.Model.ObjectBinding
 
toString() - Method in class picocli.CommandLine.Model.ObjectScope
 
toString() - Method in class picocli.CommandLine.Model.ParserSpec
 
toString() - Method in class picocli.CommandLine.Model.RuntimeTypeInfo
 
toString() - Method in class picocli.CommandLine.Model.TypedMember
 
toString() - Method in class picocli.CommandLine.ParseResult.GroupMatch
 
toString() - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
toString() - Method in class picocli.CommandLine.ParseResult.GroupValidationResult
 
toString() - Method in class picocli.CommandLine.PropertiesDefaultProvider
 
toString() - Method in class picocli.CommandLine.Range
 
toString() - Method in class picocli.CommandLine.RegexTransformer
 
toString(String) - Method in enum picocli.CommandLine.LookBehind
 
toString(StringBuilder) - Method in class picocli.CommandLine.Help.TextTable
Copies the text representation that we built up from the options into the specified StringBuilder.
toString(StringBuilder) - Method in class picocli.CommandLine.ParseResult.GroupMatch
 
toString(StringBuilder) - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
totalArgCount() - Method in class picocli.CommandLine.ParseResult.Builder
 
traceAllSpecs(CommandLine.Model.CommandSpec[], ManPageGenerator.Config) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
traced - Static variable in class picocli.CommandLine.BuiltIn
 
TraceLevel() - Constructor for enum picocli.CommandLine.TraceLevel
 
tracer - Variable in class picocli.CommandLine
 
Tracer() - Constructor for class picocli.CommandLine.Tracer
 
transform(CommandLine.Model.CommandSpec) - Method in interface picocli.CommandLine.IModelTransformer
Given an original CommandSpec, return the object that should be used instead.
transform(CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.NoOpModelTransformer
 
trim() - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
trimLineSeparator(String) - Static method in class picocli.CommandLine.Help
 
trimQuotes - Variable in class picocli.CommandLine.Model.ParserSpec
 
trimQuotes() - Method in class picocli.CommandLine.Model.ParserSpec
 
trimQuotes(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
TRUNCATE - picocli.CommandLine.Help.Column.Overflow
 
tryConvert(CommandLine.Model.ArgSpec, int, CommandLine.ITypeConverter<?>, String, int) - Method in class picocli.CommandLine.Interpreter
 
tryGet(CommandLine.Model.IScope) - Static method in class picocli.CommandLine.Model.ObjectScope
 
tryInitUserObject(CommandLine) - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
tryProcess(Set<? extends TypeElement>, RoundEnvironment) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
tty - Static variable in enum picocli.CommandLine.Help.Ansi
 
type - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
type - Variable in class picocli.CommandLine.Model.CommandUserObject
 
type - Variable in class picocli.CommandLine.Model.RuntimeTypeInfo
 
type - Variable in class picocli.CommandLine.ParseResult.GroupValidationResult
 
type() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns the type to convert the option or positional parameter to before setting the value.
type() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the type to convert the option or positional parameter to before setting the value.
type() - Method in annotation type picocli.CommandLine.Option
Optionally specify a type to control exactly what Class the option parameter should be converted to.
type() - Method in annotation type picocli.CommandLine.Parameters
Optionally specify a type to control exactly what Class the positional parameter should be converted to.
type(Class<?>) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets the type to convert the option or positional parameter to before setting the value, and returns this builder.
Type() - Constructor for enum picocli.CommandLine.ParseResult.GroupValidationResult.Type
 
TypeConversionException(String) - Constructor for exception picocli.CommandLine.TypeConversionException
Constructs a TypeConversionException.
TypeConverterMetaData - Class in picocli.codegen.annotation.processing
Implementation of the CommandLine.ITypeConverter interface that provides metadata on the @Command(typeConverter = xxx.class) annotation.
TypeConverterMetaData(TypeMirror) - Constructor for class picocli.codegen.annotation.processing.TypeConverterMetaData
 
TypedMember - Class in picocli.codegen.annotation.processing
 
TypedMember(Field) - Constructor for class picocli.CommandLine.Model.TypedMember
 
TypedMember(Field, CommandLine.Model.IScope) - Constructor for class picocli.CommandLine.Model.TypedMember
 
TypedMember(Method, CommandLine.Model.IScope, CommandLine.Model.CommandSpec) - Constructor for class picocli.CommandLine.Model.TypedMember
 
TypedMember(ExecutableElement, AbstractCommandSpecProcessor) - Constructor for class picocli.codegen.annotation.processing.TypedMember
 
TypedMember(VariableElement, int) - Constructor for class picocli.codegen.annotation.processing.TypedMember
 
TypedMember(CommandLine.Model.MethodParam, CommandLine.Model.IScope) - Constructor for class picocli.CommandLine.Model.TypedMember
 
typedValueAtPosition - Variable in class picocli.CommandLine.Model.ArgSpec
 
typedValues - Variable in class picocli.CommandLine.Model.ArgSpec
 
typedValues() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the typed command line arguments matched by this option or positional parameter spec.
typeElement - Variable in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
typeInfo - Variable in class picocli.codegen.annotation.processing.TypedMember
 
typeInfo - Variable in class picocli.CommandLine.Model.ArgGroupSpec.Builder
 
typeInfo - Variable in class picocli.CommandLine.Model.ArgGroupSpec
 
typeInfo - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
typeInfo - Variable in class picocli.CommandLine.Model.ArgSpec
 
typeInfo - Variable in class picocli.CommandLine.Model.TypedMember
 
typeInfo() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns the type info for the annotated program element associated with this group.
typeInfo() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns the type info for the annotated program element associated with this group.
typeInfo() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns the type info for this option or positional parameter.
typeInfo() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the ITypeInfo that can be used both at compile time (by annotation processors) and at runtime.
typeInfo(CommandLine.Model.ITypeInfo) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets the type info for the annotated program element associated with this group, and returns this builder.
typeInfo(CommandLine.Model.ITypeInfo) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets the type info for this option or positional parameter, and returns this builder.
typeMirror - Variable in class picocli.codegen.annotation.processing.CompileTimeTypeInfo
 
typeMirror - Variable in class picocli.codegen.annotation.processing.CompletionCandidatesMetaData
 
typeMirror - Variable in class picocli.codegen.annotation.processing.DefaultValueProviderMetaData
 
typeMirror - Variable in class picocli.codegen.annotation.processing.ParameterConsumerMetaData
 
typeMirror - Variable in class picocli.codegen.annotation.processing.TypeConverterMetaData
 
typeMirror - Variable in class picocli.codegen.annotation.processing.VersionProviderMetaData
 
TypeUtil - Class in picocli.codegen.annotation.processing
 
TypeUtil() - Constructor for class picocli.codegen.annotation.processing.TypeUtil
 

U

UNAVAILABLE - picocli.CommandLine.Model.InitialValueState
 
underline - picocli.CommandLine.Help.Ansi.Style
 
unindent(CommandLine.Help.Ansi.Text[]) - Method in class picocli.CommandLine.Help.TextTable
 
unmatched - Variable in class picocli.CommandLine.ParseResult.Builder
 
unmatched - Variable in class picocli.CommandLine.ParseResult
 
unmatched - Variable in exception picocli.CommandLine.UnmatchedArgumentException
 
unmatched() - Method in class picocli.CommandLine.ParseResult
Returns a list of command line arguments that did not match any options or positional parameters.
unmatchedArgs - Variable in class picocli.CommandLine.Model.CommandSpec
 
UnmatchedArgsBinding(CommandLine.Model.IGetter, CommandLine.Model.ISetter) - Constructor for class picocli.CommandLine.Model.UnmatchedArgsBinding
 
unmatchedArgsBindings() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the list of UnmatchedArgumentsBindings configured for this command; each UnmatchedArgsBinding captures the arguments that could not be matched to any options or positional parameters.
UnmatchedArgumentException(CommandLine, String) - Constructor for exception picocli.CommandLine.UnmatchedArgumentException
 
UnmatchedArgumentException(CommandLine, List<String>) - Constructor for exception picocli.CommandLine.UnmatchedArgumentException
 
UnmatchedArgumentException(CommandLine, List<String>, String) - Constructor for exception picocli.CommandLine.UnmatchedArgumentException
 
UnmatchedArgumentException(CommandLine, Stack<String>) - Constructor for exception picocli.CommandLine.UnmatchedArgumentException
 
unmatchedArgumentsAllowed - Variable in class picocli.CommandLine.Model.ParserSpec
 
unmatchedArgumentsAllowed() - Method in class picocli.CommandLine.Model.ParserSpec
 
unmatchedArgumentsAllowed(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
unmatchedElements - Variable in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Context
 
unmatchedOptionsAllowedAsOptionParameters - Variable in class picocli.CommandLine.Model.ParserSpec
 
unmatchedOptionsAllowedAsOptionParameters() - Method in class picocli.CommandLine.Model.ParserSpec
 
unmatchedOptionsAllowedAsOptionParameters(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
unmatchedOptionsArePositionalParams - Variable in class picocli.CommandLine.Model.ParserSpec
 
unmatchedOptionsArePositionalParams() - Method in class picocli.CommandLine.Model.ParserSpec
 
unmatchedOptionsArePositionalParams(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
unmatchedSubgroups - Variable in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
unquote(String) - Static method in class picocli.CommandLine
 
unquoteAndSplit(CommandLine.Model.ArgSpec, CommandLine.LookBehind, boolean, CommandLine.Range, int, String) - Method in class picocli.CommandLine.Interpreter
 
unspecified(boolean) - Method in class picocli.CommandLine.Range
Returns a new Range object with the isUnspecified value replaced by the specified value.
UNSPECIFIED - Static variable in class picocli.CommandLine.Model.ArgSpec
 
updateAddMethodSubcommands(boolean) - Method in class picocli.CommandLine.Model.CommandSpec
 
updateArgGroupAttributes(CommandLine.ArgGroup) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Updates this builder from the specified annotation values.
updateArgSpecMessages() - Method in class picocli.CommandLine.Model.CommandSpec
 
updateCommandAttributes(CommandLine.Command, CommandLine.IFactory) - Method in class picocli.CommandLine.Model.CommandSpec
Updates the following attributes from the specified @Command annotation: aliases, parser separator, command name, version, help command, version provider, default provider and usage message spec.
updateCommandAttributes(CommandLine.Model.CommandSpec, CommandLine.Command) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
updateCommandFromMethodElement(ExecutableElement, AbstractCommandSpecProcessor.Context, CommandLine.Model.CommandSpec, RoundEnvironment) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
updateCommandSpecFromCommandAnnotation(CommandLine.Model.CommandSpec, Element, AbstractCommandSpecProcessor.Context, RoundEnvironment) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
updateCommandSpecFromTypeElement(TypeElement, AbstractCommandSpecProcessor.Context, CommandLine.Model.CommandSpec, RoundEnvironment) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
 
updatedSubcommandsToInheritFrom(CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.Model.CommandSpec
 
updateExitCodeOnExecutionException(int) - Method in class picocli.CommandLine.Model.CommandSpec
 
updateExitCodeOnInvalidInput(int) - Method in class picocli.CommandLine.Model.CommandSpec
 
updateExitCodeOnSuccess(int) - Method in class picocli.CommandLine.Model.CommandSpec
 
updateExitCodeOnUsageHelp(int) - Method in class picocli.CommandLine.Model.CommandSpec
 
updateExitCodeOnVersionHelp(int) - Method in class picocli.CommandLine.Model.CommandSpec
 
updateFromCommand(CommandLine.Command, CommandLine.Model.CommandSpec, boolean) - Method in class picocli.CommandLine.Model.UsageMessageSpec
 
updateHelpCommand(boolean) - Method in class picocli.CommandLine.Model.CommandSpec
 
updateHelpRequested(CommandLine.Model.ArgSpec) - Method in class picocli.CommandLine.Interpreter
 
updateHelpRequested(CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.Interpreter
 
updateModelTransformer(Class<? extends CommandLine.IModelTransformer>, CommandLine.IFactory) - Method in class picocli.CommandLine.Model.CommandSpec
 
updateName(String) - Method in class picocli.CommandLine.Model.CommandSpec
 
updatePreprocessor(Class<? extends CommandLine.IParameterPreprocessor>, CommandLine.IFactory) - Method in class picocli.CommandLine.Model.CommandSpec
 
updateScopeType(CommandLine.ScopeType) - Method in class picocli.CommandLine.Model.CommandSpec
 
updateSeparator(String) - Method in class picocli.CommandLine.Model.ParserSpec
 
updateSubcommandsRepeatable(boolean) - Method in class picocli.CommandLine.Model.CommandSpec
 
updateUnmatchedGroups(CommandLine.Model.ArgGroupSpec) - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
updateVersion(String[]) - Method in class picocli.CommandLine.Model.CommandSpec
 
updateVersionProvider(Class<? extends CommandLine.IVersionProvider>, CommandLine.IFactory) - Method in class picocli.CommandLine.Model.CommandSpec
 
URIConverter() - Constructor for class picocli.CommandLine.BuiltIn.URIConverter
 
URLConverter() - Constructor for class picocli.CommandLine.BuiltIn.URLConverter
 
usage(PrintStream) - Method in class picocli.CommandLine
usage(PrintStream, CommandLine.Help.Ansi) - Method in class picocli.CommandLine
usage(PrintStream, CommandLine.Help.ColorScheme) - Method in class picocli.CommandLine
Prints a usage help message for the annotated command class to the specified PrintStream.
usage(PrintWriter) - Method in class picocli.CommandLine
usage(PrintWriter, CommandLine.Help.Ansi) - Method in class picocli.CommandLine
Similar to CommandLine.usage(PrintStream, Help.Ansi) but with the specified PrintWriter instead of a PrintStream.
usage(PrintWriter, CommandLine.Help.ColorScheme) - Method in class picocli.CommandLine
Similar to CommandLine.usage(PrintStream, Help.ColorScheme), but with the specified PrintWriter instead of a PrintStream.
usage(Object, PrintStream) - Static method in class picocli.CommandLine
Equivalent to new CommandLine(command).usage(out).
usage(Object, PrintStream, CommandLine.Help.Ansi) - Static method in class picocli.CommandLine
Equivalent to new CommandLine(command).usage(out, ansi).
usage(Object, PrintStream, CommandLine.Help.ColorScheme) - Static method in class picocli.CommandLine
Equivalent to new CommandLine(command).usage(out, colorScheme).
usage(StringBuilder, CommandLine.Help) - Method in class picocli.CommandLine
 
USAGE - Static variable in class picocli.CommandLine.ExitCode
Return value from the execute method signifying command line usage error: user input for the command was incorrect, e.g., the wrong number of arguments, a bad flag, a bad syntax in a parameter, or whatever.
usageHelp - Variable in class picocli.CommandLine.Model.OptionSpec.Builder
 
usageHelp - Variable in class picocli.CommandLine.Model.OptionSpec
 
usageHelp() - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Returns whether this option allows the user to request usage help.
usageHelp() - Method in class picocli.CommandLine.Model.OptionSpec
Returns whether this option allows the user to request usage help.
usageHelp() - Method in annotation type picocli.CommandLine.Option
Set usageHelp=true for the --help option that triggers display of the usage help message.
usageHelp(boolean) - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Sets whether this option allows the user to request usage help, and returns this builder.
usageHelpAutoWidth() - Method in annotation type picocli.CommandLine.Command
If true, picocli will attempt to detect the terminal width and adjust the usage help message accordingly.
usageHelpRequested - Variable in class picocli.CommandLine.ParseResult.Builder
 
usageHelpRequested - Variable in class picocli.CommandLine.ParseResult
 
usageHelpWidth() - Method in annotation type picocli.CommandLine.Command
usageMessage - Variable in class picocli.CommandLine.Model.CommandSpec
 
usageMessage() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the usage help message specification for this command.
usageMessage(CommandLine.Model.UsageMessageSpec) - Method in class picocli.CommandLine.Model.CommandSpec
Initializes the usageMessage specification for this command from the specified settings and returns this commandSpec.
UsageMessageSpec() - Constructor for class picocli.CommandLine.Model.UsageMessageSpec
 
UsageMessageSpec(CommandLine.Model.Interpolator) - Constructor for class picocli.CommandLine.Model.UsageMessageSpec
 
useAnsi(CommandLine.Help.Ansi) - Method in class picocli.CommandLine.AbstractHandler
useErr(PrintStream) - Method in class picocli.CommandLine.AbstractHandler
useOut(PrintStream) - Method in class picocli.CommandLine.AbstractHandler
userObject - Variable in class picocli.CommandLine.Model.ArgSpec.Builder
 
userObject - Variable in class picocli.CommandLine.Model.ArgSpec
 
userObject - Variable in class picocli.CommandLine.Model.CommandSpec
 
userObject() - Method in class picocli.codegen.annotation.processing.TypedMember
 
userObject() - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
userObject() - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Returns the user object associated with this option or positional parameters.
userObject() - Method in class picocli.CommandLine.Model.ArgSpec
Returns the user object associated with this option or positional parameters.
userObject() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the user object associated with this command.
userObject() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
 
userObject() - Method in class picocli.CommandLine.Model.TypedMember
 
userObject(Object) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets the user object associated with this option or positional parameters, and returns this builder.
userObjectOr(Object) - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
useSimplifiedAtFiles - Variable in class picocli.CommandLine.Model.ParserSpec
 
useSimplifiedAtFiles() - Method in class picocli.CommandLine.Model.ParserSpec
 
useSimplifiedAtFiles(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
 
Util - Class in picocli.codegen.util
 
Util() - Constructor for class picocli.codegen.util.Util
 
UUIDConverter() - Constructor for class picocli.CommandLine.BuiltIn.UUIDConverter
 

V

validate - Variable in class picocli.CommandLine.Model.ArgGroupSpec.Builder
 
validate - Variable in class picocli.CommandLine.Model.ArgGroupSpec
 
validate() - Method in annotation type picocli.CommandLine.ArgGroup
Determines whether picocli should validate the rules of this group (true by default).
validate() - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Returns whether picocli should validate the rules of this group: for a mutually exclusive group this means that no more than one arguments in the group is specified on the command line; for a co-ocurring group this means that all arguments in the group are specified on the command line.
validate() - Method in class picocli.CommandLine.Model.ArgGroupSpec
Returns whether picocli should validate the rules of this group: for a mutually exclusive group this means that no more than one arguments in the group is specified on the command line; for a co-ocurring group this means that all arguments in the group are specified on the command line.
validate() - Method in class picocli.CommandLine.Model.CommandSpec
Ensures all attributes of this CommandSpec have a valid value; throws an CommandLine.InitializationException if this cannot be achieved.
validate(boolean) - Method in class picocli.CommandLine.Model.ArgGroupSpec.Builder
Sets whether picocli should validate the rules of this group: for a mutually exclusive group this means that no more than one arguments in the group is specified on the command line; for a co-ocurring group this means that all arguments in the group are specified on the command line.
validate(CommandLine) - Method in class picocli.CommandLine.ParseResult.GroupMatch
 
validate(CommandLine) - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
validate(CommandLine, int, boolean, boolean, String, String, String) - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
validateAnnotations(RoundEnvironment) - Method in class picocli.codegen.annotation.processing.AnnotationValidator
 
validateArgGroupSpec(CommandLine.Model.ArgGroupSpec, boolean, String) - Static method in class picocli.CommandLine.Model.CommandReflection
 
validateArgs(CommandLine, Collection<CommandLine.Model.ArgSpec>) - Method in class picocli.CommandLine.Model.ArgGroupSpec
 
validateArgSpecMember(CommandLine.Model.TypedMember) - Static method in class picocli.CommandLine.Model.CommandReflection
 
validateCommandSpec(CommandLine.Model.CommandSpec, boolean, String) - Static method in class picocli.CommandLine.Model.CommandReflection
 
validateConstraints(Stack<String>, List<CommandLine.Model.ArgSpec>, Set<CommandLine.Model.ArgSpec>) - Method in class picocli.CommandLine.Interpreter
 
validateGroupMultiplicity(CommandLine) - Method in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
validateGroups() - Method in class picocli.CommandLine.ParseResult
 
validateInjectSpec(CommandLine.Model.TypedMember) - Static method in class picocli.CommandLine.Model.CommandReflection
 
validateInvalidCombination(RoundEnvironment, Class<T1>, Class<T2>) - Method in class picocli.codegen.annotation.processing.AnnotationValidator
 
validateInvalidCombinations(RoundEnvironment) - Method in class picocli.codegen.annotation.processing.AnnotationValidator
 
validateNoAnnotationsOnInterfaceField(Set<? extends Element>) - Method in class picocli.codegen.annotation.processing.AnnotationValidator
 
validateNoAnnotationsOnInterfaceField(RoundEnvironment) - Method in class picocli.codegen.annotation.processing.AnnotationValidator
 
validateOptions(Set<? extends Element>) - Method in class picocli.codegen.annotation.processing.AnnotationValidator
 
validatePositionalParameters(List<CommandLine.Model.PositionalParamSpec>) - Static method in class picocli.CommandLine
 
validatePositionalParameters(Set<? extends Element>) - Method in class picocli.codegen.annotation.processing.AnnotationValidator
 
validateSubcommandName(String, CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.Model.CommandSpec
 
validationResult - Variable in class picocli.CommandLine.ParseResult.GroupMatch
 
validationResult - Variable in class picocli.CommandLine.ParseResult.GroupMatchContainer
 
value - Variable in class picocli.CommandLine.Model.ObjectBinding
 
value - Variable in class picocli.CommandLine.Model.ObjectScope
 
value - Variable in exception picocli.CommandLine.ParameterException
 
value() - Method in annotation type picocli.CommandLine.Spec
Whether to inject the CommandSpec of this command (the default) or the CommandSpec of the "mixee" command that receives the options and other command elements defined here.
valueOf(boolean) - Static method in enum picocli.CommandLine.Help.Ansi
Returns Ansi.ON if the specified enabled flag is true, Ansi.OFF otherwise.
valueOf(String) - Static method in enum picocli.CommandLine.Help.Ansi.Style
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum picocli.CommandLine.Help.Ansi
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum picocli.CommandLine.Help.Column.Overflow
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum picocli.CommandLine.Help.Visibility
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum picocli.CommandLine.LookBehind
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum picocli.CommandLine.Model.InitialValueState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum picocli.CommandLine.ParseResult.GroupValidationResult.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in class picocli.CommandLine.Range
Leniently parses the specified String as a Range value and return the result.
valueOf(String) - Static method in enum picocli.CommandLine.ScopeType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum picocli.CommandLine.Spec.Target
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum picocli.CommandLine.TraceLevel
Returns the enum constant of this type with the specified name.
values() - Static method in enum picocli.CommandLine.Help.Ansi.Style
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum picocli.CommandLine.Help.Ansi
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum picocli.CommandLine.Help.Column.Overflow
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum picocli.CommandLine.Help.Visibility
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum picocli.CommandLine.LookBehind
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in class picocli.CommandLine.Model.CaseAwareLinkedMap
 
values() - Static method in enum picocli.CommandLine.Model.InitialValueState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum picocli.CommandLine.ParseResult.GroupValidationResult.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum picocli.CommandLine.ScopeType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum picocli.CommandLine.Spec.Target
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum picocli.CommandLine.TraceLevel
Returns an array containing the constants of this enum type, in the order they are declared.
varargCanConsumeNextValue(CommandLine.Model.ArgSpec, String) - Method in class picocli.CommandLine.Interpreter
Returns whether the next argument can be assigned to a vararg option/positional parameter.
verbose(String, Object...) - Method in class picocli.codegen.docgen.manpage.ManPageGenerator.Config
 
verboseDetailed(String, Object...) - Method in class picocli.codegen.docgen.manpage.ManPageGenerator.Config
 
verbosity - Variable in class picocli.codegen.docgen.manpage.ManPageGenerator.Config
 
version - Variable in class picocli.CommandLine.Model.CommandSpec
 
version() - Method in annotation type picocli.CommandLine.Command
Version information for this command, to print to the console when the user specifies an option to request version help.
version() - Method in class picocli.CommandLine.Model.CommandSpec
Returns version information for this command, to print to the console when the user specifies an option to request version help.
version(String...) - Method in class picocli.CommandLine.Model.CommandSpec
Sets version information literals for this command, to print to the console when the user specifies an option to request version help.
VERSION - Static variable in class picocli.CommandLine
This is picocli version "4.6.1".
versionHelp - Variable in class picocli.CommandLine.Model.OptionSpec.Builder
 
versionHelp - Variable in class picocli.CommandLine.Model.OptionSpec
 
versionHelp() - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Returns whether this option allows the user to request version information.
versionHelp() - Method in class picocli.CommandLine.Model.OptionSpec
Returns whether this option allows the user to request version information.
versionHelp() - Method in annotation type picocli.CommandLine.Option
Set versionHelp=true for the --version option that triggers display of the version information.
versionHelp(boolean) - Method in class picocli.CommandLine.Model.OptionSpec.Builder
Sets whether this option allows the user to request version information, and returns this builder.
versionHelpRequested - Variable in class picocli.CommandLine.ParseResult.Builder
 
versionHelpRequested - Variable in class picocli.CommandLine.ParseResult
 
versionProvider - Variable in class picocli.CommandLine.Model.CommandSpec
 
versionProvider() - Method in annotation type picocli.CommandLine.Command
Class that can provide version information dynamically at runtime.
versionProvider() - Method in class picocli.CommandLine.Model.CommandSpec
Returns the version provider for this command, to generate the CommandLine.Model.CommandSpec.version() strings.
versionProvider(CommandLine.IVersionProvider) - Method in class picocli.CommandLine.Model.CommandSpec
Sets version provider for this command, to generate the CommandLine.Model.CommandSpec.version() strings.
VersionProviderMetaData - Class in picocli.codegen.annotation.processing
Implementation of the CommandLine.IVersionProvider interface that provides metadata on the @Command(versionProvider = xxx.class) annotation.
VersionProviderMetaData() - Constructor for class picocli.codegen.annotation.processing.VersionProviderMetaData
 
VersionProviderMetaData(TypeMirror) - Constructor for class picocli.codegen.annotation.processing.VersionProviderMetaData
 
versionRequested - Variable in class picocli.CommandLine.AutoHelpMixin
 
versionString() - Static method in class picocli.CommandLine
 
versionString(CommandLine.Model.CommandSpec) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
vertexCount - Variable in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor.Graph
 
Visibility() - Constructor for enum picocli.CommandLine.Help.Visibility
 
visibleCommands - Variable in class picocli.CommandLine.Help
 
visit(Class<?>[]) - Static method in class picocli.codegen.aot.graalvm.JniConfigGenerator
 
visit(Class<?>, List<ReflectionConfigGenerator.ReflectedClass>) - Static method in class picocli.codegen.aot.graalvm.JniConfigGenerator
 
visitAnnotatedFields(Class<?>) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
visitArgSpec(CommandLine.Model.ArgSpec) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
visitCommandSpec(CommandLine.Model.CommandSpec) - Method in class picocli.codegen.aot.graalvm.DynamicProxyConfigGenerator.Visitor
 
visitCommandSpec(CommandLine.Model.CommandSpec) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
visitCommandSpec(CommandLine.Model.CommandSpec) - Method in class picocli.codegen.aot.graalvm.ResourceConfigGenerator.Visitor
 
visited - Variable in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
visitElement(Element) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
visitFieldBinding(Object) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
visitGetter(CommandLine.Model.IGetter) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
visitGroupSpec(CommandLine.Model.ArgGroupSpec) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
visitMethodBinding(Object) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
visitObjectType(Object) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
visitObjectTypes(Object[]) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
Visitor() - Constructor for class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
Visitor() - Constructor for class picocli.codegen.aot.graalvm.ResourceConfigGenerator.Visitor
 
Visitor(String[]) - Constructor for class picocli.codegen.aot.graalvm.DynamicProxyConfigGenerator.Visitor
 
visitProxyMethodBinding(Object) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
visitSetter(CommandLine.Model.ISetter) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
visitType(Class<?>) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 
visitTypeInfo(CommandLine.Model.ITypeInfo) - Method in class picocli.codegen.aot.graalvm.ReflectionConfigGenerator.Visitor
 

W

warn(String, Object...) - Method in class picocli.CommandLine.Tracer
 
warn(Element, String, Object...) - Method in class picocli.codegen.annotation.processing.AbstractCommandSpecProcessor
Prints a compile-time warning message for the specified element.
WARN - picocli.CommandLine.TraceLevel
 
width - Variable in class picocli.CommandLine.Help.Column
Column width in characters
width - Variable in class picocli.CommandLine.Model.UsageMessageSpec
 
width() - Method in class picocli.CommandLine.Help
 
width() - Method in class picocli.CommandLine.Model.UsageMessageSpec
Returns the maximum usage help message width.
width(int) - Method in class picocli.CommandLine.Model.UsageMessageSpec
Sets the maximum usage help message width to the specified value.
withCommandNames(List<String>) - Method in class picocli.CommandLine.Help
 
withStartIndex(int) - Method in class picocli.CommandLine.Help.Ansi.StyledSection
 
withToString(String) - Method in class picocli.CommandLine.Model.ArgSpec.Builder
Sets the string representation of this option or positional parameter to the specified value, and returns this builder.
withToString(String) - Method in class picocli.CommandLine.Model.CommandSpec
Sets the string representation of this command, used in error messages and trace messages.
WRAP - picocli.CommandLine.Help.Column.Overflow
 
wrapWithoutInspection(Object) - Static method in class picocli.CommandLine.Model.CommandSpec
Creates and returns a new CommandSpec with the specified associated user object.
wrapWithoutInspection(Object, CommandLine.IFactory) - Static method in class picocli.CommandLine.Model.CommandSpec
Creates and returns a new CommandSpec with the specified associated user object.
write(String) - Method in class picocli.codegen.aot.graalvm.OutputFileMixin
 
write(String, int, int) - Method in class picocli.CommandLine.ColoredStackTraceWriter
 
write(String, FileObject) - Static method in class picocli.codegen.aot.graalvm.processor.ProcessorUtil
 
writeCommandScript - Variable in class picocli.AutoComplete.App
 
writeCustomizableManPageTemplate(PrintWriter, File, CommandLine.Model.CommandSpec) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
writeEndOfOptions(PrintWriter, CommandLine.Help.IOptionRenderer, CommandLine.Help.IParamLabelRenderer, CommandLine.Model.OptionSpec) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
Write the end of options.
writeOption(PrintWriter, CommandLine.Help.IOptionRenderer, CommandLine.Help.IParamLabelRenderer, CommandLine.Model.OptionSpec) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
writePositional(PrintWriter, CommandLine.Model.PositionalParamSpec, CommandLine.Help.IParameterRenderer, CommandLine.Help.IParamLabelRenderer) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
writeSingleManPage(PrintWriter, CommandLine.Model.CommandSpec) - Static method in class picocli.codegen.docgen.manpage.ManPageGenerator
 
writeToFile(String) - Method in class picocli.codegen.aot.graalvm.OutputFileMixin
 
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