Index (spring-shell-standard 3.2.4 API)

A B C D E F G H I K N O P R S V Z
All Classes and Interfaces|All Packages|Constant Field Values

A

AbstractCompletions - Class in org.springframework.shell.standard.completion: Base class for completion script commands providing functionality for resource handling and templating with antrl stringtemplate.
AbstractCompletions(ResourceLoader, CommandCatalog) - Constructor for class org.springframework.shell.standard.completion.AbstractCompletions
AbstractShellComponent - Class in org.springframework.shell.standard: Base class helping to build shell components.
AbstractShellComponent() - Constructor for class org.springframework.shell.standard.AbstractShellComponent
afterPropertiesSet() - Method in class org.springframework.shell.standard.AbstractShellComponent
arity() - Element in annotation interface org.springframework.shell.standard.ShellOption: Return the number of input "words" this parameter consumes.
ARITY_USE_HEURISTICS - Static variable in annotation interface org.springframework.shell.standard.ShellOption: Marker value to indicate that heuristics should be used to derive arity.

B

BashCompletions - Class in org.springframework.shell.standard.completion: Completion script generator for a bash.
BashCompletions(ResourceLoader, CommandCatalog) - Constructor for class org.springframework.shell.standard.completion.BashCompletions
builder() - Method in class org.springframework.shell.standard.completion.AbstractCompletions

C

CommandValueProvider - Class in org.springframework.shell.standard: A ValueProvider that can be used to auto-complete names of shell commands.
CommandValueProvider(CommandCatalog) - Constructor for class org.springframework.shell.standard.CommandValueProvider
complete(CompletionContext) - Method in class org.springframework.shell.standard.CommandValueProvider
complete(CompletionContext) - Method in class org.springframework.shell.standard.EnumValueProvider
complete(CompletionContext) - Method in class org.springframework.shell.standard.FileValueProvider
complete(CompletionContext) - Method in interface org.springframework.shell.standard.ValueProvider: Complete completion proposals.
createNamedValueInfo(MethodParameter) - Method in class org.springframework.shell.standard.ShellOptionMethodArgumentResolver

D

defaultValue() - Element in annotation interface org.springframework.shell.standard.ShellOption: The textual (pre-conversion) value to assign to this parameter if no value is provided by the user.

E

EnumValueProvider - Class in org.springframework.shell.standard: A ValueProvider that knows how to complete values for Enum typed parameters.
EnumValueProvider() - Constructor for class org.springframework.shell.standard.EnumValueProvider

F

FileValueProvider - Class in org.springframework.shell.standard: A ValueProvider that can populate names of local Files, either absolute or relative to the current working directory.
FileValueProvider() - Constructor for class org.springframework.shell.standard.FileValueProvider

G

generate(String) - Method in class org.springframework.shell.standard.completion.BashCompletions
generate(String) - Method in class org.springframework.shell.standard.completion.ZshCompletions
generateCommandModel() - Method in class org.springframework.shell.standard.completion.AbstractCompletions: Generates a model for a recursive command model starting from root level going down with all sub commands with options.
getApplicationContext() - Method in class org.springframework.shell.standard.AbstractShellComponent
getCommandCatalog() - Method in class org.springframework.shell.standard.AbstractShellComponent
getCompletionResolver() - Method in class org.springframework.shell.standard.AbstractShellComponent
getResourceLoader() - Method in class org.springframework.shell.standard.AbstractShellComponent
getShell() - Method in class org.springframework.shell.standard.AbstractShellComponent
getTemplateExecutor() - Method in class org.springframework.shell.standard.AbstractShellComponent
getTerminal() - Method in class org.springframework.shell.standard.AbstractShellComponent
getThemeResolver() - Method in class org.springframework.shell.standard.AbstractShellComponent
getViewComponentBuilder() - Method in class org.springframework.shell.standard.AbstractShellComponent
group() - Element in annotation interface org.springframework.shell.standard.ShellMethod: The command group which this command belongs to.

H

handleMissingValue(List<String>, MethodParameter, Message<?>) - Method in class org.springframework.shell.standard.ShellOptionMethodArgumentResolver
help() - Element in annotation interface org.springframework.shell.standard.ShellOption: Return a short description of the parameter.

I

