Uses of Class
picocli.CommandLine.Model.CommandSpec
-
Packages that use CommandLine.Model.CommandSpec Package Description picocli Provides classes and interfaces for the main picocli command line parsing andautocompletion
functionality.picocli.codegen.annotation.processing picocli.codegen.aot.graalvm picocli.codegen.aot.graalvm.processor picocli.codegen.docgen.manpage picocli.codegen.util picocli.shell.jline2 picocli.shell.jline3 -
-
Uses of CommandLine.Model.CommandSpec in picocli
Fields in picocli declared as CommandLine.Model.CommandSpec Modifier and Type Field Description private CommandLine.Model.CommandSpec
CommandLine. commandSpec
private CommandLine.Model.CommandSpec
CommandLine.Help. commandSpec
private CommandLine.Model.CommandSpec
CommandLine.Help.DefaultParamLabelRenderer. commandSpec
(package private) CommandLine.Model.CommandSpec
CommandLine.Model.ArgSpec. commandSpec
private CommandLine.Model.CommandSpec
CommandLine.Model.CommandUserObject. commandSpec
private CommandLine.Model.CommandSpec
CommandLine.Model.Interpolator. commandSpec
private CommandLine.Model.CommandSpec
CommandLine.ParseResult.Builder. commandSpec
private CommandLine.Model.CommandSpec
CommandLine.ParseResult. commandSpec
private CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. parent
(package private) CommandLine.Model.CommandSpec
AutoComplete.App. spec
(package private) CommandLine.Model.CommandSpec
AutoComplete.GenerateCompletion. spec
private CommandLine.Model.CommandSpec
CommandLine.Model.Messages. spec
private CommandLine.Model.CommandSpec
CommandLine.Model.MethodBinding. spec
Fields in picocli with type parameters of type CommandLine.Model.CommandSpec Modifier and Type Field Description private java.util.Map<java.lang.String,CommandLine.Model.CommandSpec>
CommandLine.Model.CommandSpec. mixins
Methods in picocli that return CommandLine.Model.CommandSpec Modifier and Type Method Description CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. add(CommandLine.Model.ArgSpec arg)
Adds the specified option spec or positional parameter spec to the list of configured arguments to expect.private CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. addArg(CommandLine.Model.ArgSpec arg)
CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. addArgGroup(CommandLine.Model.ArgGroupSpec group)
Adds the specified argument group to the groups in this command.private CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. addArgGroup(CommandLine.Model.ArgGroupSpec group, java.util.Set<CommandLine.Model.OptionSpec> groupOptions, java.util.Set<CommandLine.Model.PositionalParamSpec> groupPositionals)
CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. addMethodSubcommands()
Reflects on the class of the user object and registers any command methods (class methods annotated with@Command
) as subcommands.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. addMethodSubcommands(CommandLine.IFactory factory)
Reflects on the class of the user object and registers any command methods (class methods annotated with@Command
) as subcommands.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. addMixin(java.lang.String name, CommandLine.Model.CommandSpec mixin)
Adds the specified mixinCommandSpec
object to the map of mixins for this command.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. addMixin(java.lang.String name, CommandLine.Model.CommandSpec mixin, CommandLine.Model.IAnnotatedElement annotatedElement)
Adds the specified mixinCommandSpec
object to the map of mixins for this command.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. addOption(CommandLine.Model.OptionSpec option)
Adds the specified option spec to the list of configured arguments to expect.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. addParentCommandElement(CommandLine.Model.IAnnotatedElement spec)
Adds the specified{@literal @}ParentCommand
-annotated program element to the list of elements for this command.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. addPositional(CommandLine.Model.PositionalParamSpec positional)
Adds the specified positional parameter spec to the list of configured arguments to expect.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. addSpecElement(CommandLine.Model.IAnnotatedElement spec)
Adds the specified{@literal @}Spec
-annotated program element to the list of elements for this command.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. addSubcommand(java.lang.String name, CommandLine subCommandLine)
Adds the specified subcommand with the specified name.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. addSubcommand(java.lang.String name, CommandLine.Model.CommandSpec subcommand)
Adds the specified subcommand with the specified name.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. addUnmatchedArgsBinding(CommandLine.Model.UnmatchedArgsBinding spec)
Adds the specifiedUnmatchedArgsBinding
to the list of model objects to capture unmatched arguments for this command.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. aliases(java.lang.String... aliases)
Sets the alternative names by which this subcommand is recognized on the command line.private static CommandLine.Model.CommandSpec
CommandLine.Model.CommandReflection. buildMixinForMember(CommandLine.Model.IAnnotatedElement member, CommandLine.IFactory factory)
CommandLine.Model.CommandSpec
CommandLine.Model.ArgSpec. command()
Returns the command this option or positional parameter belongs to.protected CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. commandLine(CommandLine commandLine)
Sets the CommandLine constructed with thisCommandSpec
model.CommandLine.Model.CommandSpec
CommandLine.Help. commandSpec()
Returns theCommandSpec
model that this Help was constructed with.CommandLine.Model.CommandSpec
CommandLine.Model.Messages. commandSpec()
Returns the CommandSpec of this object, nevernull
.CommandLine.Model.CommandSpec
CommandLine.ParseResult. commandSpec()
Returns theCommandSpec
for the matched command.private CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. copy()
static CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. create()
Creates and returns a newCommandSpec
without any associated user object.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. defaultValueProvider(CommandLine.IDefaultValueProvider defaultValueProvider)
Sets default value provider for this command.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. exitCodeOnExecutionException(int newValue)
Sets exit code signifying that an exception occurred when invoking the Runnable, Callable or Method user object of a command.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. exitCodeOnInvalidInput(int newValue)
Sets exit code for command line usage error.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. exitCodeOnSuccess(int newValue)
Sets exit code for successful termination.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. exitCodeOnUsageHelp(int newValue)
Sets exit code for successful termination after printing usage help on user request.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. exitCodeOnVersionHelp(int newValue)
Sets exit code for successful termination after printing version help on user request.(package private) static CommandLine.Model.CommandSpec
CommandLine.Model.CommandReflection. extractCommandSpec(java.lang.Object command, CommandLine.IFactory factory, boolean annotationsAreMandatory)
private static CommandLine.Model.CommandSpec
AutoComplete. findCommandFor(CommandLine.Model.ArgSpec arg, CommandLine.Model.CommandSpec cmd)
private static CommandLine.Model.CommandSpec
AutoComplete. findCommandFor(CommandLine.Model.OptionSpec option, CommandLine.Model.CommandSpec commandSpec)
private static CommandLine.Model.CommandSpec
AutoComplete. findCommandFor(CommandLine.Model.PositionalParamSpec positional, CommandLine.Model.CommandSpec commandSpec)
static CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. forAnnotatedObject(java.lang.Object userObject)
Creates and returns a newCommandSpec
initialized from the specified associated user object.static CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. forAnnotatedObject(java.lang.Object userObject, CommandLine.IFactory factory)
Creates and returns a newCommandSpec
initialized from the specified associated user object.static CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. forAnnotatedObjectLenient(java.lang.Object userObject)
Creates and returns a newCommandSpec
initialized from the specified associated user object.static CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. forAnnotatedObjectLenient(java.lang.Object userObject, CommandLine.IFactory factory)
Creates and returns a newCommandSpec
initialized from the specified associated user object.CommandLine.Model.CommandSpec
CommandLine. getCommandSpec()
Returns theCommandSpec
model that thisCommandLine
was constructed with.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. helpCommand(boolean newValue)
Sets whether this is a help command and required parameter checking should be suspended.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. interpolateVariables(java.lang.Boolean interpolate)
Sets whether whether variables should be interpolated in String values.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. mixinStandardHelpOptions(boolean newValue)
Sets whether the standard help options should be mixed in with this command.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. modelTransformer(CommandLine.IModelTransformer modelTransformer)
Sets the model transformer for this CommandSpec instance.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. name(java.lang.String name)
Sets the String to use as the program name in the synopsis line of the help message.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. negatableOptionTransformer(CommandLine.INegatableOptionTransformer newValue)
Sets theINegatableOptionTransformer
used to create the negative form of negatable options.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. optionsCaseInsensitive(boolean caseInsensitiveOptions)
Sets the case-insensitivity of options.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. parent()
Returns the parent command of this subcommand, ornull
if this is a top-level command.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. parent(CommandLine.Model.CommandSpec parent)
Sets the parent command of this subcommand.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. parser(CommandLine.Model.ParserSpec settings)
Initializes the parser specification for this command from the specified settings and returns this commandSpec.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. preprocessor(CommandLine.IParameterPreprocessor preprocessor)
Sets the preprocessor for this CommandSpec instance.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. remove(CommandLine.Model.ArgSpec arg)
(INCUBATING) Removes the specified option spec or positional parameter spec from the list of configured arguments to expect.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. resourceBundle(java.util.ResourceBundle bundle)
Initializes the resource bundle for this command: sets theUsageMessageSpec.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.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. resourceBundleBaseName(java.lang.String resourceBundleBaseName)
Initializes the resource bundle for this command: sets theUsageMessageSpec.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.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. root()
Returns the root command: the top-level command of the hierarchy, nevernull
.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. scopeType(CommandLine.ScopeType scopeType)
Sets the scope of where this argument applies: only this command, or also all sub (and sub-sub) commands, and returns this builder.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. setAddMethodSubcommands(java.lang.Boolean addMethodSubcommands)
Sets whether method commands should be added as subcommands.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. subcommandsCaseInsensitive(boolean caseInsensitiveSubcommands)
Sets the case-insensitivity of subcommands.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. subcommandsRepeatable(boolean subcommandsRepeatable)
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.CommandLine.Model.CommandSpec
CommandLine.IModelTransformer. transform(CommandLine.Model.CommandSpec commandSpec)
Given an original CommandSpec, return the object that should be used instead.CommandLine.Model.CommandSpec
CommandLine.NoOpModelTransformer. transform(CommandLine.Model.CommandSpec commandSpec)
CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. usageMessage(CommandLine.Model.UsageMessageSpec settings)
Initializes the usageMessage specification for this command from the specified settings and returns this commandSpec.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. version(java.lang.String... version)
Sets version information literals for this command, to print to the console when the user specifies an option to request version help.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. versionProvider(CommandLine.IVersionProvider versionProvider)
Sets version provider for this command, to generate theversion()
strings.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. withToString(java.lang.String newValue)
Sets the string representation of this command, used in error messages and trace messages.static CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. wrapWithoutInspection(java.lang.Object userObject)
Creates and returns a newCommandSpec
with the specified associated user object.static CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. wrapWithoutInspection(java.lang.Object userObject, CommandLine.IFactory factory)
Creates and returns a newCommandSpec
with the specified associated user object.Methods in picocli that return types with arguments of type CommandLine.Model.CommandSpec Modifier and Type Method Description java.util.Map<java.lang.String,CommandLine.Model.CommandSpec>
CommandLine.Model.CommandSpec. mixins()
Returns a map of the mixin names to mixinCommandSpec
objects configured for this command.Methods in picocli with parameters of type CommandLine.Model.CommandSpec Modifier and Type Method Description private static void
AutoComplete. addCandidatesForArgsFollowing(CommandLine.Model.CommandSpec commandSpec, java.util.List<java.lang.CharSequence> candidates)
CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. addMixin(java.lang.String name, CommandLine.Model.CommandSpec mixin)
Adds the specified mixinCommandSpec
object to the map of mixins for this command.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. addMixin(java.lang.String name, CommandLine.Model.CommandSpec mixin, CommandLine.Model.IAnnotatedElement annotatedElement)
Adds the specified mixinCommandSpec
object to the map of mixins for this command.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. addSubcommand(java.lang.String name, CommandLine.Model.CommandSpec subcommand)
Adds the specified subcommand with the specified name.private static CommandLine.Model.ArgGroupSpec
CommandLine.Model.CommandReflection. buildArgGroupForMember(CommandLine.Model.IAnnotatedElement member, CommandLine.IFactory factory, CommandLine.Model.CommandSpec commandSpec)
static CommandLine.ParseResult.Builder
CommandLine.ParseResult. builder(CommandLine.Model.CommandSpec commandSpec)
Creates and returns a newParseResult.Builder
for the specified command spec.static int
AutoComplete. complete(CommandLine.Model.CommandSpec spec, java.lang.String[] args, int argIndex, int positionInArg, int cursor, java.util.List<java.lang.CharSequence> candidates)
void
CommandLine.IParameterConsumer. consumeParameters(java.util.Stack<java.lang.String> args, CommandLine.Model.ArgSpec argSpec, CommandLine.Model.CommandSpec commandSpec)
Consumes as many of the specified command line arguments as needed by popping them off the specified Stack.void
CommandLine.NullParameterConsumer. consumeParameters(java.util.Stack<java.lang.String> args, CommandLine.Model.ArgSpec argSpec, CommandLine.Model.CommandSpec commandSpec)
static CommandLine.Model.Messages
CommandLine.Model.Messages. copy(CommandLine.Model.CommandSpec spec, CommandLine.Model.Messages original)
Returns a copy of the specified Messages object with the CommandSpec replaced by the specified one.CommandLine.Help
CommandLine.DefaultHelpFactory. create(CommandLine.Model.CommandSpec commandSpec, CommandLine.Help.ColorScheme colorScheme)
CommandLine.Help
CommandLine.IHelpFactory. create(CommandLine.Model.CommandSpec commandSpec, CommandLine.Help.ColorScheme colorScheme)
Returns aHelp
instance to assist in rendering the usage help message(package private) static CommandLine.Model.TypedMember
CommandLine.Model.TypedMember. createIfAnnotated(java.lang.reflect.Method method, CommandLine.Model.IScope scope, CommandLine.Model.CommandSpec spec)
CommandLine.Help.IParamLabelRenderer
CommandLine.Model.ArgGroupSpec. createLabelRenderer(CommandLine.Model.CommandSpec commandSpec)
private static java.util.Properties
CommandLine.PropertiesDefaultProvider. createProperties(java.io.File file, CommandLine.Model.CommandSpec commandSpec)
(package private) static CommandLine.Model.ArgGroupSpec
CommandLine.Model.CommandReflection. extractArgGroupSpec(CommandLine.Model.IAnnotatedElement member, CommandLine.IFactory factory, CommandLine.Model.CommandSpec commandSpec, boolean annotationsAreMandatory)
private static CommandLine.Model.CommandSpec
AutoComplete. findCommandFor(CommandLine.Model.ArgSpec arg, CommandLine.Model.CommandSpec cmd)
private static CommandLine.Model.CommandSpec
AutoComplete. findCommandFor(CommandLine.Model.OptionSpec option, CommandLine.Model.CommandSpec commandSpec)
private static CommandLine.Model.CommandSpec
AutoComplete. findCommandFor(CommandLine.Model.PositionalParamSpec positional, CommandLine.Model.CommandSpec commandSpec)
private java.lang.String
CommandLine.PropertiesDefaultProvider. getValue(java.lang.String key, CommandLine.Model.CommandSpec spec)
private void
CommandLine.Model.CommandSpec. inheritAttributesFrom(CommandLine.Model.CommandSpec root)
private void
CommandLine.Model.CommandSpec. initFrom(CommandLine.Model.CommandSpec spec)
(package private) void
CommandLine.Model.UsageMessageSpec. initFrom(CommandLine.Model.UsageMessageSpec settings, CommandLine.Model.CommandSpec commandSpec)
private static boolean
CommandLine.Model.CommandReflection. initFromAnnotatedFields(CommandLine.Model.IScope scope, java.lang.Class<?> cls, CommandLine.Model.CommandSpec receiver, CommandLine.Model.ArgGroupSpec.Builder groupBuilder, CommandLine.IFactory factory, CommandLine.Model.Predicate<CommandLine.Model.TypedMember> predicate)
private static boolean
CommandLine.Model.CommandReflection. initFromAnnotatedTypedMembers(CommandLine.Model.TypedMember member, CommandLine.Model.Predicate<CommandLine.Model.TypedMember> predicate, CommandLine.Model.CommandSpec commandSpec, CommandLine.Model.ArgGroupSpec.Builder groupBuilder, CommandLine.IFactory factory)
private static boolean
CommandLine.Model.CommandReflection. initFromMethodParameters(CommandLine.Model.IScope scope, java.lang.reflect.Method method, CommandLine.Model.CommandSpec receiver, CommandLine.Model.ArgGroupSpec.Builder groupBuilder, CommandLine.IFactory factory)
(package private) void
CommandLine.Model.UsageMessageSpec. initFromMixin(CommandLine.Model.UsageMessageSpec mixin, CommandLine.Model.CommandSpec commandSpec)
private static void
CommandLine.Model.CommandReflection. initMethodSubcommands(java.lang.Class<?> cls, CommandLine.Model.CommandSpec parent, CommandLine.IFactory factory)
private static void
CommandLine.Model.CommandReflection. initSubcommands(CommandLine.Command cmd, java.lang.Class<?> cls, CommandLine.Model.CommandSpec parent, CommandLine.IFactory factory, java.util.Stack<java.lang.Class<?>> hierarchy)
private static void
CommandLine.Model.CommandReflection. injectSpecIntoVersionProvider(CommandLine.Model.CommandSpec result, CommandLine.Command cmd, CommandLine.IFactory factory)
private static java.util.Properties
CommandLine.PropertiesDefaultProvider. loadProperties(CommandLine.Model.CommandSpec commandSpec)
java.lang.String
CommandLine.INegatableOptionTransformer. makeNegative(java.lang.String optionName, CommandLine.Model.CommandSpec cmd)
Returns the negative form of the specified option name for the parser to recognize when parsing command line arguments.java.lang.String
CommandLine.RegexTransformer. makeNegative(java.lang.String optionName, CommandLine.Model.CommandSpec cmd)
Returns the negative form of the specified option name for the parser to recognize when parsing command line arguments.java.lang.String
CommandLine.INegatableOptionTransformer. makeSynopsis(java.lang.String optionName, CommandLine.Model.CommandSpec cmd)
Returns the documentation string to show in the synopsis and usage help message for the specified option.java.lang.String
CommandLine.RegexTransformer. makeSynopsis(java.lang.String optionName, CommandLine.Model.CommandSpec cmd)
Returns the documentation string to show in the synopsis and usage help message for the specified option.CommandLine.Model.CommandSpec
CommandLine.Model.CommandSpec. parent(CommandLine.Model.CommandSpec parent)
Sets the parent command of this subcommand.boolean
CommandLine.IParameterPreprocessor. preprocess(java.util.Stack<java.lang.String> args, CommandLine.Model.CommandSpec commandSpec, CommandLine.Model.ArgSpec argSpec, java.util.Map<java.lang.String,java.lang.Object> info)
Called when either the command, option or positional parameter that has this preprocessor configured was recognized by the picocli parser.boolean
CommandLine.NoOpParameterPreprocessor. preprocess(java.util.Stack<java.lang.String> args, CommandLine.Model.CommandSpec commandSpec, CommandLine.Model.ArgSpec argSpec, java.util.Map<java.lang.String,java.lang.Object> info)
CommandLine.Model.CommandSpec
CommandLine.IModelTransformer. transform(CommandLine.Model.CommandSpec commandSpec)
Given an original CommandSpec, return the object that should be used instead.CommandLine.Model.CommandSpec
CommandLine.NoOpModelTransformer. transform(CommandLine.Model.CommandSpec commandSpec)
private void
CommandLine.Model.CommandSpec. updatedSubcommandsToInheritFrom(CommandLine.Model.CommandSpec root)
(package private) void
CommandLine.Model.UsageMessageSpec. updateFromCommand(CommandLine.Command cmd, CommandLine.Model.CommandSpec commandSpec, boolean loadResourceBundle)
private void
CommandLine.Interpreter. updateHelpRequested(CommandLine.Model.CommandSpec command)
private static void
CommandLine.Model.CommandReflection. validateCommandSpec(CommandLine.Model.CommandSpec result, boolean hasCommandAnnotation, java.lang.String commandClassName)
private java.lang.String
CommandLine.Model.CommandSpec. validateSubcommandName(java.lang.String name, CommandLine.Model.CommandSpec subSpec)
Constructors in picocli with parameters of type CommandLine.Model.CommandSpec Constructor Description Builder(CommandLine.Model.CommandSpec spec)
DefaultParamLabelRenderer(CommandLine.Model.CommandSpec commandSpec)
Constructs a new DefaultParamLabelRenderer with the specified separator string.Help(CommandLine.Model.CommandSpec commandSpec, CommandLine.Help.ColorScheme colorScheme)
Constructs a newHelp
instance with the specified color scheme, initialized from annotations on the specified class and superclasses.Interpolator(CommandLine.Model.CommandSpec commandSpec)
Messages(CommandLine.Model.CommandSpec spec, java.lang.String baseName)
Messages(CommandLine.Model.CommandSpec spec, java.lang.String baseName, java.util.ResourceBundle rb)
Messages(CommandLine.Model.CommandSpec spec, java.util.ResourceBundle rb)
MethodBinding(CommandLine.Model.IScope scope, java.lang.reflect.Method method, CommandLine.Model.CommandSpec spec)
TypedMember(java.lang.reflect.Method method, CommandLine.Model.IScope scope, CommandLine.Model.CommandSpec spec)
-
Uses of CommandLine.Model.CommandSpec in picocli.codegen.annotation.processing
Fields in picocli.codegen.annotation.processing declared as CommandLine.Model.CommandSpec Modifier and Type Field Description private CommandLine.Model.CommandSpec
MixinInfo. mixin
Fields in picocli.codegen.annotation.processing with type parameters of type CommandLine.Model.CommandSpec Modifier and Type Field Description (package private) java.util.Map<javax.lang.model.element.Element,CommandLine.Model.CommandSpec>
AbstractCommandSpecProcessor.Context. commands
(package private) java.util.Set<CommandLine.Model.CommandSpec>
AbstractCommandSpecProcessor.Context. commandsRequestingStandardHelpOptions
(package private) java.util.Map<javax.lang.model.type.TypeMirror,java.util.List<CommandLine.Model.CommandSpec>>
AbstractCommandSpecProcessor.Context. commandTypes
(package private) java.util.Map<CommandLine.Model.CommandSpec,java.util.Set<MixinInfo>>
AbstractCommandSpecProcessor.Context. mixinInfoMap
Methods in picocli.codegen.annotation.processing that return CommandLine.Model.CommandSpec Modifier and Type Method Description private CommandLine.Model.CommandSpec
AbstractCommandSpecProcessor. buildCommand(javax.lang.model.element.Element element, AbstractCommandSpecProcessor.Context context, javax.annotation.processing.RoundEnvironment roundEnv)
private static CommandLine.Model.CommandSpec
AbstractCommandSpecProcessor.Context. getOrCreateCommandSpecForArg(javax.lang.model.element.Element argElement, java.util.Map<javax.lang.model.element.Element,CommandLine.Model.CommandSpec> commands)
CommandLine.Model.CommandSpec
MixinInfo. mixin()
Methods in picocli.codegen.annotation.processing that return types with arguments of type CommandLine.Model.CommandSpec Modifier and Type Method Description private java.util.List<CommandLine.Model.CommandSpec>
AbstractCommandSpecProcessor. findSubcommands(java.util.List<? extends javax.lang.model.element.AnnotationMirror> annotationMirrors, AbstractCommandSpecProcessor.Context context, javax.annotation.processing.RoundEnvironment roundEnv)
Methods in picocli.codegen.annotation.processing with parameters of type CommandLine.Model.CommandSpec Modifier and Type Method Description private void
AbstractCommandSpecProcessor. buildOptionsAndPositionalsFromMethodParameters(javax.lang.model.element.ExecutableElement method, CommandLine.Model.CommandSpec result, AbstractCommandSpecProcessor.Context context)
void
ParameterConsumerMetaData. consumeParameters(java.util.Stack<java.lang.String> args, CommandLine.Model.ArgSpec argSpec, CommandLine.Model.CommandSpec commandSpec)
Does nothing.static void
DefaultValueProviderMetaData. initDefaultValueProvider(CommandLine.Model.CommandSpec result, CommandLine.Command cmd)
Sets the specifiedCommandSpec
's default value provider to aDefaultValueProviderMetaData
instance if the annotation attribute was present on the specifiedCommand
annotation.static void
VersionProviderMetaData. initVersionProvider(CommandLine.Model.CommandSpec result, CommandLine.Command cmd)
Sets the specifiedCommandSpec
's versionProvider(picocli.CommandLine.IVersionProvider) version provider} to aVersionProviderMetaData
instance if the annotation attribute was present on the specifiedCommand
annotation.private void
AbstractCommandSpecProcessor.Context. registerCommandType(CommandLine.Model.CommandSpec result, javax.lang.model.element.TypeElement typeElement)
private void
AbstractCommandSpecProcessor. updateCommandAttributes(CommandLine.Model.CommandSpec result, CommandLine.Command cmd)
private void
AbstractCommandSpecProcessor. updateCommandFromMethodElement(javax.lang.model.element.ExecutableElement method, AbstractCommandSpecProcessor.Context context, CommandLine.Model.CommandSpec result, javax.annotation.processing.RoundEnvironment roundEnv)
private void
AbstractCommandSpecProcessor. updateCommandSpecFromCommandAnnotation(CommandLine.Model.CommandSpec result, javax.lang.model.element.Element element, AbstractCommandSpecProcessor.Context context, javax.annotation.processing.RoundEnvironment roundEnv)
private void
AbstractCommandSpecProcessor. updateCommandSpecFromTypeElement(javax.lang.model.element.TypeElement typeElement, AbstractCommandSpecProcessor.Context context, CommandLine.Model.CommandSpec result, javax.annotation.processing.RoundEnvironment roundEnv)
Method parameters in picocli.codegen.annotation.processing with type arguments of type CommandLine.Model.CommandSpec Modifier and Type Method Description private static CommandLine.Model.CommandSpec
AbstractCommandSpecProcessor.Context. getOrCreateCommandSpecForArg(javax.lang.model.element.Element argElement, java.util.Map<javax.lang.model.element.Element,CommandLine.Model.CommandSpec> commands)
protected abstract boolean
AbstractCommandSpecProcessor. handleCommands(java.util.Map<javax.lang.model.element.Element,CommandLine.Model.CommandSpec> commands, java.util.Set<? extends javax.lang.model.element.TypeElement> annotations, javax.annotation.processing.RoundEnvironment roundEnv)
Subclasses must implement this method and do something with theCommandSpec
command model objects that were found during compilation.Constructors in picocli.codegen.annotation.processing with parameters of type CommandLine.Model.CommandSpec Constructor Description MixinInfo(javax.lang.model.element.VariableElement element, CommandLine.Model.CommandSpec mixin)
-
Uses of CommandLine.Model.CommandSpec in picocli.codegen.aot.graalvm
Methods in picocli.codegen.aot.graalvm with parameters of type CommandLine.Model.CommandSpec Modifier and Type Method Description static java.lang.String
DynamicProxyConfigGenerator. generateProxyConfig(CommandLine.Model.CommandSpec[] specs, java.lang.String[] interfaceClasses)
Returns a JSON String with the interface names to generate dynamic proxy classes for in the native image, used by the specifiedCommandSpec
objects.static java.lang.String
ReflectionConfigGenerator. generateReflectionConfig(CommandLine.Model.CommandSpec... specs)
Returns a JSON String with the program elements that will be accessed reflectively for the specifiedCommandSpec
objects.static java.lang.String
ResourceConfigGenerator. generateResourceConfig(CommandLine.Model.CommandSpec[] specs, java.lang.String[] bundles, java.lang.String[] resourceRegex)
Returns a JSON String with the resources and resource bundles to include for the specifiedCommandSpec
objects.(package private) void
DynamicProxyConfigGenerator.Visitor. visitCommandSpec(CommandLine.Model.CommandSpec spec)
(package private) void
ReflectionConfigGenerator.Visitor. visitCommandSpec(CommandLine.Model.CommandSpec spec)
(package private) void
ResourceConfigGenerator.Visitor. visitCommandSpec(CommandLine.Model.CommandSpec spec)
-
Uses of CommandLine.Model.CommandSpec in picocli.codegen.aot.graalvm.processor
Fields in picocli.codegen.aot.graalvm.processor with type parameters of type CommandLine.Model.CommandSpec Modifier and Type Field Description (package private) java.util.Map<javax.lang.model.element.Element,CommandLine.Model.CommandSpec>
AbstractCompositeGeneratorProcessor. allCommands
Methods in picocli.codegen.aot.graalvm.processor with parameters of type CommandLine.Model.CommandSpec Modifier and Type Method Description protected abstract java.lang.String
AbstractGenerator. generateConfig(CommandLine.Model.CommandSpec[] commands)
protected java.lang.String
ProxyConfigGen. generateConfig(CommandLine.Model.CommandSpec[] commands)
protected java.lang.String
ReflectConfigGen. generateConfig(CommandLine.Model.CommandSpec[] commands)
protected java.lang.String
ResourceConfigGen. generateConfig(CommandLine.Model.CommandSpec[] commands)
Method parameters in picocli.codegen.aot.graalvm.processor with type arguments of type CommandLine.Model.CommandSpec Modifier and Type Method Description void
AbstractGenerator. generate(java.util.Map<javax.lang.model.element.Element,CommandLine.Model.CommandSpec> allCommands)
void
IGenerator. generate(java.util.Map<javax.lang.model.element.Element,CommandLine.Model.CommandSpec> allCommands)
protected java.lang.String
AbstractGenerator. generateConfig(java.util.Map<javax.lang.model.element.Element,CommandLine.Model.CommandSpec> allCommands)
protected boolean
AbstractCompositeGeneratorProcessor. handleCommands(java.util.Map<javax.lang.model.element.Element,CommandLine.Model.CommandSpec> commands, java.util.Set<? extends javax.lang.model.element.TypeElement> annotations, javax.annotation.processing.RoundEnvironment roundEnv)
-
Uses of CommandLine.Model.CommandSpec in picocli.codegen.docgen.manpage
Fields in picocli.codegen.docgen.manpage declared as CommandLine.Model.CommandSpec Modifier and Type Field Description (package private) CommandLine.Model.CommandSpec
ManPageGenerator. spec
Methods in picocli.codegen.docgen.manpage with parameters of type CommandLine.Model.CommandSpec Modifier and Type Method Description (package private) static void
ManPageGenerator. genCommands(java.io.PrintWriter pw, CommandLine.Model.CommandSpec spec)
private static int
ManPageGenerator. generateCustomizableTemplate(ManPageGenerator.Config config, CommandLine.Model.CommandSpec spec)
static int
ManPageGenerator. generateManPage(java.io.File outdir, java.io.File customizablePagesDirectory, boolean[] verbosity, boolean overwriteCustomizablePages, CommandLine.Model.CommandSpec... specs)
Generates AsciiDoc files for the specified classes to the specified output directory, optionally also generating template files in thecustomizablePagesDirectory
directory.(package private) static int
ManPageGenerator. generateManPage(ManPageGenerator.Config config, CommandLine.Model.CommandSpec... specs)
private static int
ManPageGenerator. generateSingleManPage(ManPageGenerator.Config config, CommandLine.Model.CommandSpec spec)
private static void
ManPageGenerator. generateSingleManPage(CommandLine.Model.CommandSpec spec, java.io.File manpage)
(package private) static void
ManPageGenerator. genExitStatus(java.io.PrintWriter pw, CommandLine.Model.CommandSpec spec)
(package private) static void
ManPageGenerator. genFooter(java.io.PrintWriter pw, CommandLine.Model.CommandSpec spec)
(package private) static void
ManPageGenerator. genHeader(java.io.PrintWriter pw, CommandLine.Model.CommandSpec spec)
(package private) static void
ManPageGenerator. genOptions(java.io.PrintWriter pw, CommandLine.Model.CommandSpec spec)
(package private) static void
ManPageGenerator. genPositionalArgs(java.io.PrintWriter pw, CommandLine.Model.CommandSpec spec)
private static java.lang.String
ManPageGenerator. headerDescriptionString(CommandLine.Model.CommandSpec spec)
private static java.lang.String
ManPageGenerator. makeFileName(CommandLine.Model.CommandSpec spec)
private static java.lang.String
ManPageGenerator. manualTitle(CommandLine.Model.CommandSpec spec)
private static java.util.List<CommandLine.Model.ArgGroupSpec>
ManPageGenerator. optionListGroups(CommandLine.Model.CommandSpec commandSpec)
Returns the list ofArgGroupSpec
s with a non-null
heading.private static void
ManPageGenerator. traceAllSpecs(CommandLine.Model.CommandSpec[] specs, ManPageGenerator.Config config)
private static java.lang.String
ManPageGenerator. versionString(CommandLine.Model.CommandSpec spec)
(package private) static void
ManPageGenerator. writeCustomizableManPageTemplate(java.io.PrintWriter pw, java.io.File includeDir, CommandLine.Model.CommandSpec spec)
static void
ManPageGenerator. writeSingleManPage(java.io.PrintWriter pw, CommandLine.Model.CommandSpec spec)
-
Uses of CommandLine.Model.CommandSpec in picocli.codegen.util
Methods in picocli.codegen.util that return types with arguments of type CommandLine.Model.CommandSpec Modifier and Type Method Description static java.util.List<CommandLine.Model.CommandSpec>
Util. getCommandSpecs(java.lang.String factoryClass, java.lang.Class<?>[] classes)
-
Uses of CommandLine.Model.CommandSpec in picocli.shell.jline2
Fields in picocli.shell.jline2 declared as CommandLine.Model.CommandSpec Modifier and Type Field Description private CommandLine.Model.CommandSpec
PicocliJLineCompleter. spec
Constructors in picocli.shell.jline2 with parameters of type CommandLine.Model.CommandSpec Constructor Description PicocliJLineCompleter(CommandLine.Model.CommandSpec spec)
Constructs a newPicocliJLineCompleter
for the given command spec. -
Uses of CommandLine.Model.CommandSpec in picocli.shell.jline3
Fields in picocli.shell.jline3 declared as CommandLine.Model.CommandSpec Modifier and Type Field Description private CommandLine.Model.CommandSpec
PicocliJLineCompleter. spec
Constructors in picocli.shell.jline3 with parameters of type CommandLine.Model.CommandSpec Constructor Description PicocliJLineCompleter(CommandLine.Model.CommandSpec spec)
Constructs a newPicocliJLineCompleter
for the given command spec.
-