- AbsoluteWidthSizeConstraints - Class in org.springframework.shell.table
-
A cell sizing strategy that forces a fixed width, expressed in number of characters.
- AbsoluteWidthSizeConstraints(int) - Constructor for class org.springframework.shell.table.AbsoluteWidthSizeConstraints
-
- 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, CommandRegistry, List<ParameterResolver>) - Constructor for class org.springframework.shell.standard.completion.AbstractCompletions
-
- AbstractComponent<T extends ComponentContext<T>> - Class in org.springframework.shell.component.support
-
Base class for components.
- AbstractComponent(Terminal) - Constructor for class org.springframework.shell.component.support.AbstractComponent
-
- AbstractSelectorComponent<T,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>,I extends Nameable & Matchable & Enableable & Itemable<T>> - Class in org.springframework.shell.component.support
-
Base component for selectors which provide selectable lists.
- AbstractSelectorComponent(Terminal, String, List<I>, boolean, Comparator<I>) - Constructor for class org.springframework.shell.component.support.AbstractSelectorComponent
-
- AbstractSelectorComponent.BaseSelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>> - Class in org.springframework.shell.component.support
-
- AbstractSelectorComponent.ItemState<I extends Matchable> - Class in org.springframework.shell.component.support
-
Class keeping item state.
- AbstractSelectorComponent.SelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>> - Interface in org.springframework.shell.component.support
-
Context interface on a selector component sharing content.
- AbstractShellComponent - Class in org.springframework.shell.standard
-
Base class helping to build shell components.
- AbstractShellComponent() - Constructor for class org.springframework.shell.standard.AbstractShellComponent
-
- AbstractTextComponent<T,C extends AbstractTextComponent.TextComponentContext<T,C>> - Class in org.springframework.shell.component.support
-
Base class for components which work on a simple text input.
- AbstractTextComponent(Terminal) - Constructor for class org.springframework.shell.component.support.AbstractTextComponent
-
- AbstractTextComponent(Terminal, String) - Constructor for class org.springframework.shell.component.support.AbstractTextComponent
-
- AbstractTextComponent(Terminal, String, Function<C, List<AttributedString>>) - Constructor for class org.springframework.shell.component.support.AbstractTextComponent
-
- AbstractTextComponent.BaseTextComponentContext<T,C extends AbstractTextComponent.TextComponentContext<T,C>> - Class in org.springframework.shell.component.support
-
- AbstractTextComponent.TextComponentContext<T,C extends AbstractTextComponent.TextComponentContext<T,C>> - Interface in org.springframework.shell.component.support
-
- AbstractTextComponent.TextComponentContext.MessageLevel - Enum in org.springframework.shell.component.support
-
Message levels which can be used to alter how message is shown.
- addAligner(Aligner) - Method in class org.springframework.shell.table.TableBuilder.CellMatcherStub
-
- addFormatter(Formatter) - Method in class org.springframework.shell.table.TableBuilder.CellMatcherStub
-
- addFullBorder(BorderStyle) - Method in class org.springframework.shell.table.TableBuilder
-
Set a border around each and every cell of the table.
- addHeaderAndVerticalsBorders(BorderStyle) - Method in class org.springframework.shell.table.TableBuilder
-
Set a border on the outline of the whole table, around the first row and draw vertical lines
around each column.
- addHeaderBorder(BorderStyle) - Method in class org.springframework.shell.table.TableBuilder
-
Set a border on the outline of the whole table, as well as around the first row.
- addInnerBorder(BorderStyle) - Method in class org.springframework.shell.table.TableBuilder
-
Set a border on the inner verticals and horizontals of the table, but not on the outline.
- addOutlineBorder(BorderStyle) - Method in class org.springframework.shell.table.TableBuilder
-
Set a border on the outline of the whole table.
- addPostRunHandler(Consumer<T>) - Method in class org.springframework.shell.component.support.AbstractComponent
-
Adds a post-run handler.
- addPreRunHandler(Consumer<T>) - Method in class org.springframework.shell.component.support.AbstractComponent
-
Adds a pre-run handler.
- addResultHandler(ResultHandler<?>) - Method in class org.springframework.shell.result.GenericResultHandlerService
-
Add a plain result handler to this registry.
- addResultHandler(Class<T>, ResultHandler<? super T>) - Method in class org.springframework.shell.result.GenericResultHandlerService
-
Add a plain result handler to this registry.
- addResultHandler(GenericResultHandler) - Method in class org.springframework.shell.result.GenericResultHandlerService
-
Add a generic result handler this this registry.
- addRow() - Method in class org.springframework.shell.table.TableModelBuilder
-
- addSizer(SizeConstraints) - Method in class org.springframework.shell.table.TableBuilder.CellMatcherStub
-
- addValue(T) - Method in class org.springframework.shell.table.TableModelBuilder
-
- addWrapper(TextWrapper) - Method in class org.springframework.shell.table.TableBuilder.CellMatcherStub
-
- afterPropertiesSet() - Method in class org.springframework.shell.standard.AbstractShellComponent
-
- align(String[], int, int) - Method in interface org.springframework.shell.table.Aligner
-
Perform text alignment, returning a String array that MUST contain cellHeight
lines, each of which MUST be cellWidth chars in length.
- align(String[], int, int) - Method in class org.springframework.shell.table.DebugAligner
-
- align(String[], int, int) - Method in class org.springframework.shell.table.KeyValueHorizontalAligner
-
- align(String[], int, int) - Method in enum org.springframework.shell.table.SimpleHorizontalAligner
-
- align(String[], int, int) - Method in enum org.springframework.shell.table.SimpleVerticalAligner
-
- Aligner - Interface in org.springframework.shell.table
-
A strategy interface for performing text alignment.
- and() - Method in class org.springframework.shell.table.TableBuilder.CellMatcherStub
-
- applicationContext - Variable in class org.springframework.shell.Shell
-
- ARITY_USE_HEURISTICS - Static variable in annotation type org.springframework.shell.standard.ShellOption
-
Marker value to indicate that heuristics should be used to derive arity.
- ArrayTableModel - Class in org.springframework.shell.table
-
A TableModel backed by a row-first array.
- ArrayTableModel(Object[][]) - Constructor for class org.springframework.shell.table.ArrayTableModel
-
- at(int, int) - Static method in class org.springframework.shell.table.CellMatchers
-
- AttributedCharSequenceResultHandler - Class in org.springframework.shell.result
-
A
ResultHandler that knows how to render JLine's
AttributedCharSequence.
- AttributedCharSequenceResultHandler(Terminal) - Constructor for class org.springframework.shell.result.AttributedCharSequenceResultHandler
-
- attributedCharSequenceResultHandler(Terminal) - Method in class org.springframework.shell.result.ResultHandlerConfig
-
- AutoSizeConstraints - Class in org.springframework.shell.table
-
A SizeConstraints implementation that splits lines at space boundaries
and returns an extent with minimal and maximal width requirements.
- AutoSizeConstraints() - Constructor for class org.springframework.shell.table.AutoSizeConstraints
-
- Availability - Class in org.springframework.shell
-
Indicates whether or not a command is currently available.
- available() - Static method in class org.springframework.shell.Availability
-
- canRun(ApplicationArguments) - Method in class org.springframework.shell.jline.InteractiveShellRunner
-
- canRun(ApplicationArguments) - Method in class org.springframework.shell.jline.NonInteractiveShellRunner
-
- canRun(ApplicationArguments) - Method in class org.springframework.shell.jline.ScriptShellRunner
-
- canRun(ApplicationArguments) - Method in interface org.springframework.shell.ShellRunner
-
Checks if a particular shell runner can execute.
- category() - Method in class org.springframework.shell.CompletionProposal
-
- category(String) - Method in class org.springframework.shell.CompletionProposal
-
- CellMatcher - Interface in org.springframework.shell.table
-
This is used to specify where some components of a Table may be applied.
- CellMatchers - Class in org.springframework.shell.table
-
Contains factory methods for commonly used
CellMatchers.
- CellMatchers() - Constructor for class org.springframework.shell.table.CellMatchers
-
- Clear - Class in org.springframework.shell.standard.commands
-
ANSI console related commands.
- Clear() - Constructor for class org.springframework.shell.standard.commands.Clear
-
- clear() - Method in 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.
- close() - Method in class org.springframework.shell.jline.FileInputProvider
-
- column(int) - Static method in class org.springframework.shell.table.CellMatchers
-
- Command - Interface in org.springframework.shell
-
- Command.Help - Class in org.springframework.shell
-
Encapsulates help metadata about a shell command.
- CommandNotCurrentlyAvailable - Exception in org.springframework.shell
-
Indicates that a command exists but is currently not invokable.
- CommandNotCurrentlyAvailable(String, Availability) - Constructor for exception org.springframework.shell.CommandNotCurrentlyAvailable
-
- CommandNotFound - Exception in org.springframework.shell
-
A result to be handled by the
ResultHandler when no command could be mapped to user input
- CommandNotFound(List<String>) - Constructor for exception org.springframework.shell.CommandNotFound
-
- CommandRegistry - Interface in org.springframework.shell
-
Implementing this interface allows sub-systems (such as the help command) to
discover available commands.
- CommandValueProvider - Class in org.springframework.shell.standard
-
A
ValueProvider that can be used to auto-complete names of shell commands.
- CommandValueProvider(CommandRegistry) - Constructor for class org.springframework.shell.standard.CommandValueProvider
-
- complete(MethodParameter, CompletionContext) - Method in class org.springframework.shell.jcommander.JCommanderParameterResolver
-
- complete(MethodParameter, CompletionContext) - Method in interface org.springframework.shell.ParameterResolver
-
Invoked during TAB completion.
- complete(CompletionContext) - Method in class org.springframework.shell.Shell
-
Gather completion proposals given some (incomplete) input the user has already typed
in.
- complete(MethodParameter, CompletionContext, String[]) - Method in class org.springframework.shell.standard.CommandValueProvider
-
- complete(MethodParameter, CompletionContext, String[]) - Method in class org.springframework.shell.standard.EnumValueProvider
-
- complete(MethodParameter, CompletionContext, String[]) - Method in class org.springframework.shell.standard.FileValueProvider
-
- complete(MethodParameter, CompletionContext) - Method in class org.springframework.shell.standard.StandardParameterResolver
-
- complete(MethodParameter, CompletionContext, String[]) - Method in interface org.springframework.shell.standard.ValueProvider
-
- CompletingParsedLine - Interface in org.springframework.shell
-
An extension of ParsedLine that, being aware of the quoting and escaping rules
of the Parser that produced it, knows if and how a completion candidate
should be escaped/quoted.
- Completion - Class in org.springframework.shell.standard.commands
-
Command to create a shell completion files, i.e.
- 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.
- CompletionContext - Class in org.springframework.shell
-
Represents the buffer context in which completion was triggered.
- CompletionContext(List<String>, int, int) - Constructor for class org.springframework.shell.CompletionContext
-
- CompletionProposal - Class in org.springframework.shell
-
Represents a proposal for TAB completion, made not only of the text to append, but also metadata about the proposal.
- CompletionProposal(String) - Constructor for class org.springframework.shell.CompletionProposal
-
- ComponentContext<C extends ComponentContext<C>> - Interface in org.springframework.shell.component.context
-
Contract for base component context having access to basic key/value pairs.
- ConfigurableCommandRegistry - Class in org.springframework.shell
-
- ConfigurableCommandRegistry(ShellContext) - Constructor for class org.springframework.shell.ConfigurableCommandRegistry
-
- configureKeyValueRendering(TableBuilder, String) - Static method in class org.springframework.shell.table.Tables
-
Install all the necessary formatters, aligners, etc for key-value rendering of Maps.
- ConfirmationInput - Class in org.springframework.shell.component
-
Component for a confirmation question.
- ConfirmationInput(Terminal) - Constructor for class org.springframework.shell.component.ConfirmationInput
-
- ConfirmationInput(Terminal, String) - Constructor for class org.springframework.shell.component.ConfirmationInput
-
- ConfirmationInput(Terminal, String, boolean) - Constructor for class org.springframework.shell.component.ConfirmationInput
-
- ConfirmationInput(Terminal, String, boolean, Function<ConfirmationInput.ConfirmationInputContext, List<AttributedString>>) - Constructor for class org.springframework.shell.component.ConfirmationInput
-
- ConfirmationInput.ConfirmationInputContext - Interface in org.springframework.shell.component
-
- createMethodParameter(Parameter) - Static method in class org.springframework.shell.Utils
-
Convert from JDK
Parameter to Spring
MethodParameter.
- createMethodParameter(Executable, int) - Static method in class org.springframework.shell.Utils
-
Return a properly initialized MethodParameter for the given executable and index.
- createMethodParameters(Executable) - Static method in class org.springframework.shell.Utils
-
Return MethodParameters for each parameter of the given method/constructor.
- currentWord() - Method in class org.springframework.shell.CompletionContext
-
Return the whole word the cursor is in, or null if the cursor is past the last word.
- currentWordUpToCursor() - Method in class org.springframework.shell.CompletionContext
-
- cursor() - Method in class org.springframework.shell.jline.ExtendedDefaultParser.ExtendedArgumentList
-
- rawText() - Method in interface org.springframework.shell.Input
-
Return the input as entered by the user.
- read(BindingReader, KeyMap<String>, ConfirmationInput.ConfirmationInputContext) - Method in class org.springframework.shell.component.ConfirmationInput
-
- read(BindingReader, KeyMap<String>, PathInput.PathInputContext) - Method in class org.springframework.shell.component.PathInput
-
- read(BindingReader, KeyMap<String>, StringInput.StringInputContext) - Method in class org.springframework.shell.component.StringInput
-
- read(BindingReader, KeyMap<String>, T) - Method in class org.springframework.shell.component.support.AbstractComponent
-
Read input.
- read(BindingReader, KeyMap<String>, C) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent
-
- readInput() - Method in interface org.springframework.shell.InputProvider
-
Return text entered by user to invoke commands.
- readInput() - Method in class org.springframework.shell.jline.FileInputProvider
-
- readInput() - Method in class org.springframework.shell.jline.InteractiveShellRunner.JLineInputProvider
-
- register(String, MethodTarget) - Method in class org.springframework.shell.ConfigurableCommandRegistry
-
- register(ConfigurableCommandRegistry) - Method in interface org.springframework.shell.MethodTargetRegistrar
-
Register mappings from <command keyword(s)> to actual behavior.
- register(ConfigurableCommandRegistry) - Method in class org.springframework.shell.standard.StandardMethodTargetRegistrar
-
- register(Theme) - Method in class org.springframework.shell.style.ThemeRegistry
-
Register a theme.
- render(T) - Method in class org.springframework.shell.component.support.AbstractComponent
-
Render to be shows content of a display with set display renderer using a
given context.
- render(String, Map<String, Object>) - Method in class org.springframework.shell.style.TemplateExecutor
-
Render template with a given attributes.
- render(int) - Method in class org.springframework.shell.table.Table
-
- render(int) - Method in interface org.springframework.shell.TerminalSizeAware
-
- renderGroup(String, Map<String, Object>) - Method in class org.springframework.shell.style.TemplateExecutor
-
Render template group with a given attributes expecting to find instance
named main.
- renderTemplateResource(Map<String, Object>) - Method in class org.springframework.shell.component.support.AbstractComponent
-
Render a given template with attributes.
- resolve(MethodParameter, List<String>) - Method in class org.springframework.shell.jcommander.JCommanderParameterResolver
-
- resolve(MethodParameter, List<String>) - Method in interface org.springframework.shell.ParameterResolver
-
Turn the given textual input into an actual object, maybe using some conversion or lookup mechanism.
- resolve(MethodParameter, List<String>) - Method in class org.springframework.shell.standard.StandardParameterResolver
-
- resolvedValue() - Method in class org.springframework.shell.ValueResult
-
Represents the resolved value for the MethodParameter associated with this result.
- resolvePath(String) - Method in class org.springframework.shell.component.PathInput
-
Resolves a
Path from a given raw
path.
- resolveStyle(String) - Method in class org.springframework.shell.style.ThemeResolver
-
Resolve AttributedStyle from a spec.
- resolveTag(String) - Method in class org.springframework.shell.style.ThemeResolver
-
Resolve style from a tag with activated theme.
- resolveTag(String) - Method in class org.springframework.shell.style.ThemeSettings
-
Resolve a theme setting from a given tag.
- ResultHandler<T> - Interface in org.springframework.shell
-
Implementations know how to deal with results of method invocations, whether normal results or exceptions thrown.
- ResultHandlerConfig - Class in org.springframework.shell.result
-
- ResultHandlerConfig() - Constructor for class org.springframework.shell.result.ResultHandlerConfig
-
- ResultHandlerNotFoundException - Exception in org.springframework.shell.result
-
- ResultHandlerNotFoundException(TypeDescriptor) - Constructor for exception org.springframework.shell.result.ResultHandlerNotFoundException
-
Create a new handling executor not found exception.
- ResultHandlerService - Interface in org.springframework.shell
-
A service interface for result handling.
- ResultHandlingException - Exception in org.springframework.shell.result
-
- ResultHandlingException(String) - Constructor for exception org.springframework.shell.result.ResultHandlingException
-
Construct a new result handling exception.
- ResultHandlingException(String, Throwable) - Constructor for exception org.springframework.shell.result.ResultHandlingException
-
Construct a new result handling exception.
- RIGHT - Static variable in class org.springframework.shell.table.BorderSpecification
-
- row(int) - Static method in class org.springframework.shell.table.CellMatchers
-
- run(ComponentContext<?>) - Method in class org.springframework.shell.component.support.AbstractComponent
-
Runs a component logic with a given context and returns updated context.
- run(ApplicationArguments) - Method in class org.springframework.shell.DefaultShellApplicationRunner
-
- run(ApplicationArguments) - Method in class org.springframework.shell.jline.InteractiveShellRunner
-
- run(ApplicationArguments) - Method in class org.springframework.shell.jline.NonInteractiveShellRunner
-
- run(ApplicationArguments) - Method in class org.springframework.shell.jline.ScriptShellRunner
-
- run(InputProvider) - Method in class org.springframework.shell.Shell
-
The main program loop: acquire input, try to match it to a command and evaluate.
- run(ApplicationArguments) - Method in interface org.springframework.shell.ShellRunner
-
Execute application.
- runInternal(MultiItemSelector.MultiItemSelectorContext<T, I>) - Method in class org.springframework.shell.component.MultiItemSelector
-
- runInternal(SingleItemSelector.SingleItemSelectorContext<T, I>) - Method in class org.springframework.shell.component.SingleItemSelector
-
- runInternal(T) - Method in class org.springframework.shell.component.support.AbstractComponent
-
Run internal logic called from public run method.
- runInternal(C) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent
-
- runInternal(C) - Method in class org.springframework.shell.component.support.AbstractTextComponent
-
- runPostRunHandlers(T) - Method in class org.springframework.shell.component.support.AbstractComponent
-
Run post-run handlers
- runPreRunHandlers(T) - Method in class org.springframework.shell.component.support.AbstractComponent
-
Run pre-run handlers
- sanitizeInput(List<String>) - Static method in class org.springframework.shell.Utils
-
Sanitize the buffer input given the customizations applied to the JLine
parser (e.g. support for
line continuations, etc.)
- 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(File) - Method in 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.
- ScriptShellRunner - Class in org.springframework.shell.jline
-
A
ShellRunner that looks for process arguments that start with @, which are then interpreted as
references to script files to run and exit.
- ScriptShellRunner(Parser, Shell) - Constructor for class org.springframework.shell.jline.ScriptShellRunner
-
- SelectorItem<T> - Interface in org.springframework.shell.component.support
-
- SelectorItem.SelectorItemWrapper<T> - Class in org.springframework.shell.component.support
-
- SelectorItemWrapper(String, T) - Constructor for class org.springframework.shell.component.support.SelectorItem.SelectorItemWrapper
-
- SelectorItemWrapper(String, T, boolean) - Constructor for class org.springframework.shell.component.support.SelectorItem.SelectorItemWrapper
-
- setApplicationContext(ApplicationContext) - Method in class org.springframework.shell.standard.AbstractShellComponent
-
- setApplicationContext(ApplicationContext) - Method in class org.springframework.shell.standard.StandardMethodTargetRegistrar
-
- setBuildProperties(BuildProperties) - Method in class org.springframework.shell.standard.commands.Version
-
- setCommandsFromInputArgs(Function<ApplicationArguments, List<String>>) - Method in class org.springframework.shell.jline.NonInteractiveShellRunner
-
Sets the function that creates the command() to run from the input application arguments.
- setCursorRow(Integer) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext
-
- setCursorRow(Integer) - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext
-
Sets a cursor row.
- setDefaultValue(Boolean) - Method in interface org.springframework.shell.component.ConfirmationInput.ConfirmationInputContext
-
Sets a default value.
- setDefaultValue(String) - Method in interface org.springframework.shell.component.StringInput.StringInputContext
-
Sets a default value.
- setEofOnEscapedNewLine(boolean) - Method in class org.springframework.shell.jline.ExtendedDefaultParser
-
- setEofOnUnclosedQuote(boolean) - Method in class org.springframework.shell.jline.ExtendedDefaultParser
-
- setEscapeChars(char[]) - Method in class org.springframework.shell.jline.ExtendedDefaultParser
-
- setGitProperties(GitProperties) - Method in class org.springframework.shell.standard.commands.Version
-
- setInput(String) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext
-
- setInput(String) - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext
-
Sets an input.
- setInput(String) - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext
-
- setInput(String) - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext
-
Sets an input.
- setInteractionMode(InteractionMode) - Method in class org.springframework.shell.context.DefaultShellContext
-
- setInteractionMode(InteractionMode) - Method in interface org.springframework.shell.context.ShellContext
-
Sets an interaction mode.
- setItemMapper(Function<T, String>) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent
-
Sets an item mapper.
- setItems(List<I>) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext
-
- setItems(List<I>) - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext
-
Sets an items.
- setItemStates(List<AbstractSelectorComponent.ItemState<I>>) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext
-
- setItemStates(List<AbstractSelectorComponent.ItemState<I>>) - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext
-
Sets an item states.
- setItemStateView(List<AbstractSelectorComponent.ItemState<I>>) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext
-
- setItemStateView(List<AbstractSelectorComponent.ItemState<I>>) - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext
-
Sets an item state view
- setLineParser(Parser) - Method in class org.springframework.shell.jline.NonInteractiveShellRunner
-
Sets the line parser used to parse commands.
- setMaskCharacter(Character) - Method in interface org.springframework.shell.component.StringInput.StringInputContext
-
Sets a mask character.
- setMaskCharater(Character) - Method in class org.springframework.shell.component.StringInput
-
Sets a mask character for input and result value.
- setMaxItems(int) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent
-
Set max items to show.
- setMessage(String) - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext
-
- setMessage(String, AbstractTextComponent.TextComponentContext.MessageLevel) - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext
-
- setMessage(String) - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext
-
Sets a message.
- setMessage(String, AbstractTextComponent.TextComponentContext.MessageLevel) - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext
-
Sets a message with level.
- setMessageLevel(AbstractTextComponent.TextComponentContext.MessageLevel) - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext
-
- setMessageLevel(AbstractTextComponent.TextComponentContext.MessageLevel) - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext
-
- setName(String) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext
-
- setName(String) - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext
-
Sets a name
- setName(String) - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext
-
- setName(String) - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext
-
Sets a name.
- setParameterResolvers(List<ParameterResolver>) - Method in class org.springframework.shell.Shell
-
- setPathProvider(Function<String, Path>) - Method in class org.springframework.shell.component.PathInput
-
Sets a path provider.
- setPrintResults(boolean) - Method in class org.springframework.shell.component.support.AbstractComponent
-
Sets if results should be printed into a console, Defaults to true.
- setQuoteChars(char[]) - Method in class org.springframework.shell.jline.ExtendedDefaultParser
-
- setRenderer(Function<T, List<AttributedString>>) - Method in class org.springframework.shell.component.support.AbstractComponent
-
Sets a display renderer.
- setResourceLoader(ResourceLoader) - Method in class org.springframework.shell.component.support.AbstractComponent
-
- setResourceLoader(ResourceLoader) - Method in class org.springframework.shell.standard.AbstractShellComponent
-
- setResourceLoader(ResourceLoader) - Method in class org.springframework.shell.standard.commands.Completion
-
- setResultItems(List<I>) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext
-
- setResultItems(List<I>) - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext
-
Sets a result items.
- setResultValue(T) - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext
-
- setResultValue(T) - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext
-
Sets a result value.
- 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
-
- setTemplateExecutor(TemplateExecutor) - Method in class org.springframework.shell.component.support.AbstractComponent
-
Sets a template executor.
- setTemplateLocation(String) - Method in class org.springframework.shell.component.support.AbstractComponent
-
Sets a template location.
- setValidatorFactory(ValidatorFactory) - Method in class org.springframework.shell.jcommander.JCommanderParameterResolver
-
- setValidatorFactory(ValidatorFactory) - Method in class org.springframework.shell.Shell
-
- setValidatorFactory(ValidatorFactory) - Method in class org.springframework.shell.standard.commands.Help
-
- setValidatorFactory(ValidatorFactory) - Method in class org.springframework.shell.standard.StandardParameterResolver
-
- Shell - Class in org.springframework.shell
-
Main class implementing a shell loop.
- Shell(ResultHandlerService, CommandRegistry) - Constructor for class org.springframework.shell.Shell
-
- ShellApplicationRunner - Interface in org.springframework.shell
-
Marker interface for a main spring shell ApplicationRunner.
- ShellCommandGroup - Annotation Type in org.springframework.shell.standard
-
Used to indicate the default group of shell commands, either at the package or class level.
- ShellComponent - Annotation Type 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.
- ShellContext - Interface in org.springframework.shell.context
-
Interface defining a contract for a context which allows to loosely connect
different components together and keep things alive between commands.
- ShellMethod - Annotation Type in org.springframework.shell.standard
-
Used to mark a method as invokable via Spring Shell.
- ShellMethodAvailability - Annotation Type in org.springframework.shell.standard
-
Used to customize the name of the method used to indicate availability of a command.
- ShellOption - Annotation Type in org.springframework.shell.standard
-
- ShellOption.NoValueProvider - Interface in org.springframework.shell.standard
-
- ShellRunner - Interface in org.springframework.shell
-
Interface for shell runners.
- SimpleHorizontalAligner - Enum in org.springframework.shell.table
-
An horizontal alignment strategy that allows alignment to the left, center or right.
- SimpleVerticalAligner - Enum in org.springframework.shell.table
-
Alignment strategy that allows simple vertical alignment to top, middle or bottom.
- SingleItemSelector<T,I extends Nameable & Matchable & Enableable & Itemable<T>> - Class in org.springframework.shell.component
-
Component able to pick single item.
- SingleItemSelector(Terminal, List<I>, String, Comparator<I>) - Constructor for class org.springframework.shell.component.SingleItemSelector
-
- SingleItemSelector.SingleItemSelectorContext<T,I extends Nameable & Matchable & Itemable<T>> - Interface in org.springframework.shell.component
-
- SizeConstraints - Interface in org.springframework.shell.table
-
Strategy for computing the dimensions of a table cell.
- SizeConstraints.Extent - Class in org.springframework.shell.table
-
Holds both a minimum and maximum width.
- 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() - Method in 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
-
- StandardMethodTargetRegistrar() - Constructor for class org.springframework.shell.standard.StandardMethodTargetRegistrar
-
- StandardParameterResolver - Class in org.springframework.shell.standard
-
Default ParameterResolver implementation that supports the following features:
named parameters (recognized because they start with some
ShellMethod.prefix())
implicit named parameters (from the actual method parameter name)
positional parameters (in order, for all parameter values that were not resolved
via named parameters)
default values (for all remaining parameters)
- StandardParameterResolver(ConversionService, Set<ValueProvider>) - Constructor for class org.springframework.shell.standard.StandardParameterResolver
-
- status() - Method in exception org.springframework.shell.ExitRequest
-
The exit code to be returned when the process exits.
- stream() - Method in class org.springframework.shell.component.context.BaseComponentContext
-
- stream() - Method in interface org.springframework.shell.component.context.ComponentContext
-
- StringInput - Class in org.springframework.shell.component
-
Component for a simple string input.
- StringInput(Terminal) - Constructor for class org.springframework.shell.component.StringInput
-
- StringInput(Terminal, String, String) - Constructor for class org.springframework.shell.component.StringInput
-
- StringInput(Terminal, String, String, Function<StringInput.StringInputContext, List<AttributedString>>) - Constructor for class org.springframework.shell.component.StringInput
-
- StringInput.StringInputContext - Interface in org.springframework.shell.component
-
- StringToStyleExpressionRenderer - Class in org.springframework.shell.style
-
ST AttributeRenderer which knows to use format string to
render strings into jline StyleExpression based on theming
settings.
- StringToStyleExpressionRenderer(ThemeResolver) - Constructor for class org.springframework.shell.style.StringToStyleExpressionRenderer
-
- supports(MethodParameter) - Method in class org.springframework.shell.jcommander.JCommanderParameterResolver
-
- supports(MethodParameter) - Method in interface org.springframework.shell.ParameterResolver
-
Should return true if this resolver recognizes the given method parameter (e.g. it
has the correct annotation or the correct type).
- supports(MethodParameter, CompletionContext) - Method in class org.springframework.shell.standard.EnumValueProvider
-
- supports(MethodParameter, CompletionContext) - Method in class org.springframework.shell.standard.FileValueProvider
-
- supports(MethodParameter) - Method in class org.springframework.shell.standard.StandardParameterResolver
-
- supports(MethodParameter, CompletionContext) - Method in interface org.springframework.shell.standard.ValueProvider
-
- supports(MethodParameter, CompletionContext) - Method in class org.springframework.shell.standard.ValueProviderSupport
-
- table() - Static method in class org.springframework.shell.table.CellMatchers
-
- Table - Class in org.springframework.shell.table
-
This is the central API for table rendering.
- TableBuilder - Class in org.springframework.shell.table
-
A builder class to incrementally configure a Table.
- TableBuilder(TableModel) - Constructor for class org.springframework.shell.table.TableBuilder
-
Construct a table with the given model.
- TableBuilder.BorderStub - Class in org.springframework.shell.table
-
- TableBuilder.BorderStub.TopLeft - Class in org.springframework.shell.table
-
- TableBuilder.CellMatcherStub - Class in org.springframework.shell.table
-
- TableModel - Class in org.springframework.shell.table
-
Abstracts away the contract a
Table will use to retrieve tabular data.
- TableModel() - Constructor for class org.springframework.shell.table.TableModel
-
- TableModelBuilder<T> - Class in org.springframework.shell.table
-
Helper class to build a TableModel incrementally.
- TableModelBuilder() - Constructor for class org.springframework.shell.table.TableModelBuilder
-
- Tables - Class in org.springframework.shell.table
-
Utility class used to create and configure typical Tables.
- Tables() - Constructor for class org.springframework.shell.table.Tables
-
- TAG_HIGHLIGHT - Static variable in class org.springframework.shell.style.ThemeSettings
-
Styling for something which is highlighted.
- TAG_ITEM_DISABLED - Static variable in class org.springframework.shell.style.ThemeSettings
-
Styling for something i.e.
- TAG_ITEM_ENABLED - Static variable in class org.springframework.shell.style.ThemeSettings
-
Styling for something i.e.
- TAG_ITEM_SELECTED - Static variable in class org.springframework.shell.style.ThemeSettings
-
Styling for something i.e.
- TAG_ITEM_SELECTOR - Static variable in class org.springframework.shell.style.ThemeSettings
-
Styling for selector i.e.
- TAG_ITEM_UNSELECTED - Static variable in class org.springframework.shell.style.ThemeSettings
-
Styling for something i.e.
- TAG_LEVEL_ERROR - Static variable in class org.springframework.shell.style.ThemeSettings
-
Styling for some arbitrary content indicating ERROR level.
- TAG_LEVEL_INFO - Static variable in class org.springframework.shell.style.ThemeSettings
-
Styling for some arbitrary content indicating INFO level.
- TAG_LEVEL_WARN - Static variable in class org.springframework.shell.style.ThemeSettings
-
Styling for some arbitrary content indicating WARN level.
- TAG_LIST_KEY - Static variable in class org.springframework.shell.style.ThemeSettings
-
Styling for keys or names in a lists:
: list value1
: list value2
- TAG_LIST_VALUE - Static variable in class org.springframework.shell.style.ThemeSettings
-
Styling for keys or names in a lists:
list key1 :
list key2 :
- TAG_TITLE - Static variable in class org.springframework.shell.style.ThemeSettings
-
Represents some arbitrary title.
- TAG_VALUE - Static variable in class org.springframework.shell.style.ThemeSettings
-
Represents some arbitrary value.
- tags() - Static method in class org.springframework.shell.style.ThemeSettings
-
Gets all tags.
- TemplateExecutor - Class in org.springframework.shell.style
-
Template executor which knows to use styling.
- TemplateExecutor(ThemeResolver) - Constructor for class org.springframework.shell.style.TemplateExecutor
-
- terminal - Variable in class org.springframework.shell.result.TerminalAwareResultHandler
-
- TerminalAwareResultHandler<T> - Class in org.springframework.shell.result
-
Base class for ResultHandlers that rely on JLine's Terminal.
- TerminalAwareResultHandler(Terminal) - Constructor for class org.springframework.shell.result.TerminalAwareResultHandler
-
- TerminalSizeAware - Interface in org.springframework.shell
-
To be implemented by command result objects that can adapt to the terminal size when they are being rendered.
- terminalSizeAwareResultHandler(Terminal) - Method in class org.springframework.shell.result.ResultHandlerConfig
-
- TerminalSizeAwareResultHandler - Class in org.springframework.shell.result
-
- TerminalSizeAwareResultHandler(Terminal) - Constructor for class org.springframework.shell.result.TerminalSizeAwareResultHandler
-
- TextWrapper - Interface in org.springframework.shell.table
-
A strategy for applying text wrapping/cropping given a cell width.
- Theme - Interface in org.springframework.shell.style
-
Contract representing a theme with its name and settings.
- ThemeRegistry - Class in org.springframework.shell.style
-
Registry which stores
Theme's with its name.
- ThemeRegistry() - Constructor for class org.springframework.shell.style.ThemeRegistry
-
- ThemeResolver - Class in org.springframework.shell.style
-
Service which helps to do various things with styles.
- ThemeResolver(ThemeRegistry, String) - Constructor for class org.springframework.shell.style.ThemeResolver
-
- ThemeSettings - Class in org.springframework.shell.style
-
ThemeSettings is storing
Theme related settings together and
is base class for further customizations.
- ThemeSettings() - Constructor for class org.springframework.shell.style.ThemeSettings
-
- themeSettings() - Static method in class org.springframework.shell.style.ThemeSettings
-
Creates an instance of a default settings.
- throwableResultHandler(Terminal, CommandRegistry, ObjectProvider<InteractiveShellRunner>) - Method in class org.springframework.shell.result.ResultHandlerConfig
-
- ThrowableResultHandler - Class in org.springframework.shell.result
-
- ThrowableResultHandler(Terminal, CommandRegistry, ObjectProvider<InteractiveShellRunner>) - Constructor for class org.springframework.shell.result.ThrowableResultHandler
-
- title() - Method in class org.springframework.shell.style.ThemeSettings
-
- toBottomRight() - Method in class org.springframework.shell.table.TableBuilder.BorderStub.TopLeft
-
- TOP - Static variable in class org.springframework.shell.table.BorderSpecification
-
- toRowColumn(int, int) - Method in class org.springframework.shell.table.TableBuilder.BorderStub.TopLeft
-
- toString() - Method in class org.springframework.shell.CompletionProposal
-
- toString() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext
-
- toString() - Method in class org.springframework.shell.MethodTarget
-
- toString() - Method in class org.springframework.shell.ParameterDescription
-
- toString() - Method in class org.springframework.shell.standard.StandardMethodTargetRegistrar
-
- toString(String, String, Locale) - Method in class org.springframework.shell.style.StringToStyleExpressionRenderer
-
- toString() - Method in class org.springframework.shell.table.BorderSpecification
-
- toTemplateModel() - Method in class org.springframework.shell.component.context.BaseComponentContext
-
- toTemplateModel() - Method in interface org.springframework.shell.component.context.ComponentContext
-
Gets context values as a map.
- toTemplateModel() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext
-
- toTemplateModel() - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext
-
- transpose() - Method in class org.springframework.shell.table.TableModel
-
- type() - Method in class org.springframework.shell.ParameterDescription
-
- value() - Method in class org.springframework.shell.CompletionProposal
-
- value(String) - Method in class org.springframework.shell.CompletionProposal
-
- value() - Method in class org.springframework.shell.style.ThemeSettings
-
- valueOf(String) - Static method in enum org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext.MessageLevel
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.springframework.shell.context.InteractionMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.springframework.shell.table.BorderStyle
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.springframework.shell.table.SimpleHorizontalAligner
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.springframework.shell.table.SimpleVerticalAligner
-
Returns the enum constant of this type with the specified name.
- ValueProvider - Interface in org.springframework.shell.standard
-
Beans implementing this interface are queried during TAB completion to gather possible values of a parameter.
- ValueProviderSupport - Class in org.springframework.shell.standard
-
- ValueProviderSupport() - Constructor for class org.springframework.shell.standard.ValueProviderSupport
-
- ValueResult - Class in org.springframework.shell
-
- ValueResult(MethodParameter, Object) - Constructor for class org.springframework.shell.ValueResult
-
- ValueResult(MethodParameter, Object, BitSet, BitSet) - Constructor for class org.springframework.shell.ValueResult
-
- values() - Static method in enum org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext.MessageLevel
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum org.springframework.shell.context.InteractionMode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum org.springframework.shell.table.BorderStyle
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum org.springframework.shell.table.SimpleHorizontalAligner
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum org.springframework.shell.table.SimpleVerticalAligner
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- 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() - Method in class org.springframework.shell.standard.commands.Version
-
- Version.Command - Interface in org.springframework.shell.standard.commands
-
Marker interface used in auto-config.
- verticalGlyph() - Method in enum org.springframework.shell.table.BorderStyle
-