Index

A B C D E F G H I K N O P Q 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

bash() - Method in class org.springframework.shell.standard.commands.Completion

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

clear() - Method in class org.springframework.shell.standard.commands.Clear

Clear - Class in org.springframework.shell.standard.commands

ANSI console related commands.

Clear() - Constructor for class org.springframework.shell.standard.commands.Clear

Clear.Command - Interface in org.springframework.shell.standard.commands

Marker interface for beans providing clear functionality to the shell.

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.

Completion - Class in org.springframework.shell.standard.commands

Command to create a shell completion files, i.e. for bash.

Completion(String) - Constructor for class org.springframework.shell.standard.commands.Completion

Completion.Command - Interface in org.springframework.shell.standard.commands

Marker interface used in auto-config.

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.

help(String[]) - Method in class org.springframework.shell.standard.commands.Help

Help - Class in org.springframework.shell.standard.commands

A command to display help about all available commands.

Help(TemplateExecutor) - Constructor for class org.springframework.shell.standard.commands.Help

Help.Command - Interface in org.springframework.shell.standard.commands

Marker interface for beans providing help functionality to the shell.

history(File) - Method in class org.springframework.shell.standard.commands.History

History - Class in org.springframework.shell.standard.commands

A command that displays all previously run commands, optionally dumping to a file readable by Script.

History(History) - Constructor for class org.springframework.shell.standard.commands.History

History.Command - Interface in org.springframework.shell.standard.commands

Marker interface for beans providing history functionality to the shell.

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.commands - package org.springframework.shell.standard.commands

Contains default commands that ought to apply to each shell app.

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.

Q

quit() - Method in class org.springframework.shell.standard.commands.Quit

Quit - Class in org.springframework.shell.standard.commands

A command that terminates the running shell.

Quit() - Constructor for class org.springframework.shell.standard.commands.Quit

Quit.Command - Interface in org.springframework.shell.standard.commands

Marker interface for beans providing quit functionality to the shell.

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

script(File) - Method in class org.springframework.shell.standard.commands.Script

Script - Class in org.springframework.shell.standard.commands

A command that can read and execute other commands from a file.

Script(Parser) - Constructor for class org.springframework.shell.standard.commands.Script

Script.Command - Interface in org.springframework.shell.standard.commands

Marker interface for beans providing script functionality to the shell.

setApplicationContext(ApplicationContext) - Method in class org.springframework.shell.standard.AbstractShellComponent

setBuildProperties(BuildProperties) - Method in class org.springframework.shell.standard.commands.Version

setCommandsTemplate(String) - Method in class org.springframework.shell.standard.commands.Help

Sets a location for a template rendering commands help.

setCommandTemplate(String) - Method in class org.springframework.shell.standard.commands.Help

Sets a location for a template rendering command help.

setGitProperties(GitProperties) - Method in class org.springframework.shell.standard.commands.Version

setResourceLoader(ResourceLoader) - Method in class org.springframework.shell.standard.AbstractShellComponent

setResourceLoader(ResourceLoader) - Method in class org.springframework.shell.standard.commands.Completion

setShowBuildArtifact(boolean) - Method in class org.springframework.shell.standard.commands.Version

setShowBuildGroup(boolean) - Method in class org.springframework.shell.standard.commands.Version

setShowBuildName(boolean) - Method in class org.springframework.shell.standard.commands.Version

setShowBuildTime(boolean) - Method in class org.springframework.shell.standard.commands.Version

setShowBuildVersion(boolean) - Method in class org.springframework.shell.standard.commands.Version

setShowGitBranch(boolean) - Method in class org.springframework.shell.standard.commands.Version

setShowGitCommitId(boolean) - Method in class org.springframework.shell.standard.commands.Version

setShowGitCommitTime(boolean) - Method in class org.springframework.shell.standard.commands.Version

setShowGitShortCommitId(boolean) - Method in class org.springframework.shell.standard.commands.Version

setShowGroups(boolean) - Method in class org.springframework.shell.standard.commands.Help

Sets if groups should be shown in a listing, defaults to true.

setTemplate(String) - Method in class org.springframework.shell.standard.commands.Version

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

stacktrace() - Method in class org.springframework.shell.standard.commands.Stacktrace

Stacktrace - Class in org.springframework.shell.standard.commands

A command to display the full stacktrace when an error occurs.

Stacktrace(ObjectProvider<ThrowableResultHandler>) - Constructor for class org.springframework.shell.standard.commands.Stacktrace

Stacktrace.Command - Interface in org.springframework.shell.standard.commands

Marker interface for beans providing stacktrace functionality to the shell.

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.

version() - Method in class org.springframework.shell.standard.commands.Version

Version - Class in org.springframework.shell.standard.commands

Command to list version and other build related infos.

Version(TemplateExecutor) - Constructor for class org.springframework.shell.standard.commands.Version

Version.Command - Interface in org.springframework.shell.standard.commands

Marker interface used in auto-config.

Z

zsh() - Method in class org.springframework.shell.standard.commands.Completion

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 Q R S V Z
All Classes and Interfaces|All Packages|Constant Field Values