INHERIT_AND_INFER - Static variable in annotation interface org.springframework.shell.standard.ShellCommandGroup: The default value for the group label, which when set on a class, will mean to look at the package level on a package, to go back at the class level and infer a name from the class name.
INHERITED - Static variable in annotation interface org.springframework.shell.standard.ShellMethod: The default value for ShellMethod.group(), meaning that the group will be inherited from the explicit value set on the containing element (class then package) or ultimately inferred.
interactionMode() - Element in annotation interface org.springframework.shell.standard.ShellMethod: Defines interaction mode for a command as a hint when command should be available.

K

key() - Element in annotation interface org.springframework.shell.standard.ShellMethod: The name(s) by which this method can be invoked via Spring Shell.

N

NONE - Static variable in annotation interface org.springframework.shell.standard.ShellOption: Used to indicate that there is no default value (i.e. parameter is mandatory).
NULL - Static variable in annotation interface org.springframework.shell.standard.ShellOption: Used to indicate that the default value is the value null, which is different from the fact that there is no default value.

O

optOut() - Element in annotation interface org.springframework.shell.standard.ShellOption: Used to indicate to the framework that the given parameter should NOT be resolved by StandardParameterResolver.
org.springframework.shell.standard - package org.springframework.shell.standard: Contains infrastructure for describing commands with the "new" preferred Spring Shell programming model.
org.springframework.shell.standard.completion - package org.springframework.shell.standard.completion

P

prefix() - Element in annotation interface org.springframework.shell.standard.ShellMethod: The prefix to use for assigning parameters by name.

R

register(CommandCatalog) - Method in class org.springframework.shell.standard.StandardMethodTargetRegistrar
resolveArgumentInternal(MethodParameter, Message<?>, List<String>) - Method in class org.springframework.shell.standard.ShellOptionMethodArgumentResolver

S

setApplicationContext(ApplicationContext) - Method in class org.springframework.shell.standard.AbstractShellComponent
setResourceLoader(ResourceLoader) - Method in class org.springframework.shell.standard.AbstractShellComponent
ShellCommandGroup - Annotation Interface in org.springframework.shell.standard: Used to indicate the default group of shell commands, either at the package or class level.
ShellComponent - Annotation Interface in org.springframework.shell.standard: Indicates that an annotated class may contain shell methods (themselves annotated with ShellMethod) that is, methods that may be invoked reflectively by the shell.
ShellMethod - Annotation Interface in org.springframework.shell.standard: Used to mark a method as invokable via Spring Shell.
ShellMethodAvailability - Annotation Interface in org.springframework.shell.standard: Used to customize the name of the method used to indicate availability of a command.
ShellOption - Annotation Interface in org.springframework.shell.standard: Used to customize handling of a ShellMethod parameter.
ShellOption.NoValueProvider - Interface in org.springframework.shell.standard
ShellOptionMethodArgumentResolver - Class in org.springframework.shell.standard: Resolver for @ShellOption arguments.
ShellOptionMethodArgumentResolver(ConversionService, ConfigurableBeanFactory) - Constructor for class org.springframework.shell.standard.ShellOptionMethodArgumentResolver
StandardMethodTargetRegistrar - Class in org.springframework.shell.standard: The standard implementation of MethodTargetRegistrar for new shell applications, resolves methods annotated with ShellMethod on ShellComponent beans.
StandardMethodTargetRegistrar(ApplicationContext, CommandRegistration.BuilderSupplier) - Constructor for class org.springframework.shell.standard.StandardMethodTargetRegistrar
supportsParameter(MethodParameter) - Method in class org.springframework.shell.standard.ShellOptionMethodArgumentResolver

V

value() - Element in annotation interface org.springframework.shell.standard.ShellCommandGroup
value() - Element in annotation interface org.springframework.shell.standard.ShellComponent: Used to indicate a suggestion for a logical name for the component.
value() - Element in annotation interface org.springframework.shell.standard.ShellMethod: A description for the command.
value() - Element in annotation interface org.springframework.shell.standard.ShellMethodAvailability
value() - Element in annotation interface org.springframework.shell.standard.ShellOption: The key(s) by which this parameter can be referenced when using named parameters.
valueProvider() - Element in annotation interface org.springframework.shell.standard.ShellOption
ValueProvider - Interface in org.springframework.shell.standard: Beans implementing this interface are queried during TAB completion to gather possible values of a parameter.

Z

ZshCompletions - Class in org.springframework.shell.standard.completion: Completion script generator for a zsh.
ZshCompletions(ResourceLoader, CommandCatalog) - Constructor for class org.springframework.shell.standard.completion.ZshCompletions

A B C D E F G H I K N O P R S V Z
All Classes and Interfaces|All Packages|Constant Field Values