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

G

GenerateCompletion() - Constructor for class picocli.AutoComplete.GenerateCompletion
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.
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(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.
get() - Method in class picocli.codegen.annotation.processing.AnnotatedElementHolder: This implementation does nothing and always returns null.
get() - Method in interface picocli.CommandLine.Model.IGetter: Returns the current value of the binding.
getActualGenericTypeArguments() - Method in interface picocli.CommandLine.Model.ITypeInfo: Returns the names of the type arguments if this is a generic type.
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 interface picocli.CommandLine.Model.IAnnotatedElement
getAnnotation(Class<T>) - Method in class picocli.CommandLine.Model.MethodParam
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 interface picocli.CommandLine.Model.ITypeInfo: Returns type information of components or elements of a multivalue type.
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.
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 interface picocli.CommandLine.Model.ITypeInfo
getClassSimpleName() - Method in interface picocli.CommandLine.Model.ITypeInfo
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).
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 interface picocli.CommandLine.Model.ITypeInfo
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 interface picocli.CommandLine.Model.IExtensible: Returns an instance of the specified class, or null if this extension is not supported.
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.
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.
getLevel() - Method in class picocli.CommandLine.Tracer: Returns the trace level that needs to be matched or exceeded for internal tracing statements to be printed.
getMethodParamPosition() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
getMissing() - Method in exception picocli.CommandLine.MissingParameterException
getMixinName() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
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 interface picocli.CommandLine.Model.IAnnotatedElement
getName() - Method in class picocli.CommandLine.Model.MethodParam
getNegatableOptionTransformer() - Method in class picocli.CommandLine: Returns the INegatableOptionTransformer used to create the negative form of negatable options.
getOrCreateCommandLine() - Method in class picocli.groovy.PicocliBaseScript: Deprecated.

Return the CommandLine for this script.
getOrCreateCommandLine() - Method in class picocli.groovy.PicocliBaseScript2: Returns the CommandLine for this script.
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
getResourceBundle() - Method in class picocli.CommandLine: Returns the ResourceBundle of this command or null if no resource bundle is set.
getScope() - Method in interface picocli.CommandLine.Model.IScoped: Get the CommandLine.Model.IScope instance.
getScriptArguments() - Method in class picocli.groovy.PicocliBaseScript: Deprecated.

Return the script arguments as an array of strings.
getScriptArguments() - Method in class picocli.groovy.PicocliBaseScript2: Returns the script arguments as an array of strings.
getSeparator() - Method in class picocli.CommandLine: Returns the String that separates option names from option values when parsing command line options.
getString(String, String) - Method in class picocli.CommandLine.Model.Messages: Returns the String value found in the resource bundle for the specified key, or the specified default value if not found.
getStringArray(String, String[]) - Method in class picocli.CommandLine.Model.Messages: Returns the String array value found in the resource bundle for the specified key, or the specified default value if not found.
getStyledChars(int, int, CommandLine.Help.Ansi.Text, int) - Method in class picocli.CommandLine.Help.Ansi.Text: Copies the specified substring of this Text into the specified destination, preserving the markup.
getSubcommands() - Method in class picocli.CommandLine: Returns a map with the subcommands registered on this instance.
getSuggestions() - Method in exception picocli.CommandLine.UnmatchedArgumentException: Returns suggested solutions if such solutions exist, otherwise returns an empty list.
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.
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: 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.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.
getToString() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
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
getTypeElement() - Method in interface picocli.codegen.annotation.processing.ITypeMetaData: Returns the TypeElement of the type mirror.
getTypeInfo() - Method in interface picocli.CommandLine.Model.IAnnotatedElement
getTypeMirror() - Method in interface picocli.codegen.annotation.processing.ITypeMetaData: Returns the TypeMirror of the value.
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.
getVersion() - Method in interface picocli.CommandLine.IVersionProvider: Returns version information for a command.
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.

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