P-Index (picocli 4.7.7 API)

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

P

parameterArity(Field) - Static method in class picocli.CommandLine.Range: Returns a new Range based on the CommandLine.Parameters.arity() annotation on the specified field, or the field type's default arity if no arity was specified.
parameterConsumer() - Method in class picocli.CommandLine.Model.ArgSpec: Returns a custom IParameterConsumer to temporarily suspend picocli's parsing logic and process one or more command line arguments in a custom manner, or null.
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.
ParameterException(CommandLine, String) - Constructor for exception picocli.CommandLine.ParameterException: Constructs a new ParameterException with the specified CommandLine and error message.
ParameterException(CommandLine, String, Throwable) - Constructor for exception picocli.CommandLine.ParameterException: Constructs a new ParameterException with the specified CommandLine and error message.
ParameterException(CommandLine, String, Throwable, CommandLine.Model.ArgSpec, String) - Constructor for exception picocli.CommandLine.ParameterException: Constructs a new ParameterException with the specified CommandLine and error message.
ParameterException(CommandLine, String, CommandLine.Model.ArgSpec, String) - Constructor for exception picocli.CommandLine.ParameterException: Constructs a new ParameterException with the specified CommandLine and error message.
parameterIndex(Field) - Static method in class picocli.CommandLine.Range: Returns a new Range based on the CommandLine.Parameters.index() annotation on the specified field.
ParameterIndexGapException(String) - Constructor for exception picocli.CommandLine.ParameterIndexGapException
parameterLabelRenderer() - Method in class picocli.CommandLine.Help: Option and positional parameter value label renderer used for the synopsis line(s) and the option list.
parameterList() - Method in class picocli.CommandLine.Help: Returns the rendered positional parameters section of the usage help message for all positional parameters in this command.
parameterList(List<CommandLine.Model.PositionalParamSpec>) - Method in class picocli.CommandLine.Help: Returns the rendered positional parameters section of the usage help message for the specified positional parameters.
parameterList(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() - 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(CommandLine.Help.Ansi.IStyle...) - Method in class picocli.CommandLine.Help.ColorScheme.Builder: Adds the specified styles to the registered styles for positional parameters in this color scheme builder and returns this builder.
parameterStyles() - Method in class picocli.CommandLine.Help.ColorScheme.Builder: Returns the registered styles for positional parameters in this color scheme builder.
parameterStyles() - Method in class picocli.CommandLine.Help.ColorScheme: Returns the registered styles for positional parameters in this color scheme.
parameterText(String) - Method in class picocli.CommandLine.Help.ColorScheme: Returns a Text with all parameter styles applied to the specified parameter string.
paramLabel() - Method in class picocli.CommandLine.Model.ArgSpec: Returns the name of the option or positional parameter used in the usage help message.
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.
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() - Method in class picocli.CommandLine.Model.Messages
parent(CommandLine.Model.CommandSpec) - Method in class picocli.CommandLine.Model.CommandSpec: Sets the parent command of this subcommand.
parentCommandElements() - Method in class picocli.CommandLine.Model.CommandSpec: Returns the list of program elements annotated with {@literal @}ParentCommand configured for this command.
parentGroup() - Method in class picocli.CommandLine.Model.ArgGroupSpec: Returns the parent group that this group is part of, or null if this group is not part of a composite.
parse(String) - Static method in enum picocli.CommandLine.Help.Ansi.Style: Parses the specified comma-separated sequence of style descriptors and returns the associated styles.
parse(String) - Method in class picocli.CommandLine.Help.ColorScheme: Converts the specified markup styles to an array of CommandLine.Help.Ansi.IStyle objects.
parse(String...) - Method in class picocli.CommandLine: Deprecated.
use CommandLine.parseArgs(String...) instead
parseArgs(String...) - Method in class picocli.CommandLine: Expands any @-files in the specified command line arguments, then parses the arguments and returns a ParseResult with the options, positional parameters, and subcommands (if any) that were recognized and initialized during the parsing process.
parser() - Method in class picocli.CommandLine.Model.CommandSpec: Returns the parser specification for this command.
parser(CommandLine.Model.ParserSpec) - Method in class picocli.CommandLine.Model.CommandSpec: Initializes the parser specification for this command from the specified settings and returns this commandSpec.
ParserSpec() - Constructor for class picocli.CommandLine.Model.ParserSpec
parseScriptArguments(CommandLine, String[]) - Method in class picocli.groovy.PicocliBaseScript: Deprecated.

Returns the result of calling CommandLine.parse(String...) with the given arguments.
parseWithHandler(CommandLine.IParseResultHandler2<R>, String[]) - Method in class picocli.CommandLine: Deprecated.
use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead
parseWithHandler(CommandLine.IParseResultHandler, PrintStream, String...) - Method in class picocli.CommandLine: Deprecated.
use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead
parseWithHandlers(CommandLine.IParseResultHandler2<R>, CommandLine.IExceptionHandler2<R>, String...) - Method in class picocli.CommandLine: Deprecated.
use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead
parseWithHandlers(CommandLine.IParseResultHandler, PrintStream, CommandLine.Help.Ansi, CommandLine.IExceptionHandler, String...) - Method in class picocli.CommandLine: Deprecated.
use CommandLine.execute(String...) and CommandLine.getExecutionResult() instead
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: Provides classes and interfaces that form a framework for creating picocli annotation processors.
picocli.codegen.aot.graalvm - package picocli.codegen.aot.graalvm: Provides tools for generating GraalVM configuration files from a picocli CommandSpec model.
picocli.codegen.aot.graalvm.processor - package picocli.codegen.aot.graalvm.processor: Provides an annotation processor that generates GraalVM configuration files based on a picocli CommandSpec model.
picocli.codegen.docgen.manpage - package picocli.codegen.docgen.manpage: Provides tools for generating man-page documentation in AsciiDoc format from a picocli CommandSpec model.
picocli.codegen.util - package picocli.codegen.util: Provides utility classes for internal use in the picocli-codegen module.
picocli.groovy - package picocli.groovy: Provides classes and interfaces for integrating picocli with Groovy.
picocli.shell.jline2 - package picocli.shell.jline2: Provides classes and interfaces for integrating picocli with JLine 2.
picocli.shell.jline3 - package picocli.shell.jline3: Provides classes and interfaces for integrating picocli with JLine 3.
picocli.spring - package picocli.spring: Provides classes and interfaces for integrating picocli with Spring Boot.
picocli.spring.boot.autoconfigure - package picocli.spring.boot.autoconfigure: Provides classes and interfaces for picocli Spring Boot Auto-configuration.
PicocliAutoConfiguration - Class in picocli.spring.boot.autoconfigure
PicocliAutoConfiguration() - Constructor for class picocli.spring.boot.autoconfigure.PicocliAutoConfiguration
PicocliBaseScript - Class in picocli.groovy: Deprecated.
Use PicocliBaseScript2 instead.
PicocliBaseScript() - Constructor for class picocli.groovy.PicocliBaseScript: Deprecated.
PicocliBaseScript2 - Class in picocli.groovy: Base script class that provides picocli declarative (annotation-based) command line argument processing for Groovy scripts, updated for picocli version 4 and greater.
PicocliBaseScript2() - Constructor for class picocli.groovy.PicocliBaseScript2
PicocliCommands - Class in picocli.shell.jline3: Compiles SystemCompleter for command completion and implements a method commandDescription() that provides command descriptions for JLine TailTipWidgets to be displayed in terminal status bar.
PicocliCommands(CommandLine) - Constructor for class picocli.shell.jline3.PicocliCommands
PicocliCommands.ClearScreen - Class in picocli.shell.jline3: Command that clears the screen.
PicocliCommands.PicocliCommandsFactory - Class in picocli.shell.jline3: Command factory that is necessary for applications that want the use the ClearScreen subcommand.
PicocliCommandsFactory() - Constructor for class picocli.shell.jline3.PicocliCommands.PicocliCommandsFactory
PicocliCommandsFactory(CommandLine.IFactory) - Constructor for class picocli.shell.jline3.PicocliCommands.PicocliCommandsFactory
PicocliException(String) - Constructor for exception picocli.CommandLine.PicocliException
PicocliException(String, Throwable) - Constructor for exception picocli.CommandLine.PicocliException
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 - Class in picocli.shell.jline3: Implementation of the JLine 3 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.
PicocliJLineCompleter(CommandLine.Model.CommandSpec) - Constructor for class picocli.shell.jline3.PicocliJLineCompleter: Constructs a new PicocliJLineCompleter for the given command spec.
PicocliScript - Annotation Type in picocli.groovy: Deprecated.
Use PicocliScript2 instead.
PicocliScript2 - Annotation Type in picocli.groovy: Annotation to give Groovy scripts convenient access to picocli functionality, updated for picocli version 4 and greater.
PicocliScriptASTTransformation - Class in picocli.groovy: Ensures that Groovy scripts annotated with PicocliScript are transformed into a class that extends PicocliBaseScript.
PicocliScriptASTTransformation() - Constructor for class picocli.groovy.PicocliScriptASTTransformation
picocliSpringFactory(ApplicationContext) - Method in class picocli.spring.boot.autoconfigure.PicocliAutoConfiguration
PicocliSpringFactory - Class in picocli.spring: PicocliSpringFactory is a CommandLine.IFactory implementation that looks up classes in a given org.springframework.context.ApplicationContext.
PicocliSpringFactory(ApplicationContext) - Constructor for class picocli.spring.PicocliSpringFactory: Constructs a PicocliSpringFactory with the specified Application context, and picocli's default factory as the fallback factory for classes not found in the application context.
PicocliSpringFactory(ApplicationContext, CommandLine.IFactory) - Constructor for class picocli.spring.PicocliSpringFactory: Constructs a PicocliSpringFactory with the specified Application context, and the specified fallback factory for classes not found in the application context.
picocliSpringFactoryImpl(ApplicationContext) - Method in class picocli.spring.boot.autoconfigure.PicocliAutoConfiguration
plainString() - Method in class picocli.CommandLine.Help.Ansi.Text: Returns the plain text without any formatting.
populateCommand(T, String...) - Static method in class picocli.CommandLine: Convenience method that initializes the specified annotated object from the specified command line arguments.
populateSpec(Class<T>, String...) - Static method in class picocli.CommandLine: Convenience method that derives the command specification from the specified interface class, and returns an instance of the specified interface.
positionalParameters() - Method in class picocli.CommandLine.Model.ArgGroupSpec: Returns the list of positional parameters configured for this group.
positionalParameters() - Method in class picocli.CommandLine.Model.CommandSpec: Returns the list of positional parameters configured for this command.
posixClusteredShortOptionsAllowed() - Method in class picocli.CommandLine.Model.ParserSpec
posixClusteredShortOptionsAllowed(boolean) - Method in class picocli.CommandLine.Model.ParserSpec
posixOptionsMap() - Method in class picocli.CommandLine.Model.CommandSpec: Returns a map of the short (single character) option names to option spec objects configured for this command.
preprocess(Stack<String>, CommandLine.Model.CommandSpec, CommandLine.Model.ArgSpec, Map<String, Object>) - Method in interface picocli.CommandLine.IParameterPreprocessor: Called when either the command, option or positional parameter that has this preprocessor configured was recognized by the picocli parser.
preprocessor() - Method in annotation type picocli.CommandLine.Command: Returns the preprocessor for this command.
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.CommandSpec: Sets the preprocessor for this CommandSpec instance.
printErrorMessage(String) - Method in class picocli.groovy.PicocliBaseScript: Deprecated.

Error messages that arise from command line processing call this.
printHelpIfRequested(List<CommandLine>, PrintStream, PrintStream, CommandLine.Help.Ansi) - Static method in class picocli.CommandLine: Deprecated.
use CommandLine.executeHelpRequest(ParseResult) instead
printHelpIfRequested(List<CommandLine>, PrintStream, PrintStream, CommandLine.Help.ColorScheme) - Static method in class picocli.CommandLine: Deprecated.
use CommandLine.executeHelpRequest(ParseResult) instead
printHelpIfRequested(List<CommandLine>, PrintStream, CommandLine.Help.Ansi) - Static method in class picocli.CommandLine: Deprecated.
use CommandLine.printHelpIfRequested(ParseResult) instead
printHelpIfRequested(CommandLine.ParseResult) - Static method in class picocli.CommandLine: Delegates to CommandLine.executeHelpRequest(ParseResult).
printHelpMessage(CommandLine) - Method in class picocli.groovy.PicocliBaseScript: Deprecated.

If an @Option whose usageHelp attribute is annotated as true appears in the arguments.
printHelpMessage(CommandLine, PrintStream) - Method in class picocli.groovy.PicocliBaseScript: Deprecated.

If an @Option whose usageHelp attribute is annotated as true appears in the arguments.
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.
printVersionHelpMessage(CommandLine) - Method in class picocli.groovy.PicocliBaseScript: Deprecated.

If an @Option whose versionHelp attribute is annotated as true appears in the arguments.
process(Set<? extends TypeElement>, RoundEnvironment) - 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.
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.
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.
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.

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