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
All Classes All Packages
All Classes All Packages
R
- Range(int, int, boolean, boolean, String) - Constructor for class picocli.CommandLine.Range
-
Constructs a new Range object with the specified parameters.
- 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
- registerConverter(Class<K>, CommandLine.ITypeConverter<K>) - Method in class picocli.CommandLine
-
Registers the specified type converter for the specified class.
- 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.
- 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, ornull
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 interface picocli.CommandLine.Help.IOptionRenderer
-
Returns a text representation of the specified option and its parameter(s) if any.
- 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.
- renderedDescription() - Method in class picocli.CommandLine.Model.ArgSpec
-
Deprecated.Use
CommandLine.Model.ArgSpec.description()
instead - 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. - 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.
- 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.
- 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.
- reset - picocli.CommandLine.Help.Ansi.Style
- 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.
- 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 aMessages
object created from this command spec and the specified bundle, and then sets theArgSpec.messages
of all options and positional parameters in this command to the sameMessages
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 isnull
. - 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 aMessages
object created from this command spec and the specified bundle, and then sets theArgSpec.messages
of all options and positional parameters in this command to the sameMessages
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 isnull
. - 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
- 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
- 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 thestack trace styles
applied to the remaining stack trace of lines the specified Throwable. - 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
. - 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() - Method in class picocli.groovy.PicocliBaseScript
-
Deprecated.Parses the command line and initializes
@Field
variables annotated with@Option
or@Parameters
before executing the script body. - run() - Method in class picocli.groovy.PicocliBaseScript2
-
Parses the command line and initializes
@Field
variables annotated with@Option
or@Parameters
before executing the script body. - run(Class<R>, CommandLine.IFactory, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
instead - run(Class<R>, CommandLine.IFactory, PrintStream, String...) - Static method in class picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
instead - run(Class<R>, CommandLine.IFactory, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
instead - run(Class<R>, CommandLine.IFactory, String...) - Static method in class picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
instead - run(R, PrintStream, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
instead - run(R, PrintStream, String...) - Static method in class picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
instead - run(R, PrintStream, CommandLine.Help.Ansi, String...) - Static method in class picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
instead - run(R, String...) - Static method in class picocli.CommandLine
-
Deprecated.use
CommandLine.execute(String...)
instead - RunAll() - Constructor for class picocli.CommandLine.RunAll
- RunFirst() - Constructor for class picocli.CommandLine.RunFirst
- RunLast() - Constructor for class picocli.CommandLine.RunLast
- runRunnableSubcommand(List<CommandLine>) - Method in class picocli.groovy.PicocliBaseScript
-
Deprecated.If the most specific subcommand (the last
CommandLine
object in the list) implements Runnable or Callable, then run it. - runScriptBody() - Method in class picocli.groovy.PicocliBaseScript
-
Deprecated.The script body.
All Classes All Packages