Index

A B C D E F G H I J K L M N O P Q R S T U V W Z _ 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

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
 
AbstractArgumentMethodArgumentResolver - Class in org.springframework.shell.support
Abstract base class to resolve method arguments from a named value, e.g.
AbstractArgumentMethodArgumentResolver(ConversionService, ConfigurableBeanFactory) - Constructor for class org.springframework.shell.support.AbstractArgumentMethodArgumentResolver
Constructor with a ConversionService and a BeanFactory.
AbstractArgumentMethodArgumentResolver.NamedValueInfo - Class in org.springframework.shell.support
Represents a named value declaration.
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
 
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
 
AbstractNodeVisitor - Class in org.springframework.shell.command.parser
Base abstract NodeVisitor which visits all nodes allowing user to implement callback methods.
AbstractNodeVisitor() - Constructor for class org.springframework.shell.command.parser.AbstractNodeVisitor
 
AbstractSelectorComponent<T,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>,I extends Nameable & Matchable & Enableable & Selectable & 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 Class in org.springframework.shell.component.support
Message levels which can be used to alter how message is shown.
ACCEPT - Enum constant in enum class org.springframework.shell.component.flow.ResultMode
Blindly accept a given resultValue resulting component run to be skipped and value set as a result automatically.
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.
addLine(TerminalLine) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
addLines(List<TerminalLine>) - Method in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
addModelListener(TerminalModelListener) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
addNewLine(TextStyle, CharBuffer) - Method in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
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.
addResolver(HandlerMethodArgumentResolver) - Method in class org.springframework.shell.command.invocation.ShellMethodArgumentResolverComposite
Add the given HandlerMethodArgumentResolver.
addResolvers(List<? extends HandlerMethodArgumentResolver>) - Method in class org.springframework.shell.command.invocation.ShellMethodArgumentResolverComposite
Add the given HandlerMethodArgumentResolvers.
addResolvers(HandlerMethodArgumentResolver...) - Method in class org.springframework.shell.command.invocation.ShellMethodArgumentResolverComposite
Add the given HandlerMethodArgumentResolvers.
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.
addResultHandler(ResultHandler<?>) - Method in class org.springframework.shell.result.GenericResultHandlerService
Add a plain result handler to this registry.
addRow() - Method in class org.springframework.shell.table.TableModelBuilder
 
addSizer(SizeConstraints) - Method in class org.springframework.shell.table.TableBuilder.CellMatcherStub
 
addTypeAheadModelListener(TerminalModelListener) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
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
 
air - Enum constant in enum class org.springframework.shell.table.BorderStyle
A border style that uses space characters, giving some space between columns.
alias() - Element in annotation interface org.springframework.shell.command.annotation.Command
Define alias as an array.
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 class org.springframework.shell.table.SimpleHorizontalAligner
 
align(String[], int, int) - Method in enum class org.springframework.shell.table.SimpleVerticalAligner
 
Aligner - Interface in org.springframework.shell.table
A strategy interface for performing text alignment.
ALL - Enum constant in enum class org.springframework.shell.context.InteractionMode
All possible modes.
ALLOW_DIRECTIVES - Enum constant in enum class org.springframework.shell.command.parser.ParserConfig.Feature
Defines if directives support is enabled, disabled on default.
AllowWideColumn - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
AlternateBuffer - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
AltSendsEscape - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
ambiguousCharsAreDoubleWidth() - Method in interface org.springframework.shell.test.jediterm.terminal.TerminalDisplay
 
ambiguousCharsAreDoubleWidth() - Method in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
and() - Method in interface org.springframework.shell.command.CommandRegistration.AliasSpec
Return a builder for chaining.
and() - Method in class org.springframework.shell.command.CommandRegistration.DefaultAliasSpec
 
and() - Method in class org.springframework.shell.command.CommandRegistration.DefaultErrorHandlingSpec
 
and() - Method in class org.springframework.shell.command.CommandRegistration.DefaultExitCodeSpec
 
and() - Method in class org.springframework.shell.command.CommandRegistration.DefaultHelpOptionsSpec
 
and() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
and() - Method in class org.springframework.shell.command.CommandRegistration.DefaultTargetSpec
 
and() - Method in interface org.springframework.shell.command.CommandRegistration.ErrorHandlingSpec
Return a builder for chaining.
and() - Method in interface org.springframework.shell.command.CommandRegistration.ExitCodeSpec
Return a builder for chaining.
and() - Method in interface org.springframework.shell.command.CommandRegistration.HelpOptionsSpec
Return a builder for chaining.
and() - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec
Return a builder for chaining.
and() - Method in interface org.springframework.shell.command.CommandRegistration.TargetSpec
Return a builder for chaining.
and() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
and() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
and() - Method in class org.springframework.shell.component.flow.BasePathInput
 
and() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
and() - Method in class org.springframework.shell.component.flow.BaseStringInput
 
and() - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec
Build and return parent builder.
and() - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec
Build and return parent builder.
and() - Method in interface org.springframework.shell.component.flow.PathInputSpec
Build and return parent builder.
and() - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec
Build and return parent builder.
and() - Method in interface org.springframework.shell.component.flow.StringInputSpec
Build and return parent builder.
and() - Method in class org.springframework.shell.table.TableBuilder.CellMatcherStub
 
ANSI - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
appendBuf(StringBuilder, char[], int, int) - Static method in class org.springframework.shell.test.jediterm.terminal.util.CharUtils
 
appendChar(StringBuilder, CharUtils.CharacterType, char) - Static method in class org.springframework.shell.test.jediterm.terminal.util.CharUtils
 
ApplicationRunnerAutoConfiguration - Class in org.springframework.shell.boot
 
ApplicationRunnerAutoConfiguration() - Constructor for class org.springframework.shell.boot.ApplicationRunnerAutoConfiguration
 
apply(CompletionContext) - Method in class org.springframework.shell.completion.RegistrationOptionsCompletionResolver
 
args() - Method in record class org.springframework.shell.test.ShellTestClient.ShellRunnerTaskData
Returns the value of the args record component.
ARGUMENT - Enum constant in enum class org.springframework.shell.command.parser.TokenType
 
ARGUMENT_PREFIX - Static variable in class org.springframework.shell.support.AbstractArgumentMethodArgumentResolver
 
ArgumentHeaderMethodArgumentResolver - Class in org.springframework.shell.command
Resolver for @Header arguments.
ArgumentHeaderMethodArgumentResolver(ConversionService, ConfigurableBeanFactory) - Constructor for class org.springframework.shell.command.ArgumentHeaderMethodArgumentResolver
 
ArgumentResult(String, int) - Constructor for record class org.springframework.shell.command.parser.Parser.ParseResult.ArgumentResult
Creates an instance of a ArgumentResult record class.
argumentResults() - Method in record class org.springframework.shell.command.parser.Parser.ParseResult
Returns the value of the argumentResults record component.
arity() - Element in annotation interface org.springframework.shell.command.annotation.Option
Define option arity.
arity() - Element in annotation interface org.springframework.shell.standard.ShellOption
Return the number of input "words" this parameter consumes.
arity(int, int) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
arity(int, int) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec
Define an arity for an option.
arity(CommandRegistration.OptionArity) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
arity(CommandRegistration.OptionArity) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec
Define an arity for an option.
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.
arityMax() - Element in annotation interface org.springframework.shell.command.annotation.Option
Define option arity max.
arityMin() - Element in annotation interface org.springframework.shell.command.annotation.Option
Define option arity min.
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
 
ArrayTerminalDataStream - Class in org.springframework.shell.test.jediterm.terminal
Takes data from underlying char array.
ArrayTerminalDataStream(char[]) - Constructor for class org.springframework.shell.test.jediterm.terminal.ArrayTerminalDataStream
 
ArrayTerminalDataStream(char[], int, int) - Constructor for class org.springframework.shell.test.jediterm.terminal.ArrayTerminalDataStream
 
Ascii - Class in org.springframework.shell.test.jediterm.typeahead
 
ASCII - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSet
 
ASCII_NAMES - Static variable in class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSets
 
assertTargetBean(Method, Object, Object[]) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
Assert that the target bean class is an instance of the class where the given method is declared.
assertThat(ShellScreen) - Static method in class org.springframework.shell.test.ShellAssertions
Creates an instance of ShellScreenAssert.
assertThat(ValueResult) - Static method in class org.springframework.shell.ValueResultAsserts
 
Ast - Interface in org.springframework.shell.command.parser
Interface to generate abstract syntax tree from tokens.
Ast.AstResult - Record Class in org.springframework.shell.command.parser
Representing result from tokens to ast tree generation.
Ast.DefaultAst - Class in org.springframework.shell.command.parser
Default implementation of an Ast.
AstCommandParser(Map<String, CommandRegistration>, ParserConfig, ConversionService) - Constructor for class org.springframework.shell.command.CommandParser.AstCommandParser
 
AstNode - Class in org.springframework.shell.command.parser
Represents a node in an abstract syntax tree and knows about Token.
AstNode(Token) - Constructor for class org.springframework.shell.command.parser.AstNode
 
AstResult(List<NonterminalAstNode>, List<TerminalAstNode>) - Constructor for record class org.springframework.shell.command.parser.Ast.AstResult
Creates an instance of a AstResult record class.
at(int, int) - Static method in class org.springframework.shell.table.CellMatchers
 
attributedCharSequenceResultHandler(Terminal) - Method in class org.springframework.shell.result.ResultHandlerConfig
 
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
 
AutoConfigureShell - Annotation Interface in org.springframework.shell.test.autoconfigure
Auto-configuration imports for typical Shell tests.
AutoConfigureShellTestClient - Annotation Interface in org.springframework.shell.test.autoconfigure
Annotation that can be applied to a test class to enable and configure auto-configuration of shell client.
AutoNewLine - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
AutoRepeatKeys - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
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
 
AutoWrap - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
availability(Supplier<Availability>) - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder
 
availability(Supplier<Availability>) - Method in interface org.springframework.shell.command.CommandRegistration.Builder
Define an Availability suppliear for a command.
Availability - Class in org.springframework.shell
Indicates whether or not a command is currently available.
AvailabilityProvider - Interface in org.springframework.shell
Interface resolving Availability.
AvailabilityReflectiveProcessor - Class in org.springframework.shell
A ReflectiveProcessor implementation that registers methods of a return type Availability from a target which is a class.
AvailabilityReflectiveProcessor() - Constructor for class org.springframework.shell.AvailabilityReflectiveProcessor
 
available() - Static method in class org.springframework.shell.Availability
 

B

backspace() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
backspace() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
BaseBuilder() - Constructor for class org.springframework.shell.command.CommandRegistration.BaseBuilder
 
BaseComponentContext<C extends ComponentContext<C>> - Class in org.springframework.shell.component.context
Base implementation of a ComponentContext.
BaseComponentContext() - Constructor for class org.springframework.shell.component.context.BaseComponentContext
 
BaseConfirmationInput - Class in org.springframework.shell.component.flow
Base impl for ConfirmationInputSpec.
BaseConfirmationInput(ComponentFlow.BaseBuilder, String) - Constructor for class org.springframework.shell.component.flow.BaseConfirmationInput
 
BaseInput<T extends BaseInputSpec<T>> - Class in org.springframework.shell.component.flow
Base impl for specs.
BaseInputSpec<T extends BaseInputSpec<T>> - Interface in org.springframework.shell.component.flow
Base spec for other specs.
BaseMultiItemSelector - Class in org.springframework.shell.component.flow
Base impl for MultiItemSelectorSpec.
BaseMultiItemSelector(ComponentFlow.BaseBuilder, String) - Constructor for class org.springframework.shell.component.flow.BaseMultiItemSelector
 
basePackageClasses() - Element in annotation interface org.springframework.shell.command.annotation.CommandScan
Type-safe alternative to CommandScan.basePackages() for specifying the packages to scan for commands.
basePackages() - Element in annotation interface org.springframework.shell.command.annotation.CommandScan
Base packages to scan for commands.
BasePathInput - Class in org.springframework.shell.component.flow
Base impl for PathInputSpec.
BasePathInput(ComponentFlow.BaseBuilder, String) - Constructor for class org.springframework.shell.component.flow.BasePathInput
 
BaseSelectorComponentContext() - Constructor for class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext
 
BaseSingleItemSelector - Class in org.springframework.shell.component.flow
Base impl for SingleItemSelectorSpec.
BaseSingleItemSelector(ComponentFlow.BaseBuilder, String) - Constructor for class org.springframework.shell.component.flow.BaseSingleItemSelector
 
BaseStringInput - Class in org.springframework.shell.component.flow
Base impl for StringInputSpec.
BaseStringInput(ComponentFlow.BaseBuilder, String) - Constructor for class org.springframework.shell.component.flow.BaseStringInput
 
BaseTextComponentContext() - Constructor for class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext
 
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
 
BeanListTableModel<T> - Class in org.springframework.shell.table
A table model that is backed by a list of beans.
BeanListTableModel(Class<T>, Iterable<T>) - Constructor for class org.springframework.shell.table.BeanListTableModel
 
BeanListTableModel(Iterable<T>, String...) - Constructor for class org.springframework.shell.table.BeanListTableModel
 
BeanListTableModel(Iterable<T>, LinkedHashMap<String, Object>) - Constructor for class org.springframework.shell.table.BeanListTableModel
 
beep() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
beep() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
beep() - Method in interface org.springframework.shell.test.jediterm.terminal.TerminalDisplay
 
beep() - Method in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
BEL - Static variable in class org.springframework.shell.test.jediterm.typeahead.Ascii
Bell ('\a'): A character for use when there is a need to call for human attention.
bindKeyMap(KeyMap<String>) - Method in class org.springframework.shell.component.PathSearch
 
bindKeyMap(KeyMap<String>) - Method in class org.springframework.shell.component.support.AbstractComponent
Bind key map.
bindKeyMap(KeyMap<String>) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent
 
bindKeyMap(KeyMap<String>) - Method in class org.springframework.shell.component.support.AbstractTextComponent
 
bitsetCopy(BitSet, int, BitSet, int, int) - Static method in class org.springframework.shell.test.jediterm.terminal.util.Util
 
BLINK - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TextStyle.Option
 
BLINK_BLOCK - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.CursorShape
 
BLINK_UNDERLINE - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.CursorShape
 
BLINK_VERTICAL_BAR - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.CursorShape
 
BOLD - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TextStyle.Option
 
BorderSpecification - Class in org.springframework.shell.table
This represents a directive to set some borders on cells of a table.
BorderStyle - Enum Class in org.springframework.shell.table
Provides support for different styles of borders, using simple or fancy ascii art.
bottom - Enum constant in enum class org.springframework.shell.table.SimpleVerticalAligner
 
BOTTOM - Static variable in class org.springframework.shell.table.BorderSpecification
 
BracketedPasteMode - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
BRITISH - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSet
 
BS - Static variable in class org.springframework.shell.test.jediterm.typeahead.Ascii
Backspace ('\b'): A format effector which controls the movement of the printing position one printing space backward on the same printing line.
buf - Variable in class org.springframework.shell.test.jediterm.terminal.ArrayTerminalDataStream
 
build() - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder
 
build() - Method in interface org.springframework.shell.command.CommandRegistration.Builder
build() - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder
 
build() - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder
Builds instance of input wizard.
build() - Method in interface org.springframework.shell.support.search.SearchMatch.Builder
Build instance of a SearchMatch.
build() - Method in class org.springframework.shell.support.search.SearchMatch.DefaultBuilder
 
build() - Method in class org.springframework.shell.table.TableBuilder
 
build() - Method in class org.springframework.shell.table.TableBuilder.CellMatcherStub
 
build() - Method in class org.springframework.shell.table.TableModelBuilder
 
build() - Method in class org.springframework.shell.test.jediterm.terminal.TextStyle.Builder
 
build() - Method in interface org.springframework.shell.test.ShellTestClient.Builder
Build a shell client.
build() - Method in class org.springframework.shell.test.ShellTestClient.DefaultBuilder
 
build() - Method in interface org.springframework.shell.test.ShellWriteSequence
Build the result.
build() - Method in class org.springframework.shell.test.ShellWriteSequence.DefaultShellWriteSequence
 
builder() - Static method in interface org.springframework.shell.command.CommandRegistration
Gets a new instance of a CommandRegistration.Builder.
builder() - Static method in interface org.springframework.shell.component.flow.ComponentFlow
Gets a new instance of an input wizard builder.
builder() - Method in class org.springframework.shell.standard.completion.AbstractCompletions
 
builder() - Static method in interface org.springframework.shell.support.search.SearchMatch
Gets an instance of a builder for a SearchMatch.
builder(TerminalSession, Shell, PromptProvider, LineReader, Terminal) - Static method in interface org.springframework.shell.test.ShellTestClient
Get an instance of a builder.
Builder() - Constructor for class org.springframework.shell.test.jediterm.terminal.TextStyle.Builder
 
Builder(TextStyle) - Constructor for class org.springframework.shell.test.jediterm.terminal.TextStyle.Builder
 
buildResult() - Method in class org.springframework.shell.command.parser.AbstractNodeVisitor
Called after all nodes has been visited to build results.
buildResult() - Method in class org.springframework.shell.command.parser.Parser.DefaultNodeVisitor
 

C

C0_CHARS - Static variable in class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSets
Denotes the mapping for C0 characters.
C1_CHARS - Static variable in class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSets
Denotes the mapping for C1 characters.
CAMEL - Enum constant in enum class org.springframework.shell.boot.SpringShellProperties.OptionNamingCase
 
CAMELCASE - Static variable in class org.springframework.shell.command.support.OptionNameModifierSupport
 
canOpenSession() - Method in class org.springframework.shell.test.jediterm.terminal.ui.JediTermWidget
 
canOpenSession() - Method in interface org.springframework.shell.test.jediterm.terminal.ui.TerminalWidget
 
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.
carriageReturn() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
carriageReturn() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
carriageReturn() - Method in interface org.springframework.shell.test.ShellWriteSequence
Sequence terminal carriage return.
carriageReturn() - Method in class org.springframework.shell.test.ShellWriteSequence.DefaultShellWriteSequence
 
CASE_SENSITIVE_COMMANDS - Enum constant in enum class org.springframework.shell.command.parser.ParserConfig.Feature
Defines if commands are parsed using case-sensitivity, enabled on default.
CASE_SENSITIVE_OPTIONS - Enum constant in enum class org.springframework.shell.command.parser.ParserConfig.Feature
Defines if options are parsed using case-sensitivity, enabled on default.
caseSensitive(boolean) - Method in interface org.springframework.shell.support.search.SearchMatch.Builder
Set a flag for caseSensitive.
caseSensitive(boolean) - Method in class org.springframework.shell.support.search.SearchMatch.DefaultBuilder
 
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
 
center - Enum constant in enum class org.springframework.shell.table.SimpleHorizontalAligner
 
characterAttributes(TextStyle) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
characterAttributes(TextStyle) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
CharacterSet - Enum Class in org.springframework.shell.test.jediterm.terminal.emulator.charset
Provides an enum with names for the supported character sets.
CharacterSets - Class in org.springframework.shell.test.jediterm.terminal.emulator.charset
Provides the (graphical) character sets.
charAt(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.CharBuffer
 
charAt(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine
 
CharBuffer - Class in org.springframework.shell.test.jediterm.terminal.model
 
CharBuffer(char[], int, int) - Constructor for class org.springframework.shell.test.jediterm.terminal.model.CharBuffer
 
CharBuffer(char, int) - Constructor for class org.springframework.shell.test.jediterm.terminal.model.CharBuffer
 
CharBuffer(String) - Constructor for class org.springframework.shell.test.jediterm.terminal.model.CharBuffer
 
charsEqualIgnoreCase(char, char) - Static method in class org.springframework.shell.test.jediterm.terminal.util.Util
 
CharUtils - Class in org.springframework.shell.test.jediterm.terminal.util
 
CharUtils.CharacterType - Enum Class in org.springframework.shell.test.jediterm.terminal.util
 
checkboxOff() - Method in class org.springframework.shell.style.FigureSettings
 
checkboxOn() - Method in class org.springframework.shell.style.FigureSettings
 
clear() - Method in class org.springframework.shell.boot.StandardCommandsAutoConfiguration
 
clear() - Method in class org.springframework.shell.command.invocation.ShellMethodArgumentResolverComposite
Clear the list of configured resolvers and the resolver cache.
clear() - Method in class org.springframework.shell.standard.commands.Clear
 
clear(TerminalLine.TextEntry) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine
 
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.
clearAll() - Method in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
clearAll() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
clearAllTabStops() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
clearAllTabStops() - Method in interface org.springframework.shell.test.jediterm.terminal.model.Tabulator
Clears all tab stops.
clearAllTabStops() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
clearArea(int, int, int, int, TextStyle) - Method in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
clearArea(int, int, TextStyle) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine
 
clearBuffer() - Method in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
clearBuffer(boolean) - Method in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
ClearCommand() - Constructor for class org.springframework.shell.boot.SpringShellProperties.ClearCommand
 
clearHistory() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
clearLines(int, int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
clearLines(int, int) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
clearLines(int, int, TerminalLine.TextEntry) - Method in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
clearScreen() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
clearScreen() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
clearScreen() - Method in interface org.springframework.shell.test.ShellWriteSequence
Sequence terminal clear screen.
clearScreen() - Method in class org.springframework.shell.test.ShellWriteSequence.DefaultShellWriteSequence
 
clearTabStop(int) - Method in interface org.springframework.shell.test.jediterm.terminal.model.Tabulator
Clears the tab stop at the given position.
clearTabStopAtCursor() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
clearTabStopAtCursor() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
clearTypeAheadPredictions() - Method in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
clearTypeAheadPredictions() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
clone() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod.HandlerMethodParameter
 
clone() - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder
 
clone() - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder
Clones existing builder.
clone() - Method in class org.springframework.shell.test.jediterm.terminal.model.CharBuffer
 
close() - Method in class org.springframework.shell.jline.FileInputProvider
 
close() - Method in class org.springframework.shell.test.jediterm.terminal.TerminalStarter
 
close() - Method in interface org.springframework.shell.test.jediterm.terminal.TtyConnector
 
close() - Method in class org.springframework.shell.test.jediterm.terminal.ui.JediTermWidget
 
close() - Method in interface org.springframework.shell.test.jediterm.terminal.ui.TerminalSession
 
close() - Method in class org.springframework.shell.test.ShellTestClient.DefaultShellClient
 
code() - Element in annotation interface org.springframework.shell.command.annotation.ExitCode
Exit code value.
collectDefaults() - Static method in enum class org.springframework.shell.command.parser.ParserConfig.Feature
 
column(int) - Static method in class org.springframework.shell.table.CellMatchers
 
command() - Element in annotation interface org.springframework.shell.command.annotation.Command
Define command as an array.
command(String) - Method in class org.springframework.shell.command.CommandRegistration.DefaultHelpOptionsSpec
 
command(String) - Method in interface org.springframework.shell.command.CommandRegistration.HelpOptionsSpec
Sets command used for help.
command(String) - Method in interface org.springframework.shell.test.ShellWriteSequence
Sequence from command with expected carriage return.
command(String) - Method in class org.springframework.shell.test.ShellWriteSequence.DefaultShellWriteSequence
 
command(String...) - Method in interface org.springframework.shell.command.CommandRegistration.AliasSpec
Define commands for an alias.
command(String...) - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder
 
command(String...) - Method in interface org.springframework.shell.command.CommandRegistration.Builder
Define commands this registration uses.
command(String...) - Method in class org.springframework.shell.command.CommandRegistration.DefaultAliasSpec
 
Command - Interface in org.springframework.shell
 
Command - Annotation Interface in org.springframework.shell.command.annotation
Annotation marking a method to be a candicate for a shell command target.
Command() - Constructor for class org.springframework.shell.boot.SpringShellProperties.Command
 
COMMAND - Enum constant in enum class org.springframework.shell.command.parser.TokenType
 
Command.Help - Class in org.springframework.shell
Encapsulates help metadata about a shell command.
CommandAlias - Interface in org.springframework.shell.command
Interface representing an alias in a command.
CommandAlias.DefaultCommandAlias - Class in org.springframework.shell.command
Default implementation of CommandAlias.
CommandArgumentNode - Class in org.springframework.shell.command.parser
Node representing a command argument.
CommandArgumentNode(Token, CommandNode) - Constructor for class org.springframework.shell.command.parser.CommandArgumentNode
 
CommandAvailability - Annotation Interface in org.springframework.shell.command.annotation
Annotation marking a method having Availability.
commandCatalog(ObjectProvider<MethodTargetRegistrar>, ObjectProvider<CommandResolver>, ObjectProvider<CommandCatalogCustomizer>, ShellContext) - Method in class org.springframework.shell.boot.CommandCatalogAutoConfiguration
 
CommandCatalog - Interface in org.springframework.shell.command
Interface defining contract to handle existing CommandRegistrations.
CommandCatalog.DefaultCommandCatalog - Class in org.springframework.shell.command
Default implementation of a CommandCatalog.
CommandCatalogAutoConfiguration - Class in org.springframework.shell.boot
 
CommandCatalogAutoConfiguration() - Constructor for class org.springframework.shell.boot.CommandCatalogAutoConfiguration
 
CommandCatalogCustomizer - Interface in org.springframework.shell.command
Interface to customize a CommandCatalog.
CommandContext - Interface in org.springframework.shell.command
Interface containing information about current command execution.
CommandContext.DefaultCommandContext - Class in org.springframework.shell.command
Default implementation of a CommandContext.
CommandContextMethodArgumentResolver - Class in org.springframework.shell.command
Implementation of a HandlerMethodArgumentResolver resolving CommandContext.
CommandContextMethodArgumentResolver() - Constructor for class org.springframework.shell.command.CommandContextMethodArgumentResolver
 
CommandExceptionResolver - Interface in org.springframework.shell.command
Interface to be implemented by objects that can resolve exceptions thrown during command processing, in the typical case error response.
CommandExecution - Interface in org.springframework.shell.command
Interface to evaluate a result from a command with an arguments.
CommandExecution.CommandExecutionException - Exception in org.springframework.shell.command
 
CommandExecution.CommandExecutionHandlerMethodArgumentResolvers - Class in org.springframework.shell.command
 
CommandExecution.CommandParserExceptionsException - Exception in org.springframework.shell.command
 
CommandExecution.DefaultCommandExecution - Class in org.springframework.shell.command
Default implementation of a CommandExecution.
CommandExecution.ParamNameHandlerMethodArgumentResolver - Class in org.springframework.shell.command
 
CommandExecutionException(Throwable) - Constructor for exception org.springframework.shell.command.CommandExecution.CommandExecutionException
 
commandExecutionHandlerMethodArgumentResolvers(ShellConversionServiceSupplier) - Method in class org.springframework.shell.boot.ParameterResolverAutoConfiguration
 
CommandExecutionHandlerMethodArgumentResolvers(List<? extends HandlerMethodArgumentResolver>) - Constructor for class org.springframework.shell.command.CommandExecution.CommandExecutionHandlerMethodArgumentResolvers
 
CommandExitCode - Interface in org.springframework.shell.command
Interface representing an exit code in a command.
CommandExitCode.DefaultCommandExitCode - Class in org.springframework.shell.command
 
CommandHandlingResult - Interface in org.springframework.shell.command
Holder for handling some processing, typically with CommandExceptionResolver.
CommandHandlingResult.DefaultHandlingResult - Class in org.springframework.shell.command
 
CommandModel - Class in org.springframework.shell.command.parser
Helper class to make it easier to work with command registrations and how those are used with parser model.
CommandModel(Map<String, CommandRegistration>, ParserConfig) - Constructor for class org.springframework.shell.command.parser.CommandModel
 
CommandNode - Class in org.springframework.shell.command.parser
Node representing a command.
CommandNode(Token, String) - Constructor for class org.springframework.shell.command.parser.CommandNode
 
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
 
CommandNotFound(List<String>, Map<String, CommandRegistration>, String) - Constructor for exception org.springframework.shell.CommandNotFound
 
CommandNotFoundMessageProvider - Interface in org.springframework.shell.result
Provider for a message used within CommandNotFoundResultHandler.
CommandNotFoundMessageProvider.ProviderContext - Interface in org.springframework.shell.result
commandNotFoundResultHandler(Terminal, ObjectProvider<CommandNotFoundMessageProvider>) - Method in class org.springframework.shell.result.ResultHandlerConfig
 
CommandNotFoundResultHandler - Class in org.springframework.shell.result
ResultHandler for CommandNotFound using CommandNotFoundMessageProvider to provide an error message.
CommandNotFoundResultHandler(Terminal, ObjectProvider<CommandNotFoundMessageProvider>) - Constructor for class org.springframework.shell.result.CommandNotFoundResultHandler
 
commandOption(CommandOption) - Method in class org.springframework.shell.CompletionContext
Return a copy of this context with given command option.
CommandOption - Interface in org.springframework.shell.command
Interface representing an option in a command.
CommandOption.DefaultCommandOption - Class in org.springframework.shell.command
Default implementation of CommandOption.
CommandParser - Interface in org.springframework.shell.command
Interface parsing arguments for a CommandRegistration.
CommandParser.AstCommandParser - Class in org.springframework.shell.command
Default implementation of a CommandParser.
CommandParser.CommandParserException - Exception in org.springframework.shell.command
 
CommandParser.CommandParserResult - Interface in org.springframework.shell.command
Result of a parsing CommandOption with an argument.
CommandParser.CommandParserResults - Interface in org.springframework.shell.command
Results of a CommandParser.
CommandParser.DefaultCommandParserResult - Class in org.springframework.shell.command
Default implementation of a CommandParser.CommandParserResult.
CommandParser.DefaultCommandParserResults - Class in org.springframework.shell.command
Default implementation of a CommandParser.CommandParserResults.
CommandParserException(String) - Constructor for exception org.springframework.shell.command.CommandParser.CommandParserException
 
CommandParserException(String, Throwable) - Constructor for exception org.springframework.shell.command.CommandParser.CommandParserException
 
commandParserExceptionResolver() - Method in class org.springframework.shell.result.ResultHandlerConfig
 
CommandParserExceptionResolver - Class in org.springframework.shell.command
CommandParserExceptionResolver() - Constructor for class org.springframework.shell.command.CommandParserExceptionResolver
 
CommandParserExceptionsException(String, List<CommandParser.CommandParserException>) - Constructor for exception org.springframework.shell.command.CommandExecution.CommandParserExceptionsException
 
commandRegistration() - Method in record class org.springframework.shell.command.parser.Parser.ParseResult
Returns the value of the commandRegistration record component.
commandRegistration(CommandRegistration) - Method in class org.springframework.shell.CompletionContext
Return a copy of this context with given command registration.
CommandRegistration - Interface in org.springframework.shell.command
Interface defining a command registration endpoint.
CommandRegistration.AliasSpec - Interface in org.springframework.shell.command
Spec defining an alias.
CommandRegistration.BaseBuilder - Class in org.springframework.shell.command
 
CommandRegistration.Builder - Interface in org.springframework.shell.command
Builder interface for CommandRegistration.
CommandRegistration.BuilderSupplier - Interface in org.springframework.shell.command
Interface used to supply instance of a CommandRegistration.Builder.
CommandRegistration.DefaultAliasSpec - Class in org.springframework.shell.command
 
CommandRegistration.DefaultBuilder - Class in org.springframework.shell.command
 
CommandRegistration.DefaultCommandRegistration - Class in org.springframework.shell.command
 
CommandRegistration.DefaultErrorHandlingSpec - Class in org.springframework.shell.command
 
CommandRegistration.DefaultExitCodeSpec - Class in org.springframework.shell.command
 
CommandRegistration.DefaultHelpOptionsSpec - Class in org.springframework.shell.command
 
CommandRegistration.DefaultOptionSpec - Class in org.springframework.shell.command
 
CommandRegistration.DefaultTargetSpec - Class in org.springframework.shell.command
 
CommandRegistration.ErrorHandlingSpec - Interface in org.springframework.shell.command
Spec defining an error handling.
CommandRegistration.ExitCodeSpec - Interface in org.springframework.shell.command
Spec defining an exit code.
CommandRegistration.HelpOptionInfo - Interface in org.springframework.shell.command
 
CommandRegistration.HelpOptionInfo.DefaultHelpOptionInfo - Class in org.springframework.shell.command
 
CommandRegistration.HelpOptionsSpec - Interface in org.springframework.shell.command
Spec defining help options.
CommandRegistration.OptionArity - Enum Class in org.springframework.shell.command
Enumeration of option arity values.
CommandRegistration.OptionNameModifier - Interface in org.springframework.shell.command
Interface used to modify option long name.
CommandRegistration.OptionSpec - Interface in org.springframework.shell.command
Spec defining an option.
CommandRegistration.TargetInfo - Interface in org.springframework.shell.command
Encapsulates info for CommandRegistration.TargetSpec.
CommandRegistration.TargetInfo.DefaultTargetInfo - Class in org.springframework.shell.command
 
CommandRegistration.TargetInfo.TargetType - Enum Class in org.springframework.shell.command
 
CommandRegistration.TargetSpec - Interface in org.springframework.shell.command
Spec defining a target.
CommandRegistrationBeanRegistrar - Class in org.springframework.shell.command.annotation.support
Delegate used by EnableCommandRegistrar and CommandScanRegistrar to register a bean definition(s) for a @Command class.
CommandRegistrationBeanRegistrar(BeanDefinitionRegistry) - Constructor for class org.springframework.shell.command.annotation.support.CommandRegistrationBeanRegistrar
 
commandRegistrationBuilderSupplier(ObjectProvider<CommandRegistrationCustomizer>) - Method in class org.springframework.shell.boot.CommandCatalogAutoConfiguration
 
CommandRegistrationCustomizer - Interface in org.springframework.shell.boot
Callback interface that can be used to customize a CommandRegistration.Builder.
CommandResolver - Interface in org.springframework.shell.command
Interface to resolve currently existing commands.
commands() - Method in interface org.springframework.shell.result.CommandNotFoundMessageProvider.ProviderContext
Gets a list of commands parsed.
CommandScan - Annotation Interface in org.springframework.shell.command.annotation
Configures the base packages used when scanning for @Comamnd classes.
CommandScanRegistrar - Class in org.springframework.shell.command.annotation.support
ImportBeanDefinitionRegistrar for @CommandScan.
commandValueProvider(CommandCatalog) - Method in class org.springframework.shell.boot.StandardAPIAutoConfiguration
 
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
 
compareTo(PathSearch.ScoredPath) - Method in class org.springframework.shell.component.PathSearch.ScoredPath
 
complete(LineReader, ParsedLine, List<Candidate>) - Method in class org.springframework.shell.boot.CompleterAutoConfiguration.CompleterAdapter
 
complete(CompletionContext) - Method in class org.springframework.shell.Shell
Gather completion proposals given some (incomplete) input the user has already typed in.
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.
completer() - Method in class org.springframework.shell.boot.CompleterAutoConfiguration
 
CompleterAdapter() - Constructor for class org.springframework.shell.boot.CompleterAutoConfiguration.CompleterAdapter
 
CompleterAutoConfiguration - Class in org.springframework.shell.boot
 
CompleterAutoConfiguration() - Constructor for class org.springframework.shell.boot.CompleterAutoConfiguration
 
CompleterAutoConfiguration.CompleterAdapter - Class in org.springframework.shell.boot
 
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(SpringShellProperties) - Method in class org.springframework.shell.boot.StandardCommandsAutoConfiguration
 
completion(CompletionResolver) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
completion(CompletionResolver) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec
Define a completion function for an option.
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.
CompletionCommand() - Constructor for class org.springframework.shell.boot.SpringShellProperties.CompletionCommand
 
CompletionContext - Class in org.springframework.shell
Represents the buffer context in which completion was triggered.
CompletionContext(List<String>, int, int, CommandRegistration, CommandOption) - 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
 
CompletionProvider - Interface in org.springframework.shell.completion
Interface resolving completion proposals.
CompletionResolver - Interface in org.springframework.shell.completion
Interface resolving completion proposals.
completionResolvers - Variable in class org.springframework.shell.Shell
 
ComponentContext<C extends ComponentContext<C>> - Interface in org.springframework.shell.component.context
Contract for base component context having access to basic key/value pairs.
ComponentFlow - Interface in org.springframework.shell.component.flow
Wizart providing an implementation which allows more polished way to ask various inputs from a user using shell style components for simple text/path input, single select and multi-select.
ComponentFlow.BaseBuilder - Class in org.springframework.shell.component.flow
 
ComponentFlow.Builder - Interface in org.springframework.shell.component.flow
Interface for a wizard builder.
ComponentFlow.ComponentFlowResult - Interface in org.springframework.shell.component.flow
Results from a flow run.
ComponentFlow.DefaultBuilder - Class in org.springframework.shell.component.flow
 
ComponentFlow.DefaultComponentFlow - Class in org.springframework.shell.component.flow
 
ComponentFlow.DefaultComponentFlowResult - Class in org.springframework.shell.component.flow
 
ComponentFlow.OrderedInputOperation - Class in org.springframework.shell.component.flow
 
ComponentFlowAutoConfiguration - Class in org.springframework.shell.boot
Auto-configuration for ComponentFlow.
ComponentFlowAutoConfiguration() - Constructor for class org.springframework.shell.boot.ComponentFlowAutoConfiguration
 
ComponentFlowAutoConfiguration.ComponentFlowConfiguration - Class in org.springframework.shell.boot
 
componentFlowBuilder(ObjectProvider<ComponentFlowCustomizer>) - Method in class org.springframework.shell.boot.ComponentFlowAutoConfiguration
 
ComponentFlowConfiguration() - Constructor for class org.springframework.shell.boot.ComponentFlowAutoConfiguration.ComponentFlowConfiguration
 
ComponentFlowCustomizer - Interface in org.springframework.shell.boot
Callback interface that can be used to customize a ComponentFlow.Builder.
Config() - Constructor for class org.springframework.shell.boot.SpringShellProperties.Config
 
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
 
ConfirmationInputSpec - Interface in org.springframework.shell.component.flow
Interface for string input spec builder.
consume(int, int, TextStyle, CharBuffer, int) - Method in interface org.springframework.shell.test.jediterm.terminal.StyledTextConsumer
 
consume(int, int, TextStyle, CharBuffer, int) - Method in class org.springframework.shell.test.jediterm.terminal.StyledTextConsumerAdapter
 
consumeNul(int, int, int, TextStyle, CharBuffer, int) - Method in interface org.springframework.shell.test.jediterm.terminal.StyledTextConsumer
 
consumeNul(int, int, int, TextStyle, CharBuffer, int) - Method in class org.springframework.shell.test.jediterm.terminal.StyledTextConsumerAdapter
 
consumeQueue(int, int, int, int) - Method in interface org.springframework.shell.test.jediterm.terminal.StyledTextConsumer
 
consumeQueue(int, int, int, int) - Method in class org.springframework.shell.test.jediterm.terminal.StyledTextConsumerAdapter
 
consumer(Consumer<CommandContext>) - Method in class org.springframework.shell.command.CommandRegistration.DefaultTargetSpec
 
consumer(Consumer<CommandContext>) - Method in interface org.springframework.shell.command.CommandRegistration.TargetSpec
Register a consumer target.
CONSUMER - Enum constant in enum class org.springframework.shell.command.CommandRegistration.TargetInfo.TargetType
 
containsIgnoreCase(String, String) - Static method in class org.springframework.shell.test.jediterm.terminal.util.Util
 
containsKey(Object) - Method in interface org.springframework.shell.component.context.ComponentContext
Check if a context contains a key.
containsText(String) - Method in class org.springframework.shell.test.ShellScreenAssert
Verifies that text if found from a screen.
contextOf(Throwable, List<String>, Map<String, CommandRegistration>, String) - Static method in interface org.springframework.shell.result.CommandNotFoundMessageProvider
 
ControlSequence - Class in org.springframework.shell.test.jediterm.terminal.emulator
 
copy() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine
 
copyOf(char[], int) - Static method in class org.springframework.shell.test.jediterm.terminal.util.Util
 
copyOf(int[], int) - Static method in class org.springframework.shell.test.jediterm.terminal.util.Util
 
copyOf(T[], int) - Static method in class org.springframework.shell.test.jediterm.terminal.util.Util
 
countDoubleWidthCharacters(char[], int, int, boolean) - Static method in class org.springframework.shell.test.jediterm.terminal.util.CharUtils
 
cr() - Method in interface org.springframework.shell.test.ShellWriteSequence
Sequence terminal carriage return.
cr() - Method in class org.springframework.shell.test.ShellWriteSequence.DefaultShellWriteSequence
 
CR - Static variable in class org.springframework.shell.test.jediterm.typeahead.Ascii
Carriage Return ('\r'): A format effector which controls the movement of the printing position to the first printing position on the same printing line.
create(A, B) - Static method in class org.springframework.shell.test.jediterm.terminal.util.Pair
 
createDefaultStyle() - Method in class org.springframework.shell.test.jediterm.terminal.ui.JediTermWidget
 
createEmpty() - Static method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine
 
createEmptyWithColors() - Method in class org.springframework.shell.test.jediterm.terminal.TextStyle
 
createEmulator(TerminalDataStream, Terminal) - Method in class org.springframework.shell.test.jediterm.terminal.TerminalStarter
 
createMethodParameter(Executable, int) - Static method in class org.springframework.shell.Utils
Return a properly initialized MethodParameter for the given executable and index.
createMethodParameter(Parameter) - Static method in class org.springframework.shell.Utils
Convert from JDK Parameter to Spring MethodParameter.
createMethodParameters(Executable) - Static method in class org.springframework.shell.Utils
Return MethodParameters for each parameter of the given method/constructor.
createNamedValueInfo(MethodParameter) - Method in class org.springframework.shell.command.annotation.support.OptionMethodArgumentResolver
 
createNamedValueInfo(MethodParameter) - Method in class org.springframework.shell.command.ArgumentHeaderMethodArgumentResolver
 
createNamedValueInfo(MethodParameter) - Method in class org.springframework.shell.standard.ShellOptionMethodArgumentResolver
 
createNamedValueInfo(MethodParameter) - Method in class org.springframework.shell.support.AbstractArgumentMethodArgumentResolver
Create the AbstractArgumentMethodArgumentResolver.NamedValueInfo object for the given method parameter.
createTerminalPanel(StyleState, TerminalTextBuffer) - Method in class org.springframework.shell.test.jediterm.terminal.ui.JediTermWidget
 
createTerminalSession(TtyConnector) - Method in class org.springframework.shell.test.jediterm.terminal.ui.JediTermWidget
 
createTerminalSession(TtyConnector) - Method in interface org.springframework.shell.test.jediterm.terminal.ui.TerminalWidget
 
createTerminalStarter(JediTerminal, TtyConnector) - Method in class org.springframework.shell.test.jediterm.terminal.ui.JediTermWidget
 
createWithResolvedBean() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
If the provided instance contains a bean name rather than an object instance, the bean name is resolved before a InvocableShellMethod is created and returned.
crnl() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
ctrl(char) - Method in interface org.springframework.shell.test.ShellWriteSequence
Sequence terminal ctrl.
ctrl(char) - Method in class org.springframework.shell.test.ShellWriteSequence.DefaultShellWriteSequence
 
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
 
cursorBackward(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
cursorBackward(int) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
CursorBlinking - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
cursorDown(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
cursorDown(int) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
cursorForward(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
cursorForward(int) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
cursorHorizontalAbsolute(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
cursorHorizontalAbsolute(int) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
CursorKey - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
cursorPosition(int, int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
cursorPosition(int, int) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
cursorShape(CursorShape) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
cursorShape(CursorShape) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
CursorShape - Enum Class in org.springframework.shell.test.jediterm.terminal
Current cursor shape as described by https://vt100.net/docs/vt510-rm/DECSCUSR.html.
cursorUp(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
cursorUp(int) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
CursorVisible - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
customize(TerminalBuilder) - Method in interface org.springframework.shell.boot.TerminalCustomizer
Callback to customize a TerminalBuilder instance.
customize(CommandCatalog) - Method in interface org.springframework.shell.command.CommandCatalogCustomizer
Customize a command catalog.
customize(CommandRegistration.Builder) - Method in interface org.springframework.shell.boot.CommandRegistrationCustomizer
Callback to customize a CommandRegistration.Builder instance.
customize(ComponentFlow.Builder) - Method in interface org.springframework.shell.boot.ComponentFlowCustomizer
Callback to customize a ComponentFlow.Builder instance.
customize(NonInteractiveShellRunner) - Method in interface org.springframework.shell.boot.NonInteractiveShellRunnerCustomizer
customOptionNameModifierCommandRegistrationCustomizer(CommandRegistration.OptionNameModifier) - Method in class org.springframework.shell.boot.CommandCatalogAutoConfiguration
 

D

DANISH - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSet
 
DataStreamIteratingEmulator - Class in org.springframework.shell.test.jediterm.terminal
 
DataStreamIteratingEmulator(TerminalDataStream, Terminal) - Constructor for class org.springframework.shell.test.jediterm.terminal.DataStreamIteratingEmulator
 
DebugAligner - Class in org.springframework.shell.table
A decorator Aligner that checks the Aligner invariants contract, useful for debugging.
DebugAligner(Aligner) - Constructor for class org.springframework.shell.table.DebugAligner
 
DebugTextWrapper - Class in org.springframework.shell.table
A TextWrapper that delegates to another but makes sure that the contract is not violated.
DebugTextWrapper(TextWrapper) - Constructor for class org.springframework.shell.table.DebugTextWrapper
 
DEC_SPECIAL_CHARS - Static variable in class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSets
The DEC special characters (only the last 32 characters).
DEC_SPECIAL_GRAPHICS - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSet
 
DEC_SUPPLEMENTAL - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSet
 
DEFAULT - Static variable in class org.springframework.shell.test.jediterm.terminal.model.TerminalTypeAheadSettings
 
DEFAULT_MAX_LINES_COUNT - Static variable in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
DEFAULT_PRECEDENCE - Static variable in interface org.springframework.shell.command.CommandExceptionResolver
Default precedence related use of Ordered and Order.
DEFAULT_ROW_CAPACITY - Static variable in class org.springframework.shell.table.TableModelBuilder
 
DefaultAst() - Constructor for class org.springframework.shell.command.parser.Ast.DefaultAst
 
DefaultBuilder() - Constructor for class org.springframework.shell.command.CommandRegistration.DefaultBuilder
 
DefaultBuilder() - Constructor for class org.springframework.shell.support.search.SearchMatch.DefaultBuilder
 
DefaultCommandAlias(String, String) - Constructor for class org.springframework.shell.command.CommandAlias.DefaultCommandAlias
 
defaultCommandCatalogCustomizer(ObjectProvider<CommandRegistration>) - Method in class org.springframework.shell.boot.CommandCatalogAutoConfiguration
 
DefaultCommandExecution(List<? extends HandlerMethodArgumentResolver>, Validator, Terminal, ConversionService, CommandCatalog) - Constructor for class org.springframework.shell.command.CommandExecution.DefaultCommandExecution
 
DefaultCommandOption(String[], String[], Character[], String, ResolvableType, boolean, String, Integer, Integer, Integer, String, CompletionResolver) - Constructor for class org.springframework.shell.command.CommandOption.DefaultCommandOption
 
DefaultCommandRegistration(String[], InteractionMode, String, boolean, String, Supplier<Availability>, List<CommandRegistration.DefaultOptionSpec>, CommandRegistration.DefaultTargetSpec, List<CommandRegistration.DefaultAliasSpec>, CommandRegistration.DefaultExitCodeSpec, CommandRegistration.DefaultErrorHandlingSpec, CommandRegistration.DefaultHelpOptionsSpec) - Constructor for class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration
 
defaultCompletionResolver() - Method in class org.springframework.shell.boot.ParameterResolverAutoConfiguration
 
DefaultConfirmationInputSpec - Class in org.springframework.shell.component.flow
Default impl for BaseConfirmationInput.
DefaultConfirmationInputSpec(ComponentFlow.BaseBuilder, String) - Constructor for class org.springframework.shell.component.flow.DefaultConfirmationInputSpec
 
DefaultFormatter - Class in org.springframework.shell.table
A very simple formatter that uses Object.toString() and splits on newlines.
DefaultFormatter() - Constructor for class org.springframework.shell.table.DefaultFormatter
 
DefaultHelpOptionInfo(boolean, String[], Character[], String) - Constructor for class org.springframework.shell.command.CommandRegistration.HelpOptionInfo.DefaultHelpOptionInfo
 
DefaultInteractiveShellSession(Shell, PromptProvider, LineReader, BlockingQueue<ShellTestClient.ShellRunnerTaskData>, TerminalSession, Terminal) - Constructor for class org.springframework.shell.test.ShellTestClient.DefaultInteractiveShellSession
 
DefaultLexer(CommandModel, ParserConfig) - Constructor for class org.springframework.shell.command.parser.Lexer.DefaultLexer
 
DefaultMultiInputSpec - Class in org.springframework.shell.component.flow
Default impl for BaseMultiItemSelector.
DefaultMultiInputSpec(ComponentFlow.BaseBuilder, String) - Constructor for class org.springframework.shell.component.flow.DefaultMultiInputSpec
 
DefaultNonInteractiveShellSession(Shell, String[], BlockingQueue<ShellTestClient.ShellRunnerTaskData>, TerminalSession, Terminal) - Constructor for class org.springframework.shell.test.ShellTestClient.DefaultNonInteractiveShellSession
 
defaultOptionNameModifier(Function<String, String>) - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder
 
defaultOptionNameModifier(Function<String, String>) - Method in interface org.springframework.shell.command.CommandRegistration.Builder
Provides a global option name modifier.
defaultOptionNameModifierCommandRegistrationCustomizer(SpringShellProperties) - Method in class org.springframework.shell.boot.CommandCatalogAutoConfiguration
 
DefaultParser(CommandModel, Lexer, Ast) - Constructor for class org.springframework.shell.command.parser.Parser.DefaultParser
 
DefaultParser(CommandModel, Lexer, Ast, ParserConfig) - Constructor for class org.springframework.shell.command.parser.Parser.DefaultParser
 
DefaultParser(CommandModel, Lexer, Ast, ParserConfig, ConversionService) - Constructor for class org.springframework.shell.command.parser.Parser.DefaultParser
 
DefaultPathInputSpec - Class in org.springframework.shell.component.flow
Default impl for BasePathInput.
DefaultPathInputSpec(ComponentFlow.BaseBuilder, String) - Constructor for class org.springframework.shell.component.flow.DefaultPathInputSpec
 
defaultResultHandler(Terminal) - Method in class org.springframework.shell.result.ResultHandlerConfig
 
DefaultResultHandler - Class in org.springframework.shell.result
A simple ResultHandler that deals with Objects (hence comes as a last resort) and prints the Object.toString() value of results to standard out.
DefaultResultHandler(Terminal) - Constructor for class org.springframework.shell.result.DefaultResultHandler
 
defaults() - Static method in class org.springframework.shell.style.FigureSettings
 
defaults() - Static method in class org.springframework.shell.style.StyleSettings
Creates an instance of a default settings.
defaults() - Static method in class org.springframework.shell.style.ThemeSettings
Gets a default theme settings.
defaultSelect(String) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
defaultSelect(String) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec
Automatically selects and exposes a given item.
DefaultSelectItem - Class in org.springframework.shell.component.flow
Default impl for SelectItem.
DefaultSelectItem(String, String, boolean, boolean) - Constructor for class org.springframework.shell.component.flow.DefaultSelectItem
 
DefaultSelectorList(int) - Constructor for class org.springframework.shell.component.support.SelectorList.DefaultSelectorList
 
defaultShellApplicationRunner(List<ShellRunner>) - Method in class org.springframework.shell.boot.ApplicationRunnerAutoConfiguration
 
DefaultShellApplicationRunner - Class in org.springframework.shell
Default ShellApplicationRunner which dispatches to the first ordered ShellRunner able to handle the shell.
DefaultShellApplicationRunner(List<ShellRunner>) - Constructor for class org.springframework.shell.DefaultShellApplicationRunner
 
DefaultShellContext - Class in org.springframework.shell.context
Default implementation of a ShellContext.
DefaultShellContext() - Constructor for class org.springframework.shell.context.DefaultShellContext
 
DefaultSingleInputSpec - Class in org.springframework.shell.component.flow
Default impl for BaseSingleItemSelector.
DefaultSingleInputSpec(ComponentFlow.BaseBuilder, String) - Constructor for class org.springframework.shell.component.flow.DefaultSingleInputSpec
 
DefaultStringInputSpec - Class in org.springframework.shell.component.flow
Default impl for BaseStringInput.
DefaultStringInputSpec(ComponentFlow.BaseBuilder, String) - Constructor for class org.springframework.shell.component.flow.DefaultStringInputSpec
 
DefaultTargetInfo(CommandRegistration.TargetInfo.TargetType, Object, Method, Function<CommandContext, ?>, Consumer<CommandContext>) - Constructor for class org.springframework.shell.command.CommandRegistration.TargetInfo.DefaultTargetInfo
 
defaultValidator() - Static method in class org.springframework.shell.Utils
Gets a default shared validator.
defaultValidatorFactory() - Static method in class org.springframework.shell.Utils
Gets a default shared validation factory.
defaultValue() - Element in annotation interface org.springframework.shell.command.annotation.Option
Define option default value.
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.
defaultValue(Boolean) - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
defaultValue(Boolean) - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec
Sets a default value.
defaultValue(String) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
defaultValue(String) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec
Define a defaultValue for an option.
defaultValue(String) - Method in class org.springframework.shell.component.flow.BasePathInput
 
defaultValue(String) - Method in class org.springframework.shell.component.flow.BaseStringInput
 
defaultValue(String) - Method in interface org.springframework.shell.component.flow.PathInputSpec
Sets a default value.
defaultValue(String) - Method in interface org.springframework.shell.component.flow.StringInputSpec
Sets a default value.
DEL - Static variable in class org.springframework.shell.test.jediterm.typeahead.Ascii
Delete: This character is used primarily to "erase" or "obliterate" erroneous or unwanted characters in perforated tape.
deleteCharacters(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
deleteCharacters(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine
 
deleteCharacters(int) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
deleteCharacters(int, int, int) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
deleteCharacters(int, int, int, TextStyle) - Method in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
deleteCharacters(int, int, TextStyle) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine
 
deleteCharacters(int, TextStyle) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine
 
deleteLines(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
deleteLines(int) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
deleteLines(int, int, int) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
deleteLines(int, int, int, TerminalLine.TextEntry) - Method in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
DelimiterTextWrapper - Class in org.springframework.shell.table
A Text wrapper that wraps at "word" boundaries.
DelimiterTextWrapper() - Constructor for class org.springframework.shell.table.DelimiterTextWrapper
 
DelimiterTextWrapper(char) - Constructor for class org.springframework.shell.table.DelimiterTextWrapper
 
description() - Element in annotation interface org.springframework.shell.command.annotation.Command
Define a command description.
description() - Element in annotation interface org.springframework.shell.command.annotation.Option
Return a short description of the option.
description() - Method in class org.springframework.shell.CompletionProposal
 
description(String) - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder
 
description(String) - Method in interface org.springframework.shell.command.CommandRegistration.Builder
Define a description text for a command.
description(String) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
description(String) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec
Define a description for an option.
description(String) - Method in class org.springframework.shell.CompletionProposal
 
designateCharacterSet(int, char) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
designateCharacterSet(int, char) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
designateGraphicSet(int, CharacterSet) - Method in class org.springframework.shell.test.jediterm.terminal.emulator.charset.GraphicSetState
 
designateGraphicSet(GraphicSet, char) - Method in class org.springframework.shell.test.jediterm.terminal.emulator.charset.GraphicSetState
Designates the given graphic set to the character set designator.
DETAILS_COMMAND_NAME - Static variable in class org.springframework.shell.result.ThrowableResultHandler
The name of the command that may be used to print details about the last error.
deviceAttributes(byte[]) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
deviceAttributes(byte[]) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
deviceStatusReport(String) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
deviceStatusReport(String) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
DIM - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TextStyle.Option
 
DIRECTIVE - Enum constant in enum class org.springframework.shell.command.parser.TokenType
 
DirectiveNode - Class in org.springframework.shell.command.parser
Node representing
DirectiveNode(Token, String, String) - Constructor for class org.springframework.shell.command.parser.DirectiveNode
 
DirectiveResult - Record Class in org.springframework.shell.command.parser
Encapsulating Directive with its fields, name and value.
DirectiveResult(String, String) - Constructor for record class org.springframework.shell.command.parser.DirectiveResult
Creates an instance of a DirectiveResult record class.
directiveResults() - Method in record class org.springframework.shell.command.parser.Parser.ParseResult
Returns the value of the directiveResults record component.
disconnected() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
disconnected() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
displayText() - Method in class org.springframework.shell.CompletionProposal
 
displayText(String) - Method in class org.springframework.shell.CompletionProposal
 
dispose() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLineIntervalHighlighting
 
dispose() - Method in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
distanceToLineEnd() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
distanceToLineEnd() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
doDispose() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLineIntervalHighlighting
 
doHandleResult(Object) - Method in class org.springframework.shell.result.DefaultResultHandler
 
doHandleResult(Throwable) - Method in class org.springframework.shell.result.ThrowableResultHandler
 
doHandleResult(AttributedCharSequence) - Method in class org.springframework.shell.result.AttributedCharSequenceResultHandler
 
doHandleResult(CommandNotFound) - Method in class org.springframework.shell.result.CommandNotFoundResultHandler
 
doHandleResult(ParameterValidationException) - Method in class org.springframework.shell.result.ParameterValidationExceptionResultHandler
 
doHandleResult(TerminalSizeAware) - Method in class org.springframework.shell.result.TerminalSizeAwareResultHandler
 
doHandleResult(T) - Method in class org.springframework.shell.result.TerminalAwareResultHandler
 
doInvoke(Object...) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
Invoke the handler method with the given argument values.
dontQuote() - Method in class org.springframework.shell.CompletionProposal
 
dontQuote(boolean) - Method in class org.springframework.shell.CompletionProposal
 
DOUBLEDASH - Enum constant in enum class org.springframework.shell.command.parser.TokenType
 
downwardsArror() - Method in class org.springframework.shell.style.FigureSettings
 
drop(int) - Method in class org.springframework.shell.CompletionContext
Return a copy of this context, as if the first nbWords were not present
dump() - Static method in class org.springframework.shell.style.FigureSettings
 
dump() - Static method in class org.springframework.shell.style.StyleSettings
 
dump() - Static method in class org.springframework.shell.style.ThemeSettings
Gets a dump theme settings.
DUTCH - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSet
 
DWC - Static variable in class org.springframework.shell.test.jediterm.terminal.util.CharUtils
 

E

EightBitInput - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
emit(CharSequence) - Method in interface org.springframework.shell.CompletingParsedLine
 
emit(CharSequence) - Method in class org.springframework.shell.jline.ExtendedDefaultParser.ExtendedArgumentList
 
empty() - Static method in interface org.springframework.shell.command.CommandHandlingResult
Gets an empty instance of CommandHandlingResult.
empty() - Static method in interface org.springframework.shell.component.ConfirmationInput.ConfirmationInputContext
empty() - Static method in interface org.springframework.shell.component.context.ComponentContext
Gets an empty context.
empty() - Static method in interface org.springframework.shell.component.MultiItemSelector.MultiItemSelectorContext
empty() - Static method in interface org.springframework.shell.component.PathInput.PathInputContext
empty() - Static method in interface org.springframework.shell.component.PathSearch.PathSearchContext
empty() - Static method in interface org.springframework.shell.component.SingleItemSelector.SingleItemSelectorContext
empty() - Static method in interface org.springframework.shell.component.StringInput.StringInputContext
empty() - Static method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext
empty() - Static method in class org.springframework.shell.test.jediterm.terminal.util.Pair
 
empty(Function<C, String>) - Static method in interface org.springframework.shell.component.SingleItemSelector.SingleItemSelectorContext
empty(Function<T, String>) - Static method in interface org.springframework.shell.component.MultiItemSelector.MultiItemSelectorContext
EMPTY - Static variable in interface org.springframework.shell.Input
 
EMPTY - Static variable in class org.springframework.shell.test.jediterm.terminal.model.CharBuffer
 
EMPTY - Static variable in class org.springframework.shell.test.jediterm.terminal.TextStyle
 
EMPTY_CHAR - Static variable in class org.springframework.shell.test.jediterm.terminal.util.CharUtils
 
Emulator - Interface in org.springframework.shell.test.jediterm.terminal.emulator
 
Enableable - Interface in org.springframework.shell.component.support
 
EnableCommand - Annotation Interface in org.springframework.shell.command.annotation
Enable support for @Command annotated classes.
EnableCommandRegistrar - Class in org.springframework.shell.command.annotation.support
ImportBeanDefinitionRegistrar for @EnableCommands.
EnableCommandRegistrar() - Constructor for class org.springframework.shell.command.annotation.support.EnableCommandRegistrar
 
enabled() - Method in class org.springframework.shell.component.flow.DefaultSelectItem
 
enabled() - Method in interface org.springframework.shell.component.flow.SelectItem
Returns if item is enabled.
enabled(boolean) - Method in class org.springframework.shell.command.CommandRegistration.DefaultHelpOptionsSpec
 
enabled(boolean) - Method in interface org.springframework.shell.command.CommandRegistration.HelpOptionsSpec
Whether help options are enabled.
enabledByDefault() - Method in enum class org.springframework.shell.command.parser.ParserConfig.Feature
 
enabledIn(int) - Method in enum class org.springframework.shell.command.parser.ParserConfig.Feature
 
ENQ - Static variable in class org.springframework.shell.test.jediterm.typeahead.Ascii
Enquiry: A communication control character used in data communication systems as a request for a response from a remote station.
enumValueProvider() - Method in class org.springframework.shell.boot.StandardAPIAutoConfiguration
 
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
 
EOF() - Constructor for exception org.springframework.shell.test.jediterm.terminal.TerminalDataStream.EOF
 
equals(Object) - Method in class org.springframework.shell.Command.Help
 
equals(Object) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
 
equals(Object) - Method in record class org.springframework.shell.command.parser.Ast.AstResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.shell.command.parser.DirectiveResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.shell.command.parser.Lexer.LexerResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.shell.command.parser.MessageResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.shell.command.parser.Parser.ParseResult.ArgumentResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.shell.command.parser.Parser.ParseResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.springframework.shell.command.parser.Parser.ParseResult.OptionResult
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.springframework.shell.test.jediterm.terminal.TextStyle
 
equals(Object) - Method in class org.springframework.shell.test.jediterm.terminal.util.Pair
 
equals(Object) - Method in record class org.springframework.shell.test.ShellTestClient.ShellRunnerTaskData
Indicates whether some other object is "equal to" this one.
eraseCharacters(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
eraseCharacters(int) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
eraseCharacters(int, int, int) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
eraseInDisplay(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
eraseInDisplay(int) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
eraseInLine(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
eraseInLine(int) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
error() - Method in interface org.springframework.shell.result.CommandNotFoundMessageProvider.ProviderContext
Gets an actual error.
error() - Method in class org.springframework.shell.style.FigureSettings
 
ERROR - Enum constant in enum class org.springframework.shell.command.parser.ParserMessage.Type
 
ERROR - Enum constant in enum class org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext.MessageLevel
 
errors() - Method in interface org.springframework.shell.command.CommandParser.CommandParserResults
Gets parsing errors.
errors() - Method in class org.springframework.shell.command.CommandParser.DefaultCommandParserResults
 
ESC - Static variable in class org.springframework.shell.test.jediterm.typeahead.Ascii
Escape: A control character intended to provide code extension (supplementary characters) in general information interchange.
evaluate(String[]) - Method in class org.springframework.shell.command.CommandExecution.DefaultCommandExecution
 
evaluate(String[]) - Method in interface org.springframework.shell.command.CommandExecution
Evaluate a command with a given arguments.
evaluate(Input) - Method in class org.springframework.shell.Shell
Evaluate a single "line" of input from the user by trying to map words to a command and arguments.
evaluateExpression(String) - Method in class org.springframework.shell.style.ThemeResolver
Evaluate expression.
EXACTLY_ONE - Enum constant in enum class org.springframework.shell.command.CommandRegistration.OptionArity
Define min(1), max(1).
ExceptionResolver - Annotation Interface in org.springframework.shell.command.annotation
Annotation for handling exceptions in specific command classes and/or its methods.
ExceptionResolverMethodResolver - Class in org.springframework.shell.command.annotation
 
ExceptionResolverMethodResolver(Class<?>) - Constructor for class org.springframework.shell.command.annotation.ExceptionResolverMethodResolver
A constructor that finds ExceptionResolver methods in the given type.
excludeAutoConfiguration() - Element in annotation interface org.springframework.shell.test.autoconfigure.ShellTest
Auto-configuration exclusions that should be applied for this test.
excludeFilters() - Element in annotation interface org.springframework.shell.test.autoconfigure.ShellTest
A set of exclude filters which can be used to filter beans that would otherwise be added to the application context.
exitCode() - Method in class org.springframework.shell.command.CommandHandlingResult.DefaultHandlingResult
 
exitCode() - Method in interface org.springframework.shell.command.CommandHandlingResult
Gets an exit code for this CommandHandlingResult.
ExitCode - Annotation Interface in org.springframework.shell.command.annotation
Defines exit code.
ExitCodeAutoConfiguration - Class in org.springframework.shell.boot
Auto-configuration for exit codes.
ExitCodeAutoConfiguration() - Constructor for class org.springframework.shell.boot.ExitCodeAutoConfiguration
 
exitCodeExceptionProvider() - Method in class org.springframework.shell.boot.ExitCodeAutoConfiguration
 
ExitCodeExceptionProvider - Interface in org.springframework.shell.exit
Interface to provide exception for an exit code.
ExitCodeMappings - Interface in org.springframework.shell.exit
Interface used with implementation of a boot's ExitCodeExceptionMapper in a context of spring-shell spesific one.
ExitRequest - Exception in org.springframework.shell
This exception, when thrown and caught, will ask the shell to gracefully shutdown.
ExitRequest() - Constructor for exception org.springframework.shell.ExitRequest
 
ExitRequest(int) - Constructor for exception org.springframework.shell.ExitRequest
 
ExtendedArgumentList(String, List<String>, int, int, int, String) - Constructor for class org.springframework.shell.jline.ExtendedDefaultParser.ExtendedArgumentList
 
ExtendedDefaultParser - Class in org.springframework.shell.jline
Shameful copy-paste of JLine's DefaultParser which creates CompletingParsedLine.
ExtendedDefaultParser() - Constructor for class org.springframework.shell.jline.ExtendedDefaultParser
 
ExtendedDefaultParser.ExtendedArgumentList - Class in org.springframework.shell.jline
The result of a delimited buffer.
Extent(int, int) - Constructor for class org.springframework.shell.table.SizeConstraints.Extent
 

F

fancy_double - Enum constant in enum class org.springframework.shell.table.BorderStyle
A border style that uses dedicated double-light box drawing characters from the unicode set.
fancy_heavy - Enum constant in enum class org.springframework.shell.table.BorderStyle
A border style that uses dedicated fat box drawing characters from the unicode set.
fancy_heavy_double_dash - Enum constant in enum class org.springframework.shell.table.BorderStyle
A border style that uses dedicated double dash heavy box drawing characters from the unicode set.
fancy_heavy_quadruple_dash - Enum constant in enum class org.springframework.shell.table.BorderStyle
A border style that uses dedicated double dash heavy box drawing characters from the unicode set.
fancy_heavy_triple_dash - Enum constant in enum class org.springframework.shell.table.BorderStyle
A border style that uses dedicated double dash heavy box drawing characters from the unicode set.
fancy_light - Enum constant in enum class org.springframework.shell.table.BorderStyle
A border style that uses dedicated light box drawing characters from the unicode set.
fancy_light_double_dash - Enum constant in enum class org.springframework.shell.table.BorderStyle
A border style that uses dedicated double dash light box drawing characters from the unicode set.
fancy_light_quadruple_dash - Enum constant in enum class org.springframework.shell.table.BorderStyle
A border style that uses dedicated double dash light box drawing characters from the unicode set.
fancy_light_triple_dash - Enum constant in enum class org.springframework.shell.table.BorderStyle
A border style that uses dedicated double dash light box drawing characters from the unicode set.
FF - Static variable in class org.springframework.shell.test.jediterm.typeahead.Ascii
Form Feed ('\f'): A format effector which controls the movement of the printing position to the first pre-determined printing line on the next form or page.
figures() - Method in class org.springframework.shell.style.ThemeSettings
FigureSettings - Class in org.springframework.shell.style
Base class defining a settings for figures.
FigureSettings() - Constructor for class org.springframework.shell.style.FigureSettings
 
FileInputProvider - Class in org.springframework.shell.jline
An InputProvider that reads input from file-like sources.
FileInputProvider(Reader, Parser) - Constructor for class org.springframework.shell.jline.FileInputProvider
 
fileValueProvider() - Method in class org.springframework.shell.boot.StandardAPIAutoConfiguration
 
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
 
fillScreen(char) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
fillScreen(char) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
findProvidedArgument(MethodParameter, Object...) - Static method in class org.springframework.shell.command.invocation.InvocableShellMethod
 
findScreenLineIndex(TerminalLine) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
FINNISH - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSet
 
first - Variable in class org.springframework.shell.test.jediterm.terminal.util.Pair
 
FLAT - Enum constant in enum class org.springframework.shell.boot.SpringShellProperties.HelpCommand.GroupingMode
 
format(Object) - Method in class org.springframework.shell.table.DefaultFormatter
 
format(Object) - Method in interface org.springframework.shell.table.Formatter
 
format(Object) - Method in class org.springframework.shell.table.MapFormatter
 
formatArgumentError(MethodParameter, String) - Static method in class org.springframework.shell.command.invocation.InvocableShellMethod
 
formatInvokeError(String, Object[]) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
 
formatMessage(int, Object...) - Method in enum class org.springframework.shell.command.parser.ParserMessage
 
Formatter - Interface in org.springframework.shell.table
A Formatter is responsible for the initial rendering of a value to lines of text.
forward(boolean) - Method in interface org.springframework.shell.support.search.SearchMatch.Builder
Set a flag for forward.
forward(boolean) - Method in class org.springframework.shell.support.search.SearchMatch.DefaultBuilder
 
FRENCH - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSet
 
FRENCH_CANADIAN - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSet
 
fromRowColumn(int, int) - Method in class org.springframework.shell.table.TableBuilder.BorderStub
 
fromTopLeft() - Method in class org.springframework.shell.table.TableBuilder.BorderStub
 
FULL - Static variable in class org.springframework.shell.table.BorderSpecification
 
function(Function<CommandContext, ?>) - Method in class org.springframework.shell.command.CommandRegistration.DefaultTargetSpec
 
function(Function<CommandContext, ?>) - Method in interface org.springframework.shell.command.CommandRegistration.TargetSpec
Register a function target.
FUNCTION - Enum constant in enum class org.springframework.shell.command.CommandRegistration.TargetInfo.TargetType
 

G

generate(String) - Method in class org.springframework.shell.standard.completion.BashCompletions
 
generate(List<Token>) - Method in class org.springframework.shell.command.parser.Ast.DefaultAst
 
generate(List<Token>) - Method in interface org.springframework.shell.command.parser.Ast
Generate ast result from a tokens.
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.
GenericResultHandler - Interface in org.springframework.shell.result
 
GenericResultHandlerService - Class in org.springframework.shell.result
Base implementation suitable for use in most environments.
GenericResultHandlerService() - Constructor for class org.springframework.shell.result.GenericResultHandlerService
 
GERMAN - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSet
 
get(Object) - Method in class org.springframework.shell.component.context.BaseComponentContext
 
get(Object) - Method in interface org.springframework.shell.component.context.ComponentContext
Gets a value from a context.
get(Object, Class<T>) - Method in class org.springframework.shell.component.context.BaseComponentContext
 
get(Object, Class<T>) - Method in interface org.springframework.shell.component.context.ComponentContext
Gets a value from a context with a given type to get cast to.
get(String) - Method in class org.springframework.shell.style.ThemeRegistry
Gets a theme from a registry.
getAlgorithm() - Method in class org.springframework.shell.support.search.SearchMatchResult.DefaultResult
 
getAlgorithm() - Method in interface org.springframework.shell.support.search.SearchMatchResult
Get SearchMatchAlgorithm handling a search.
getAliases() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration
 
getAliases() - Method in interface org.springframework.shell.command.CommandRegistration
Gets an aliases.
getApplicationContext() - Method in class org.springframework.shell.standard.AbstractShellComponent
 
getArityMax() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption
 
getArityMax() - Method in interface org.springframework.shell.command.CommandOption
Gets a maximum arity.
getArityMax() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
getArityMin() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption
 
getArityMin() - Method in interface org.springframework.shell.command.CommandOption
Gets a minimum arity.
getArityMin() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
getAvailability() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration
 
getAvailability() - Method in interface org.springframework.shell.command.CommandRegistration
Get Availability for a command
getAvailability() - Method in exception org.springframework.shell.CommandNotCurrentlyAvailable
 
getBean() - Method in class org.springframework.shell.command.CommandRegistration.TargetInfo.DefaultTargetInfo
 
getBean() - Method in interface org.springframework.shell.command.CommandRegistration.TargetInfo
Get the bean.
getBean() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
Return the bean for this handler method.
getBeanType() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
This method returns the type of the handler for this handler method.
getBridgedMethod() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
If the bean method is a bridge method, this method returns the bridged (user-defined) method.
getBuf() - Method in class org.springframework.shell.test.jediterm.terminal.model.CharBuffer
 
getBuffersCharAt(int, int) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
getBuilder() - Method in class org.springframework.shell.component.flow.BaseInput
 
getCanonicalStyle(TextStyle) - Static method in class org.springframework.shell.test.jediterm.terminal.TextStyle
 
getCaseType() - Method in class org.springframework.shell.boot.SpringShellProperties.OptionNaming
 
getChar() - Method in class org.springframework.shell.test.jediterm.terminal.ArrayTerminalDataStream
 
getChar() - Method in interface org.springframework.shell.test.jediterm.terminal.TerminalDataStream
 
getChar() - Method in class org.springframework.shell.test.jediterm.terminal.TtyBasedArrayDataStream
 
getChar(char, GraphicSet, GraphicSet) - Static method in class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSets
Returns the character mapping for a given original value using the given graphic sets GL and GR.
getCharAt(int, int) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
getCharName(char, GraphicSet, GraphicSet) - Static method in class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSets
Returns the name for the given character using the given graphic sets GL and GR.
getChildren() - Method in class org.springframework.shell.command.parser.NonterminalAstNode
 
getClear() - Method in class org.springframework.shell.boot.SpringShellProperties.Command
 
getCode() - Method in enum class org.springframework.shell.command.parser.ParserMessage
 
getColumnCount() - Method in class org.springframework.shell.table.ArrayTableModel
 
getColumnCount() - Method in class org.springframework.shell.table.BeanListTableModel
 
getColumnCount() - Method in class org.springframework.shell.table.TableModel
 
getColumnCount() - Method in interface org.springframework.shell.test.jediterm.terminal.TerminalDisplay
 
getColumnCount() - Method in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
getCommand() - Method in class org.springframework.shell.boot.SpringShellProperties
 
getCommand() - Method in class org.springframework.shell.boot.SpringShellProperties.Help
 
getCommand() - Method in class org.springframework.shell.command.CommandAlias.DefaultCommandAlias
 
getCommand() - Method in interface org.springframework.shell.command.CommandAlias
Gets a command an alias.
getCommand() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration
 
getCommand() - Method in interface org.springframework.shell.command.CommandRegistration
Gets a command for this registration.
getCommand() - Method in class org.springframework.shell.command.CommandRegistration.HelpOptionInfo.DefaultHelpOptionInfo
 
getCommand() - Method in interface org.springframework.shell.command.CommandRegistration.HelpOptionInfo
Gets command for help.
getCommand() - Method in class org.springframework.shell.command.parser.CommandNode
 
getCommand() - Method in exception org.springframework.shell.CommandNotCurrentlyAvailable
 
getCommandCatalog() - Method in class org.springframework.shell.standard.AbstractShellComponent
 
getCommandOption() - Method in class org.springframework.shell.CompletionContext
 
getCommandRegistration() - Method in class org.springframework.shell.command.CommandContext.DefaultCommandContext
 
getCommandRegistration() - Method in interface org.springframework.shell.command.CommandContext
Gets a command registration.
getCommandRegistration() - Method in class org.springframework.shell.CompletionContext
 
getCommandsTemplate() - Method in class org.springframework.shell.boot.SpringShellProperties.HelpCommand
 
getCommandTemplate() - Method in class org.springframework.shell.boot.SpringShellProperties.HelpCommand
 
getComparator() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
getComparator() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
getCompletion() - Method in class org.springframework.shell.boot.SpringShellProperties.Command
 
getCompletion() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption
 
getCompletion() - Method in interface org.springframework.shell.command.CommandOption
Gets a completion function.
getCompletion() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
getCompletionResolver() - Method in class org.springframework.shell.standard.AbstractShellComponent
 
getConfig() - Method in class org.springframework.shell.boot.SpringShellProperties
 
getConstraintViolations() - Method in exception org.springframework.shell.ParameterValidationException
 
getConsumer() - Method in class org.springframework.shell.command.CommandRegistration.TargetInfo.DefaultTargetInfo
 
getConsumer() - Method in interface org.springframework.shell.command.CommandRegistration.TargetInfo
Get the consumer
getContainingClass() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod.HandlerMethodParameter
 
getContents(boolean) - Method in interface org.springframework.shell.test.jediterm.terminal.TerminalCopyPasteHandler
 
getContext() - Method in interface org.springframework.shell.component.flow.ComponentFlow.ComponentFlowResult
Gets a context.
getContext() - Method in class org.springframework.shell.component.flow.ComponentFlow.DefaultComponentFlowResult
 
getCurrent() - Method in class org.springframework.shell.test.jediterm.terminal.model.StyleState
 
getCurrentSession() - Method in class org.springframework.shell.test.jediterm.terminal.ui.JediTermWidget
 
getCurrentSession() - Method in interface org.springframework.shell.test.jediterm.terminal.ui.TerminalWidget
 
getCursorRow() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext
 
getCursorRow() - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext
Gets a cursor row.
getCursorX() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
getCursorX() - Method in class org.springframework.shell.test.jediterm.terminal.model.StoredCursor
 
getCursorX() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
getCursorY() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
getCursorY() - Method in class org.springframework.shell.test.jediterm.terminal.model.StoredCursor
 
getCursorY() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
getDebugInfo() - Method in class org.springframework.shell.test.jediterm.terminal.emulator.ControlSequence
 
getDefaultIncludes() - Method in class org.springframework.shell.test.autoconfigure.ShellTypeExcludeFilter
 
getDefaultSelect() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
getDefaultValue() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption
 
getDefaultValue() - Method in interface org.springframework.shell.command.CommandOption
Gets a default value of an option.
getDefaultValue() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
getDefaultValue() - Method in interface org.springframework.shell.component.ConfirmationInput.ConfirmationInputContext
Gets a default value.
getDefaultValue() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
getDefaultValue() - Method in class org.springframework.shell.component.flow.BasePathInput
 
getDefaultValue() - Method in class org.springframework.shell.component.flow.BaseStringInput
 
getDefaultValue() - Method in interface org.springframework.shell.component.StringInput.StringInputContext
Gets a default value.
getDescription() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption
 
getDescription() - Method in interface org.springframework.shell.command.CommandOption
Gets a description of an option.
getDescription() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration
 
getDescription() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
getDescription() - Method in interface org.springframework.shell.command.CommandRegistration
Get description for a command.
getDescription() - Method in class org.springframework.shell.Command.Help
 
getDesignation() - Method in class org.springframework.shell.test.jediterm.terminal.emulator.charset.GraphicSet
 
getDesignations() - Method in class org.springframework.shell.test.jediterm.terminal.model.StoredCursor
 
getDirCount() - Method in class org.springframework.shell.component.PathSearch.PathScannerResult
 
getEnd() - Method in class org.springframework.shell.support.search.SearchMatchResult.DefaultResult
 
getEnd() - Method in interface org.springframework.shell.support.search.SearchMatchResult
Get end of a match.
getEndOffset() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLineIntervalHighlighting
 
getEntries() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine
 
getEnv() - Method in class org.springframework.shell.boot.SpringShellProperties.Config
 
getEscapeChars() - Method in class org.springframework.shell.jline.ExtendedDefaultParser
 
getExceptionResolvers() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration
 
getExceptionResolvers() - Method in interface org.springframework.shell.command.CommandRegistration
Gets an exception resolvers.
getExitCode() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration
 
getExitCode() - Method in interface org.springframework.shell.command.CommandRegistration
Gets an exit code.
getFileCount() - Method in class org.springframework.shell.component.PathSearch.PathScannerResult
 
getFinalChar() - Method in class org.springframework.shell.test.jediterm.terminal.emulator.ControlSequence
 
getFirst() - Method in class org.springframework.shell.test.jediterm.terminal.util.Pair
 
getFirst(Pair<T, ?>) - Static method in class org.springframework.shell.test.jediterm.terminal.util.Pair
 
getFunction() - Method in class org.springframework.shell.command.CommandRegistration.TargetInfo.DefaultTargetInfo
 
getFunction() - Method in interface org.springframework.shell.command.CommandRegistration.TargetInfo
Get the function
getGL() - Method in class org.springframework.shell.test.jediterm.terminal.emulator.charset.GraphicSetState
Returns the (possibly overridden) GL graphic set.
getGLMapping() - Method in class org.springframework.shell.test.jediterm.terminal.model.StoredCursor
 
getGLOverride() - Method in class org.springframework.shell.test.jediterm.terminal.model.StoredCursor
 
getGLOverrideIndex() - Method in class org.springframework.shell.test.jediterm.terminal.emulator.charset.GraphicSetState
 
getGR() - Method in class org.springframework.shell.test.jediterm.terminal.emulator.charset.GraphicSetState
Returns the GR graphic set.
getGraphicSet(int) - Method in class org.springframework.shell.test.jediterm.terminal.emulator.charset.GraphicSetState
Returns the current graphic set (one of four).
getGRMapping() - Method in class org.springframework.shell.test.jediterm.terminal.model.StoredCursor
 
getGroup() - Method in class org.springframework.shell.command.CommandAlias.DefaultCommandAlias
 
getGroup() - Method in interface org.springframework.shell.command.CommandAlias
Get group for an alias.
getGroup() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration
 
getGroup() - Method in interface org.springframework.shell.command.CommandRegistration
Get group for a command.
getGroup() - Method in class org.springframework.shell.Command.Help
 
getGroupingMode() - Method in class org.springframework.shell.boot.SpringShellProperties.HelpCommand
 
getHandlerTypes() - Method in interface org.springframework.shell.result.GenericResultHandler
 
getHeavyDecBoxChar(char) - Static method in class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSets
 
getHeight() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
getHelp() - Method in class org.springframework.shell.boot.SpringShellProperties.Command
 
getHelp() - Method in class org.springframework.shell.boot.SpringShellProperties
 
getHelpOption() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration
 
getHelpOption() - Method in interface org.springframework.shell.command.CommandRegistration
Gets a help option info.
getHistory() - Method in class org.springframework.shell.boot.SpringShellProperties.Command
 
getHistory() - Method in class org.springframework.shell.boot.SpringShellProperties
 
getHistoryBuffer() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
getHistoryLinesCount() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
getId() - Method in class org.springframework.shell.component.flow.BaseInput
 
getId() - Method in class org.springframework.shell.component.flow.ComponentFlow.OrderedInputOperation
 
getId() - Method in class org.springframework.shell.test.jediterm.terminal.TextStyle
 
getIndex() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.ItemState
 
getIndex() - Method in class org.springframework.shell.test.jediterm.terminal.emulator.charset.GraphicSet
 
getInput() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext
 
getInput() - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext
Gets an input.
getInput() - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext
 
getInput() - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext
Gets an input.
getInsetX() - Method in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
getInteractionMode() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration
 
getInteractionMode() - Method in interface org.springframework.shell.command.CommandRegistration
getInteractionMode() - Method in class org.springframework.shell.context.DefaultShellContext
 
getInteractionMode() - Method in interface org.springframework.shell.context.ShellContext
Gets an interaction mode.
getInteractive() - Method in class org.springframework.shell.boot.SpringShellProperties
 
getItem() - Method in interface org.springframework.shell.component.support.Itemable
 
getItem() - Method in class org.springframework.shell.component.support.SelectorItem.SelectorItemWrapper
 
getItem() - Method in class org.springframework.shell.component.support.SelectorList.BaseProjectionItem
 
getItem() - Method in interface org.springframework.shell.component.support.SelectorList.ProjectionItem
 
getItemMapper() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent
Gets an item mapper.
getItems() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext
 
getItems() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent
Gets items.
getItems() - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext
Gets an items.
getItemStates() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext
 
getItemStates() - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext
Gets an item states
getItemStateView() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext
 
getItemStateView() - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext
Gets an item state view.
getLabel() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption
 
getLabel() - Method in interface org.springframework.shell.command.CommandOption
Gets a label.
getLabel() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
getLastError() - Method in class org.springframework.shell.result.ThrowableResultHandler
Return the last error that was dealt with by this result handler.
getLatencyThreshold() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTypeAheadSettings
 
getLength() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine.TextEntry
 
getLength() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLineIntervalHighlighting
 
getLine() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLineIntervalHighlighting
 
getLine(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
getLine(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
Returns terminal lines.
getLineCount() - Method in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
getLines() - Method in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
getLineText(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
getLocation() - Method in class org.springframework.shell.boot.SpringShellProperties.Config
 
getLongNames() - Method in class org.springframework.shell.boot.SpringShellProperties.Help
 
getLongNames() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption
 
getLongNames() - Method in interface org.springframework.shell.command.CommandOption
Gets a long names of an option.
getLongNames() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
getLongNames() - Method in class org.springframework.shell.command.CommandRegistration.HelpOptionInfo.DefaultHelpOptionInfo
 
getLongNames() - Method in interface org.springframework.shell.command.CommandRegistration.HelpOptionInfo
Gets long names options for help.
getLongNamesModified() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption
 
getLongNamesModified() - Method in interface org.springframework.shell.command.CommandOption
Gets a modified long names of an option.
getMappingFunctions() - Method in class org.springframework.shell.command.CommandExitCode.DefaultCommandExitCode
 
getMappingFunctions() - Method in interface org.springframework.shell.command.CommandExitCode
Gets a function mappings from exceptions to exit codes.
getMask() - Method in enum class org.springframework.shell.command.parser.ParserConfig.Feature
 
getMaskCharacter() - Method in class org.springframework.shell.component.flow.BaseStringInput
 
getMaskCharacter() - Method in interface org.springframework.shell.component.StringInput.StringInputContext
Gets a mask character.
getMaskedInput() - Method in interface org.springframework.shell.component.StringInput.StringInputContext
Gets a masked input.
getMaskedResultValue() - Method in interface org.springframework.shell.component.StringInput.StringInputContext
Gets a masked result value.
getMaxItems() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
getMaxItems() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
getMaxPathsSearch() - Method in class org.springframework.shell.component.PathSearch.PathSearchConfig
 
getMaxPathsShow() - Method in class org.springframework.shell.component.PathSearch.PathSearchConfig
 
getMessage() - Method in record class org.springframework.shell.command.parser.MessageResult
Gets a formatted message using position and inserts.
getMessage() - Method in exception org.springframework.shell.CommandNotFound
 
getMessage() - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext
 
getMessage() - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext
Sets a message.
getMessageLevel() - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext
 
getMessageLevel() - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext
getMethod() - Method in class org.springframework.shell.command.CommandRegistration.TargetInfo.DefaultTargetInfo
 
getMethod() - Method in interface org.springframework.shell.command.CommandRegistration.TargetInfo
Get the bean method
getMethod() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
Return the method for this handler method.
getMethodAnnotation(Class<A>) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
Return a single annotation on the underlying method traversing its super methods if no annotation can be found on the given method itself.
getMethodAnnotation(Class<T>) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod.HandlerMethodParameter
 
getMethodArgumentValues(Message<?>, Object...) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
Get the method argument values for the current message, checking the provided argument values and falling back to the configured argument resolvers.
getMethodParameters() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
Return the method parameters for this handler method.
getModel() - Method in class org.springframework.shell.table.Table
 
getModel() - Method in class org.springframework.shell.table.TableBuilder
 
getName() - Method in class org.springframework.shell.boot.SpringShellProperties.History
 
getName() - Method in class org.springframework.shell.boot.SpringShellProperties.Theme
 
getName() - Method in class org.springframework.shell.command.parser.DirectiveNode
 
getName() - Method in class org.springframework.shell.command.parser.OptionNode
 
getName() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
getName() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
getName() - Method in class org.springframework.shell.component.flow.BasePathInput
 
getName() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
getName() - Method in class org.springframework.shell.component.flow.BaseStringInput
 
getName() - Method in class org.springframework.shell.component.PathSearch.PathSearchContext.PathViewItem
 
getName() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext
 
getName() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.ItemState
 
getName() - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext
Gets a name.
getName() - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext
 
getName() - Method in class org.springframework.shell.component.support.AbstractTextComponent
Gets a name.
getName() - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext
Gets a name.
getName() - Method in interface org.springframework.shell.component.support.Nameable
 
getName() - Method in class org.springframework.shell.component.support.SelectorItem.SelectorItemWrapper
 
getName() - Method in class org.springframework.shell.component.support.SelectorList.BaseProjectionItem
 
getName() - Method in interface org.springframework.shell.style.Theme
Gets a theme name.
getName() - Method in interface org.springframework.shell.test.jediterm.terminal.TtyConnector
 
getNaming() - Method in class org.springframework.shell.boot.SpringShellProperties.Option
 
getNext() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
getNext() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
getNext() - Method in class org.springframework.shell.component.flow.BasePathInput
 
getNext() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
getNext() - Method in class org.springframework.shell.component.flow.BaseStringInput
 
getNext() - Method in class org.springframework.shell.component.flow.ComponentFlow.OrderedInputOperation
 
getNextTabWidth(int) - Method in interface org.springframework.shell.test.jediterm.terminal.model.Tabulator
Returns the width of the tab stop that is at or after the given position.
getNonControlCharacters(int, char[], int, int) - Static method in class org.springframework.shell.test.jediterm.terminal.util.CharUtils
 
getNoninteractive() - Method in class org.springframework.shell.boot.SpringShellProperties
 
getOffset() - Method in class org.springframework.shell.test.jediterm.terminal.model.SubCharBuffer
 
getOperation() - Method in class org.springframework.shell.component.flow.ComponentFlow.OrderedInputOperation
 
getOption() - Method in class org.springframework.shell.boot.SpringShellProperties
 
getOptionNameModifier() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
getOptions() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration
 
getOptions() - Method in interface org.springframework.shell.command.CommandRegistration
Gets an options.
getOptionValue(String) - Method in class org.springframework.shell.command.CommandContext.DefaultCommandContext
 
getOptionValue(String) - Method in interface org.springframework.shell.command.CommandContext
Gets an mapped option value.
getOrder() - Method in class org.springframework.shell.component.flow.BaseInput
 
getOrder() - Method in class org.springframework.shell.component.flow.ComponentFlow.OrderedInputOperation
 
getParent() - Method in class org.springframework.shell.test.jediterm.terminal.model.SubCharBuffer
 
getParentCommandNode() - Method in class org.springframework.shell.command.parser.CommandArgumentNode
 
getParentOptionNode() - Method in class org.springframework.shell.command.parser.OptionArgumentNode
 
getParserExceptions() - Method in exception org.springframework.shell.command.CommandExecution.CommandParserExceptionsException
 
getParserResults() - Method in class org.springframework.shell.command.CommandContext.DefaultCommandContext
 
getParserResults() - Method in interface org.springframework.shell.command.CommandContext
Gets a command option parser results.
getParts() - Method in class org.springframework.shell.style.PartsText
 
getPartsText() - Method in class org.springframework.shell.component.PathSearch.PathSearchContext.PathViewItem
 
getPath() - Method in class org.springframework.shell.component.PathSearch.PathSearchContext.PathViewItem
 
getPath() - Method in class org.springframework.shell.component.PathSearch.ScoredPath
 
getPathSearchConfig() - Method in interface org.springframework.shell.component.PathSearch.PathSearchContext
Get path search config.
getPathViewItems() - Method in interface org.springframework.shell.component.PathSearch.PathSearchContext
Gets a path view items.
getPixelHeight() - Method in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
getPixelWidth() - Method in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
getPosition() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption
 
getPosition() - Method in interface org.springframework.shell.command.CommandOption
Gets a positional value.
getPosition() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
getPosition() - Method in class org.springframework.shell.command.parser.Token
 
getPosition() - Method in class org.springframework.shell.CompletionContext
 
getPositions() - Method in class org.springframework.shell.support.search.SearchMatchResult.DefaultResult
 
getPositions() - Method in interface org.springframework.shell.support.search.SearchMatchResult
Get positions of a match.
getPostHandlers() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
getPostHandlers() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
getPostHandlers() - Method in class org.springframework.shell.component.flow.BasePathInput
 
getPostHandlers() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
getPostHandlers() - Method in class org.springframework.shell.component.flow.BaseStringInput
 
getPreHandlers() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
getPreHandlers() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
getPreHandlers() - Method in class org.springframework.shell.component.flow.BasePathInput
 
getPreHandlers() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
getPreHandlers() - Method in class org.springframework.shell.component.flow.BaseStringInput
 
getPreviousTabWidth(int) - Method in interface org.springframework.shell.test.jediterm.terminal.model.Tabulator
Returns the width of the tab stop that is before the given position.
getProjection() - Method in class org.springframework.shell.component.support.SelectorList.DefaultSelectorList
 
getProjection() - Method in interface org.springframework.shell.component.support.SelectorList
 
getPrompt() - Method in interface org.springframework.shell.jline.PromptProvider
 
getPromptUpdatedAfterResizeFuture(BiConsumer<Long, Runnable>) - Method in class org.springframework.shell.test.jediterm.terminal.emulator.JediEmulator
 
getProperties(Class<?>) - Method in class org.springframework.shell.test.autoconfigure.ShellTestContextBootstrapper
 
getQuit() - Method in class org.springframework.shell.boot.SpringShellProperties.Command
 
getQuoteChars() - Method in class org.springframework.shell.jline.ExtendedDefaultParser
 
getRawArgs() - Method in class org.springframework.shell.command.CommandContext.DefaultCommandContext
 
getRawArgs() - Method in interface org.springframework.shell.command.CommandContext
Gets a raw args passed into a currently executing command.
getReason() - Method in class org.springframework.shell.Availability
 
getRegistrations() - Method in class org.springframework.shell.command.CommandCatalog.DefaultCommandCatalog
 
getRegistrations() - Method in interface org.springframework.shell.command.CommandCatalog
Gets all CommandRegistrations mapped with their names.
getRegistrations() - Method in exception org.springframework.shell.CommandNotFound
Gets command registrations known when this error was created.
getRenderer() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
getRenderer() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
getRenderer() - Method in class org.springframework.shell.component.flow.BasePathInput
 
getRenderer() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
getRenderer() - Method in class org.springframework.shell.component.flow.BaseStringInput
 
getResolvedFromHandlerMethod() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
Return the HandlerMethod from which this HandlerMethod instance was resolved via InvocableShellMethod.createWithResolvedBean().
getResolvers() - Method in class org.springframework.shell.command.CommandExecution.CommandExecutionHandlerMethodArgumentResolvers
 
getResolvers() - Method in class org.springframework.shell.command.invocation.ShellMethodArgumentResolverComposite
Return a read-only list with the contained resolvers, or an empty list.
getResourceLoader() - Method in class org.springframework.shell.standard.AbstractShellComponent
 
getResult() - Method in class org.springframework.shell.component.PathSearch.ScoredPath
 
getResultItem() - Method in interface org.springframework.shell.component.SingleItemSelector.SingleItemSelectorContext
Gets a result item.
getResultItems() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext
 
getResultItems() - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext
Gets a result items.
getResultMode() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
getResultMode() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
getResultMode() - Method in class org.springframework.shell.component.flow.BasePathInput
 
getResultMode() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
getResultMode() - Method in class org.springframework.shell.component.flow.BaseStringInput
 
getResultType() - Method in exception org.springframework.shell.result.ResultHandlerNotFoundException
Return the source type that was requested to convert from.
getResultValue() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
getResultValue() - Method in class org.springframework.shell.component.flow.BasePathInput
 
getResultValue() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
getResultValue() - Method in class org.springframework.shell.component.flow.BaseStringInput
 
getResultValue() - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext
 
getResultValue() - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext
Sets a result value.
getResultValues() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
getReturnType() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
Return the HandlerMethod return type.
getReturnValueType(Object) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
Return the actual return value type.
getRootCommand() - Method in class org.springframework.shell.boot.SpringShellProperties.CompletionCommand
 
getRowCount() - Method in class org.springframework.shell.table.ArrayTableModel
 
getRowCount() - Method in class org.springframework.shell.table.BeanListTableModel
 
getRowCount() - Method in class org.springframework.shell.table.TableModel
 
getRowCount() - Method in interface org.springframework.shell.test.jediterm.terminal.TerminalDisplay
 
getRowCount() - Method in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
getScore() - Method in class org.springframework.shell.support.search.SearchMatchResult.DefaultResult
 
getScore() - Method in interface org.springframework.shell.support.search.SearchMatchResult
Get score of a match.
getScoredPaths() - Method in class org.springframework.shell.component.PathSearch.PathScannerResult
 
getScreen() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
getScreenLinesCount() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
getScript() - Method in class org.springframework.shell.boot.SpringShellProperties.Command
 
getScript() - Method in class org.springframework.shell.boot.SpringShellProperties
 
getScrollBuffer() - Method in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
getSecond() - Method in class org.springframework.shell.test.jediterm.terminal.util.Pair
 
getSecond(Pair<?, T>) - Static method in class org.springframework.shell.test.jediterm.terminal.util.Pair
 
getSelected() - Method in class org.springframework.shell.component.support.SelectorList.DefaultSelectorList
 
getSelected() - Method in interface org.springframework.shell.component.support.SelectorList
 
getSelectItems() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
getSelectItems() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
getSessionName() - Method in class org.springframework.shell.test.jediterm.terminal.ui.JediTermWidget
 
getSessionName() - Method in interface org.springframework.shell.test.jediterm.terminal.ui.TerminalSession
 
getSettings() - Method in interface org.springframework.shell.style.Theme
Gets a theme settings.
getShell() - Method in class org.springframework.shell.standard.AbstractShellComponent
 
getShortLogMessage() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
Return a short representation of this handler method for log message purposes.
getShortNames() - Method in class org.springframework.shell.boot.SpringShellProperties.Help
 
getShortNames() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption
 
getShortNames() - Method in interface org.springframework.shell.command.CommandOption
Gets a short names of an option.
getShortNames() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
getShortNames() - Method in class org.springframework.shell.command.CommandRegistration.HelpOptionInfo.DefaultHelpOptionInfo
 
getShortNames() - Method in interface org.springframework.shell.command.CommandRegistration.HelpOptionInfo
Gets short names options for help.
getStacktrace() - Method in class org.springframework.shell.boot.SpringShellProperties.Command
 
getStart() - Method in class org.springframework.shell.support.search.SearchMatchResult.DefaultResult
 
getStart() - Method in interface org.springframework.shell.support.search.SearchMatchResult
Get start of a match.
getStart() - Method in class org.springframework.shell.test.jediterm.terminal.model.CharBuffer
 
getStartOffset() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLineIntervalHighlighting
 
getStyle() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine.TextEntry
 
getStyleAt(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine
 
getStyleAt(int, int) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
getStyledCharAt(int, int) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
getStyleLines() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
getStyleState() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
getStyleState() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
getTarget() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration
 
getTarget() - Method in interface org.springframework.shell.command.CommandRegistration
Gets target info.
getTargetType() - Method in class org.springframework.shell.command.CommandRegistration.TargetInfo.DefaultTargetInfo
 
getTargetType() - Method in interface org.springframework.shell.command.CommandRegistration.TargetInfo
Get target type
getTemplate() - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
getTemplateExecutor() - Method in class org.springframework.shell.component.support.AbstractComponent
Gets a template executor.
getTemplateExecutor() - Method in class org.springframework.shell.standard.AbstractShellComponent
 
getTemplateLocation() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
getTemplateLocation() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
getTemplateLocation() - Method in class org.springframework.shell.component.flow.BasePathInput
 
getTemplateLocation() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
getTemplateLocation() - Method in class org.springframework.shell.component.flow.BaseStringInput
 
getTerminal() - Method in class org.springframework.shell.command.CommandContext.DefaultCommandContext
 
getTerminal() - Method in interface org.springframework.shell.command.CommandContext
Gets a terminal.
getTerminal() - Method in class org.springframework.shell.component.support.AbstractComponent
Gets a Terminal.
getTerminal() - Method in class org.springframework.shell.standard.AbstractShellComponent
 
getTerminal() - Method in class org.springframework.shell.test.jediterm.terminal.ui.JediTermWidget
 
getTerminal() - Method in interface org.springframework.shell.test.jediterm.terminal.ui.TerminalSession
 
getTerminalDisplay() - Method in class org.springframework.shell.test.jediterm.terminal.ui.JediTermWidget
 
getTerminalDisplay() - Method in interface org.springframework.shell.test.jediterm.terminal.ui.TerminalWidget
 
getTerminalHeight() - Method in class org.springframework.shell.test.autoconfigure.SpringShellTestProperties
 
getTerminalHeight() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
getTerminalHeight() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
getTerminalOutputStream() - Method in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
getTerminalPanel() - Method in class org.springframework.shell.test.jediterm.terminal.ui.JediTermWidget
 
getTerminalPanelListener() - Method in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
getTerminalStarter() - Method in class org.springframework.shell.test.jediterm.terminal.ui.JediTermWidget
 
getTerminalStarter() - Method in interface org.springframework.shell.test.jediterm.terminal.ui.TerminalSession
 
getTerminalTextBuffer() - Method in class org.springframework.shell.test.jediterm.terminal.ui.JediTermWidget
 
getTerminalTextBuffer() - Method in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
getTerminalTextBuffer() - Method in interface org.springframework.shell.test.jediterm.terminal.ui.TerminalSession
 
getTerminalWidth() - Method in class org.springframework.shell.component.context.BaseComponentContext
 
getTerminalWidth() - Method in interface org.springframework.shell.component.context.ComponentContext
Get terminal width.
getTerminalWidth() - Method in class org.springframework.shell.test.autoconfigure.SpringShellTestProperties
 
getTerminalWidth() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
getTerminalWidth() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
getText() - Method in exception org.springframework.shell.CommandNotFound
Gets a raw text input.
getText() - Method in class org.springframework.shell.style.PartsText.PartText
 
getText() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine
 
getText() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine.TextEntry
 
getTextLengthDoubleWidthAware(char[], int, int, boolean) - Static method in class org.springframework.shell.test.jediterm.terminal.util.CharUtils
Computes text length as sum of characters length, treating double-width(full-width) characters as 2, normal-width(half-width) as 1 (Read http://en.wikipedia.org/wiki/Halfwidth_and_fullwidth_forms)
getTextStyle() - Method in class org.springframework.shell.test.jediterm.terminal.model.StoredCursor
 
getTheme() - Method in class org.springframework.shell.boot.SpringShellProperties
 
getThemeResolver() - Method in class org.springframework.shell.standard.AbstractShellComponent
 
getThis() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
getThis() - Method in interface org.springframework.shell.component.flow.BaseInputSpec
Usual this trick to get typed child.
getThis() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
getThis() - Method in class org.springframework.shell.component.flow.BasePathInput
 
getThis() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
getThis() - Method in class org.springframework.shell.component.flow.BaseStringInput
 
getThisContext(ComponentContext<?>) - Method in class org.springframework.shell.component.ConfirmationInput
 
getThisContext(ComponentContext<?>) - Method in class org.springframework.shell.component.MultiItemSelector
 
getThisContext(ComponentContext<?>) - Method in class org.springframework.shell.component.PathInput
 
getThisContext(ComponentContext<?>) - Method in class org.springframework.shell.component.PathSearch
 
getThisContext(ComponentContext<?>) - Method in class org.springframework.shell.component.SingleItemSelector
 
getThisContext(ComponentContext<?>) - Method in class org.springframework.shell.component.StringInput
 
getThisContext(ComponentContext<?>) - Method in class org.springframework.shell.component.support.AbstractComponent
Gets a real component context using common this trick.
getToken() - Method in class org.springframework.shell.command.parser.AstNode
 
getTtyConnector() - Method in class org.springframework.shell.test.jediterm.terminal.ui.JediTermWidget
 
getTtyConnector() - Method in interface org.springframework.shell.test.jediterm.terminal.ui.TerminalSession
 
getType() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption
 
getType() - Method in interface org.springframework.shell.command.CommandOption
Gets a ResolvableType of an option.
getType() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
getType() - Method in enum class org.springframework.shell.command.parser.ParserMessage
 
getType() - Method in class org.springframework.shell.command.parser.Token
 
getTypeAheadStyle() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTypeAheadSettings
 
getValue() - Method in class org.springframework.shell.command.parser.DirectiveNode
 
getValue() - Method in class org.springframework.shell.command.parser.OptionArgumentNode
 
getValue() - Method in class org.springframework.shell.command.parser.Token
 
getValue() - Method in interface org.springframework.shell.component.SingleItemSelector.SingleItemSelectorContext
Gets a value.
getValue(int, int) - Method in class org.springframework.shell.table.ArrayTableModel
 
getValue(int, int) - Method in class org.springframework.shell.table.BeanListTableModel
 
getValue(int, int) - Method in class org.springframework.shell.table.TableModel
 
getValues() - Method in interface org.springframework.shell.component.MultiItemSelector.MultiItemSelectorContext
Gets a values.
getVersion() - Method in class org.springframework.shell.boot.SpringShellProperties.Command
 
getWidth() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
getWindowTitle() - Method in interface org.springframework.shell.test.jediterm.terminal.TerminalDisplay
 
getWindowTitle() - Method in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
getWordIndex() - Method in class org.springframework.shell.CompletionContext
 
getWords() - Method in exception org.springframework.shell.CommandNotFound
Gets a words in this exception.
getWords() - Method in class org.springframework.shell.CompletionContext
 
getX() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
getX() - Method in interface org.springframework.shell.test.jediterm.terminal.ui.TerminalCoordinates
 
getY() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
getY() - Method in interface org.springframework.shell.test.jediterm.terminal.ui.TerminalCoordinates
 
GraphicSet - Class in org.springframework.shell.test.jediterm.terminal.emulator.charset
Denotes how a graphic set is designated.
GraphicSet(int) - Constructor for class org.springframework.shell.test.jediterm.terminal.emulator.charset.GraphicSet
 
GraphicSetState - Class in org.springframework.shell.test.jediterm.terminal.emulator.charset
 
GraphicSetState() - Constructor for class org.springframework.shell.test.jediterm.terminal.emulator.charset.GraphicSetState
 
group() - Element in annotation interface org.springframework.shell.command.annotation.Command
Define a command group.
group() - Element in annotation interface org.springframework.shell.standard.ShellMethod
The command group which this command belongs to.
group(String) - Method in interface org.springframework.shell.command.CommandRegistration.AliasSpec
Define group for an alias.
group(String) - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder
 
group(String) - Method in interface org.springframework.shell.command.CommandRegistration.Builder
Define a group for a command.
group(String) - Method in class org.springframework.shell.command.CommandRegistration.DefaultAliasSpec
 
GROUP - Enum constant in enum class org.springframework.shell.boot.SpringShellProperties.HelpCommand.GroupingMode
 

H

handle(Object) - Method in class org.springframework.shell.result.GenericResultHandlerService
 
handle(Object) - Method in interface org.springframework.shell.ResultHandlerService
Handle result.
handle(Object, TypeDescriptor) - Method in interface org.springframework.shell.result.GenericResultHandler
 
handle(Object, TypeDescriptor) - Method in class org.springframework.shell.result.GenericResultHandlerService
 
handle(Object, TypeDescriptor) - Method in interface org.springframework.shell.ResultHandlerService
Handle result to the specified TypeDescriptor.
handleMissingValue(List<String>, MethodParameter, Message<?>) - Method in class org.springframework.shell.command.annotation.support.OptionMethodArgumentResolver
 
handleMissingValue(List<String>, MethodParameter, Message<?>) - Method in class org.springframework.shell.command.ArgumentHeaderMethodArgumentResolver
 
handleMissingValue(List<String>, MethodParameter, Message<?>) - Method in class org.springframework.shell.standard.ShellOptionMethodArgumentResolver
 
handleMissingValue(List<String>, MethodParameter, Message<?>) - Method in class org.springframework.shell.support.AbstractArgumentMethodArgumentResolver
handleResolvedValue(Object, List<String>, MethodParameter, Message<?>) - Method in class org.springframework.shell.support.AbstractArgumentMethodArgumentResolver
Invoked after a value is resolved.
handleResult(T) - Method in class org.springframework.shell.result.TerminalAwareResultHandler
 
handleResult(T) - Method in interface org.springframework.shell.ResultHandler
Deal with some method execution result, whether it was the normal return value, or some kind of Throwable.
HandlerMethodParameter(int) - Constructor for class org.springframework.shell.command.invocation.InvocableShellMethod.HandlerMethodParameter
 
HandlerMethodParameter(InvocableShellMethod.HandlerMethodParameter) - Constructor for class org.springframework.shell.command.invocation.InvocableShellMethod.HandlerMethodParameter
 
hasExceptionMappings() - Method in class org.springframework.shell.command.annotation.ExceptionResolverMethodResolver
Whether the contained type has any exception mappings.
hasFilter() - Method in class org.springframework.shell.component.PathSearch.PathScannerResult
 
hashCode() - Method in class org.springframework.shell.Command.Help
 
hashCode() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
 
hashCode() - Method in record class org.springframework.shell.command.parser.Ast.AstResult
Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.shell.command.parser.DirectiveResult
Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.shell.command.parser.Lexer.LexerResult
Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.shell.command.parser.MessageResult
Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.shell.command.parser.Parser.ParseResult.ArgumentResult
Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.shell.command.parser.Parser.ParseResult
Returns a hash code value for this object.
hashCode() - Method in record class org.springframework.shell.command.parser.Parser.ParseResult.OptionResult
Returns a hash code value for this object.
hashCode() - Method in class org.springframework.shell.test.jediterm.terminal.TextStyle
 
hashCode() - Method in class org.springframework.shell.test.jediterm.terminal.util.Pair
 
hashCode() - Method in record class org.springframework.shell.test.ShellTestClient.ShellRunnerTaskData
Returns a hash code value for this object.
hasMappedOption(String) - Method in class org.springframework.shell.command.CommandContext.DefaultCommandContext
 
hasMappedOption(String) - Method in interface org.springframework.shell.command.CommandContext
Gets if option has been mapped.
hasMaskCharacter() - Method in interface org.springframework.shell.component.StringInput.StringInputContext
Returns flag if there is a mask character defined.
hasMethodAnnotation(Class<A>) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
Return whether the parameter is declared with the given annotation type.
hasMethodAnnotation(Class<T>) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod.HandlerMethodParameter
 
hasNext() - Method in class org.springframework.shell.test.jediterm.terminal.DataStreamIteratingEmulator
 
hasNext() - Method in interface org.springframework.shell.test.jediterm.terminal.emulator.Emulator
 
hasOption(TextStyle.Option) - Method in class org.springframework.shell.test.jediterm.terminal.TextStyle
 
hasTty() - Method in class org.springframework.shell.component.support.AbstractComponent
Checks if this component has an existing tty.
hasValue(Object) - Method in class org.springframework.shell.ValueResultAsserts
 
HEADER_COMMAND_CONTEXT - Static variable in class org.springframework.shell.command.CommandContextMethodArgumentResolver
 
heavyDecCompatibleBuffer(CharBuffer) - Static method in class org.springframework.shell.test.jediterm.terminal.util.CharUtils
 
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(SpringShellProperties, ObjectProvider<TemplateExecutor>) - Method in class org.springframework.shell.boot.StandardCommandsAutoConfiguration
 
Help - Class in org.springframework.shell.standard.commands
A command to display help about all available commands.
Help() - Constructor for class org.springframework.shell.boot.SpringShellProperties.Help
 
Help(String) - Constructor for class org.springframework.shell.Command.Help
 
Help(String, String) - Constructor for class org.springframework.shell.Command.Help
 
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.
HelpCommand() - Constructor for class org.springframework.shell.boot.SpringShellProperties.HelpCommand
 
helpOptionsCommandRegistrationCustomizer(SpringShellProperties) - Method in class org.springframework.shell.boot.CommandCatalogAutoConfiguration
 
hidden() - Element in annotation interface org.springframework.shell.command.annotation.Command
Define command to be hidden.
hidden() - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder
 
hidden() - Method in interface org.springframework.shell.command.CommandRegistration.Builder
Define a command to be hidden.
hidden(boolean) - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder
 
hidden(boolean) - Method in interface org.springframework.shell.command.CommandRegistration.Builder
Define a command to be hidden by a given flag.
HIDDEN - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TextStyle.Option
 
HIDDEN - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel.TerminalCursorState
 
highlight() - Method in class org.springframework.shell.style.StyleSettings
 
history() - Method in class org.springframework.shell.boot.JLineAutoConfiguration.JLineHistoryConfiguration
 
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() - Constructor for class org.springframework.shell.boot.SpringShellProperties.History
 
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.
historyCommand(History) - Method in class org.springframework.shell.boot.StandardCommandsAutoConfiguration
 
HistoryCommand() - Constructor for class org.springframework.shell.boot.SpringShellProperties.HistoryCommand
 
horizontalGlyph() - Method in enum class org.springframework.shell.table.BorderStyle
 
horizontalTab() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
horizontalTab() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
HT - Static variable in class org.springframework.shell.test.jediterm.typeahead.Ascii
Horizontal Tabulation ('\t'): A format effector which controls the movement of the printing position to the next in a series of predetermined positions along the printing line.

I

IGNORE_DIRECTIVES - Enum constant in enum class org.springframework.shell.command.parser.ParserConfig.Feature
Used in a case where directive support is disabled and parser should ignore ones found instead of reporting error, disabled on default.
ILLEGAL_CONTENT_BEFORE_COMMANDS - Enum constant in enum class org.springframework.shell.command.parser.ParserMessage
 
ILLEGAL_OPTION_VALUE - Enum constant in enum class org.springframework.shell.command.parser.ParserMessage
 
includeFilters() - Element in annotation interface org.springframework.shell.test.autoconfigure.ShellTest
A set of include filters which can be used to add otherwise filtered beans to the application context.
index() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
index() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
indexOfIgnoreCase(String, String, int) - Static method in class org.springframework.shell.test.jediterm.terminal.util.Util
Implementation copied from String.indexOf(String, int) except character comparisons made case insensitive
info() - Method in class org.springframework.shell.style.FigureSettings
 
INFO - Enum constant in enum class org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext.MessageLevel
 
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.
init() - Method in interface org.springframework.shell.test.jediterm.terminal.TtyConnector
 
INNER - Static variable in class org.springframework.shell.table.BorderSpecification
 
INNER_HORIZONTAL - Static variable in class org.springframework.shell.table.BorderSpecification
 
INNER_VERTICAL - Static variable in class org.springframework.shell.table.BorderSpecification
 
Input - Interface in org.springframework.shell
Represents the input buffer to the shell.
InputProvider - Interface in org.springframework.shell
To be implemented by components able to provide a "line" of user input, whether interactively or by batch.
insertBlankCharacters(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
insertBlankCharacters(int) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
insertBlankCharacters(int, int, int) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
insertBlankCharacters(int, int, int, int, TextStyle) - Method in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
insertBlankCharacters(int, int, int, TextStyle) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine
 
insertLines(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
insertLines(int) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
insertLines(int, int, int) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
insertLines(int, int, int, TerminalLine.TextEntry) - Method in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
InsertMode - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
inserts() - Method in record class org.springframework.shell.command.parser.MessageResult
Returns the value of the inserts record component.
insertString(int, CharBuffer, TextStyle) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine
 
interactionMode() - Element in annotation interface org.springframework.shell.command.annotation.Command
Define interaction mode for a command as a hint when command should be available.
interactionMode() - Element in annotation interface org.springframework.shell.standard.ShellMethod
Defines interaction mode for a command as a hint when command should be available.
interactionMode(InteractionMode) - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder
 
interactionMode(InteractionMode) - Method in interface org.springframework.shell.command.CommandRegistration.Builder
Define InteractionMode for a command.
InteractionMode - Enum Class in org.springframework.shell.context
Enumeration for modes shell is operating.
interactive() - Method in class org.springframework.shell.test.ShellTestClient.DefaultShellClient
 
interactive() - Method in interface org.springframework.shell.test.ShellTestClient
Run interactive shell session.
Interactive() - Constructor for class org.springframework.shell.boot.SpringShellProperties.Interactive
 
INTERACTIVE - Enum constant in enum class org.springframework.shell.context.InteractionMode
Interactive mode which is expected to not exit and do have a running mode to keep shell alive.
interactiveApplicationRunner() - Method in class org.springframework.shell.boot.ShellRunnerAutoConfiguration
 
InteractiveShellRunner - Class in org.springframework.shell.jline
A ShellRunner that bootstraps the shell in interactive mode.
InteractiveShellRunner(LineReader, PromptProvider, Shell, ShellContext) - Constructor for class org.springframework.shell.jline.InteractiveShellRunner
 
InteractiveShellRunner.JLineInputProvider - Class in org.springframework.shell.jline
 
Interlace - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
intersection(char, char, char, char) - Static method in enum class org.springframework.shell.table.BorderStyle
 
intersectsWith(int, int) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLineIntervalHighlighting
 
INVERSE - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TextStyle.Option
 
InvocableShellMethod - Class in org.springframework.shell.command.invocation
Encapsulates information about a handler method consisting of a method and a bean.
InvocableShellMethod(Object, Method) - Constructor for class org.springframework.shell.command.invocation.InvocableShellMethod
Create an instance from a bean instance and a method.
InvocableShellMethod(Object, String, Class<?>...) - Constructor for class org.springframework.shell.command.invocation.InvocableShellMethod
Create an instance from a bean instance, method name, and parameter types.
InvocableShellMethod(String, BeanFactory, Method) - Constructor for class org.springframework.shell.command.invocation.InvocableShellMethod
Create an instance from a bean name, a method, and a BeanFactory.
InvocableShellMethod(InvocableShellMethod) - Constructor for class org.springframework.shell.command.invocation.InvocableShellMethod
Copy constructor for use in subclasses.
InvocableShellMethod.HandlerMethodParameter - Class in org.springframework.shell.command.invocation
A MethodParameter with HandlerMethod-specific behavior.
invoke(Message<?>, Object...) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
Invoke the method after resolving its argument values in the context of the given message.
isAutoWrap() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
isAutoWrap() - Method in class org.springframework.shell.test.jediterm.terminal.model.StoredCursor
 
isAvailable() - Method in class org.springframework.shell.Availability
 
isComplete() - Method in interface org.springframework.shell.test.ShellTestClient.BaseShellSession
 
isComplete() - Method in class org.springframework.shell.test.ShellTestClient.DefaultInteractiveShellSession
 
isComplete() - Method in class org.springframework.shell.test.ShellTestClient.DefaultNonInteractiveShellSession
 
isConnected() - Method in interface org.springframework.shell.test.jediterm.terminal.TtyConnector
 
isDecBoxChar(char) - Static method in class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSets
 
isDelimiter(CharSequence, int) - Method in class org.springframework.shell.jline.ExtendedDefaultParser
Returns true if the specified character is a whitespace parameter.
isDelimiterChar(CharSequence, int) - Method in class org.springframework.shell.jline.ExtendedDefaultParser
Returns true if the character at the specified position if a delimiter.
isDisposed() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLineIntervalHighlighting
 
isDoubleWidthCharacter(int, boolean) - Static method in class org.springframework.shell.test.jediterm.terminal.util.CharUtils
 
isEmpty() - Method in class org.springframework.shell.command.CommandHandlingResult.DefaultHandlingResult
 
isEmpty() - Method in interface org.springframework.shell.command.CommandHandlingResult
Indicate whether this CommandHandlingResult does not have a result.
isEmpty() - Method in class org.springframework.shell.test.jediterm.terminal.ArrayTerminalDataStream
 
isEmpty() - Method in interface org.springframework.shell.test.jediterm.terminal.TerminalDataStream
 
isEnabled() - Method in class org.springframework.shell.boot.SpringShellProperties.ClearCommand
 
isEnabled() - Method in class org.springframework.shell.boot.SpringShellProperties.CompletionCommand
 
isEnabled() - Method in class org.springframework.shell.boot.SpringShellProperties.Help
 
isEnabled() - Method in class org.springframework.shell.boot.SpringShellProperties.HelpCommand
 
isEnabled() - Method in class org.springframework.shell.boot.SpringShellProperties.History
 
isEnabled() - Method in class org.springframework.shell.boot.SpringShellProperties.HistoryCommand
 
isEnabled() - Method in class org.springframework.shell.boot.SpringShellProperties.Interactive
 
isEnabled() - Method in class org.springframework.shell.boot.SpringShellProperties.Noninteractive
 
isEnabled() - Method in class org.springframework.shell.boot.SpringShellProperties.QuitCommand
 
isEnabled() - Method in class org.springframework.shell.boot.SpringShellProperties.Script
 
isEnabled() - Method in class org.springframework.shell.boot.SpringShellProperties.ScriptCommand
 
isEnabled() - Method in class org.springframework.shell.boot.SpringShellProperties.StacktraceCommand
 
isEnabled() - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
isEnabled() - Method in class org.springframework.shell.command.CommandRegistration.HelpOptionInfo.DefaultHelpOptionInfo
 
isEnabled() - Method in interface org.springframework.shell.command.CommandRegistration.HelpOptionInfo
Gets whether help options are enabled.
isEnabled() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.ItemState
 
isEnabled() - Method in interface org.springframework.shell.component.support.Enableable
 
isEnabled() - Method in class org.springframework.shell.component.support.SelectorItem.SelectorItemWrapper
 
isEnabled() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTypeAheadSettings
 
isEofOnEscapedNewLine() - Method in class org.springframework.shell.jline.ExtendedDefaultParser
 
isEofOnUnclosedQuote() - Method in class org.springframework.shell.jline.ExtendedDefaultParser
 
isEscapeChar(CharSequence, int) - Method in class org.springframework.shell.jline.ExtendedDefaultParser
Check if this character is a valid escape char (i.e.
isEscaped(CharSequence, int) - Method in class org.springframework.shell.jline.ExtendedDefaultParser
Check if a character is escaped (i.e.
isHidden() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration
 
isHidden() - Method in interface org.springframework.shell.command.CommandRegistration
Returns if command is hidden.
isLinux - Static variable in class org.springframework.shell.test.jediterm.terminal.ui.UIUtil
 
isMac - Static variable in class org.springframework.shell.test.jediterm.terminal.ui.UIUtil
 
isMatch() - Method in class org.springframework.shell.style.PartsText.PartText
 
isNul() - Method in class org.springframework.shell.test.jediterm.terminal.model.CharBuffer
 
isNul() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine
 
isNul() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine.TextEntry
 
isOriginMode() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
isOriginMode() - Method in class org.springframework.shell.test.jediterm.terminal.model.StoredCursor
 
isOS2 - Static variable in class org.springframework.shell.test.jediterm.terminal.ui.UIUtil
 
isPresent() - Method in class org.springframework.shell.command.CommandHandlingResult.DefaultHandlingResult
 
isPresent() - Method in interface org.springframework.shell.command.CommandHandlingResult
Indicate whether this CommandHandlingResult has a result.
isQuoteChar(CharSequence, int) - Method in class org.springframework.shell.jline.ExtendedDefaultParser
 
isQuoted(CharSequence, int) - Method in class org.springframework.shell.jline.ExtendedDefaultParser
 
isRequired() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption
 
isRequired() - Method in interface org.springframework.shell.command.CommandOption
Gets a flag if option is required.
isRequired() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
isResult() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext
 
isResult() - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext
Return if there is a result.
isSearchCaseSensitive() - Method in class org.springframework.shell.component.PathSearch.PathSearchConfig
 
isSearchForward() - Method in class org.springframework.shell.component.PathSearch.PathSearchConfig
 
isSearchNormalize() - Method in class org.springframework.shell.component.PathSearch.PathSearchConfig
 
isSelected() - Method in class org.springframework.shell.component.PathSearch.PathSearchContext.PathViewItem
 
isSelected() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.ItemState
 
isSelected() - Method in interface org.springframework.shell.component.support.Selectable
 
isSelected() - Method in class org.springframework.shell.component.support.SelectorItem.SelectorItemWrapper
 
isSelected() - Method in class org.springframework.shell.component.support.SelectorList.BaseProjectionItem
 
isSessionRunning() - Method in class org.springframework.shell.test.jediterm.terminal.ui.JediTermWidget
 
isShowBuildArtifact() - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
isShowBuildGroup() - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
isShowBuildName() - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
isShowBuildTime() - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
isShowBuildVersion() - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
isShowGitBranch() - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
isShowGitCommitId() - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
isShowGitCommitTime() - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
isShowGitShortCommitId() - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
isStoreResult() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
isStoreResult() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
isStoreResult() - Method in class org.springframework.shell.component.flow.BasePathInput
 
isStoreResult() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
isStoreResult() - Method in class org.springframework.shell.component.flow.BaseStringInput
 
isUnix - Static variable in class org.springframework.shell.test.jediterm.terminal.ui.UIUtil
 
isUsingAlternateBuffer() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
isVoid() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
Return true if the method return type is void, false otherwise.
isWindows - Static variable in class org.springframework.shell.test.jediterm.terminal.ui.UIUtil
 
isWrapped() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine
 
ITALIAN - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSet
 
ITALIC - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TextStyle.Option
 
item() - Method in class org.springframework.shell.component.flow.DefaultSelectItem
 
item() - Method in interface org.springframework.shell.component.flow.SelectItem
Gets an item
Itemable<T> - Interface in org.springframework.shell.component.support
 
itemDisabled() - Method in class org.springframework.shell.style.StyleSettings
 
itemEnabled() - Method in class org.springframework.shell.style.StyleSettings
 
itemSelected() - Method in class org.springframework.shell.style.StyleSettings
 
itemSelector() - Method in class org.springframework.shell.style.StyleSettings
 
itemUnselected() - Method in class org.springframework.shell.style.StyleSettings
 
iterator() - Method in class org.springframework.shell.test.jediterm.terminal.model.CharBuffer
 

J

JAVA_RUNTIME_VERSION - Static variable in class org.springframework.shell.test.jediterm.terminal.ui.UIUtil
 
JediEmulator - Class in org.springframework.shell.test.jediterm.terminal.emulator
The main terminal emulator class.
JediEmulator(TerminalDataStream, Terminal) - Constructor for class org.springframework.shell.test.jediterm.terminal.emulator.JediEmulator
 
JediTerminal - Class in org.springframework.shell.test.jediterm.terminal.model
Terminal that reflects obtained commands and text at TerminalDisplay(handles change of cursor position, screen size etc) and TerminalTextBuffer(stores printed text)
JediTerminal(TerminalDisplay, TerminalTextBuffer, StyleState) - Constructor for class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
JediTerminal.ResizeHandler - Interface in org.springframework.shell.test.jediterm.terminal.model
 
JediTermWidget - Class in org.springframework.shell.test.jediterm.terminal.ui
 
JediTermWidget() - Constructor for class org.springframework.shell.test.jediterm.terminal.ui.JediTermWidget
 
JediTermWidget(int, int) - Constructor for class org.springframework.shell.test.jediterm.terminal.ui.JediTermWidget
 
JLineAutoConfiguration - Class in org.springframework.shell.boot
 
JLineAutoConfiguration() - Constructor for class org.springframework.shell.boot.JLineAutoConfiguration
 
JLineAutoConfiguration.JLineHistoryConfiguration - Class in org.springframework.shell.boot
 
JLineHistoryConfiguration() - Constructor for class org.springframework.shell.boot.JLineAutoConfiguration.JLineHistoryConfiguration
 
JLineInputProvider(LineReader, PromptProvider) - Constructor for class org.springframework.shell.jline.InteractiveShellRunner.JLineInputProvider
 
JLineShellAutoConfiguration - Class in org.springframework.shell.boot
Shell implementation using JLine to capture input and trigger completions.
JLineShellAutoConfiguration() - Constructor for class org.springframework.shell.boot.JLineShellAutoConfiguration
 
JnaRuntimeHints - Class in org.springframework.shell
 
JnaRuntimeHints() - Constructor for class org.springframework.shell.JnaRuntimeHints
 

K

KEBAB - Enum constant in enum class org.springframework.shell.boot.SpringShellProperties.OptionNamingCase
 
KEBABCASE - Static variable in class org.springframework.shell.command.support.OptionNameModifierSupport
 
key() - Element in annotation interface org.springframework.shell.standard.ShellMethod
The name(s) by which this method can be invoked via Spring Shell.
KeyboardAction - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
keyDown() - Method in class org.springframework.shell.test.ShellWriteSequence.DefaultShellWriteSequence
 
keyDown() - Method in interface org.springframework.shell.test.ShellWriteSequence
Sequence terminal key down.
keyLeft() - Method in class org.springframework.shell.test.ShellWriteSequence.DefaultShellWriteSequence
 
keyLeft() - Method in interface org.springframework.shell.test.ShellWriteSequence
Sequence terminal key left.
Keypad - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
keyRight() - Method in class org.springframework.shell.test.ShellWriteSequence.DefaultShellWriteSequence
 
keyRight() - Method in interface org.springframework.shell.test.ShellWriteSequence
Sequence terminal key right.
keyUp() - Method in class org.springframework.shell.test.ShellWriteSequence.DefaultShellWriteSequence
 
keyUp() - Method in interface org.springframework.shell.test.ShellWriteSequence
Sequence terminal key up.
KeyValueHorizontalAligner - Class in org.springframework.shell.table
A text alignment strategy that aligns text horizontally so that all instances of some special character(s) line up perfectly in a column.
KeyValueHorizontalAligner(String) - Constructor for class org.springframework.shell.table.KeyValueHorizontalAligner
 
KeyValueSizeConstraints - Class in org.springframework.shell.table
A SizeConstraints implementation that is tailored to rendering a series of key = value pairs.
KeyValueSizeConstraints(String) - Constructor for class org.springframework.shell.table.KeyValueSizeConstraints
 
KeyValueTextWrapper - Class in org.springframework.shell.table
A TextWrapper implementation tailored for key-value rendering (working in concert with KeyValueSizeConstraints, KeyValueHorizontalAligner), that tries its best to vertically align some delimiter character (default '=').
KeyValueTextWrapper() - Constructor for class org.springframework.shell.table.KeyValueTextWrapper
 
KeyValueTextWrapper(String) - Constructor for class org.springframework.shell.table.KeyValueTextWrapper
 

L

label() - Element in annotation interface org.springframework.shell.command.annotation.Option
Return a label of the option.
label(String) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
label(String) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec
Define a label for an option.
left - Enum constant in enum class org.springframework.shell.table.SimpleHorizontalAligner
 
LEFT - Static variable in class org.springframework.shell.table.BorderSpecification
 
leftPointingQuotation() - Method in class org.springframework.shell.style.FigureSettings
 
leftwardsArrow() - Method in class org.springframework.shell.style.FigureSettings
 
length - Variable in class org.springframework.shell.test.jediterm.terminal.ArrayTerminalDataStream
 
length() - Method in class org.springframework.shell.test.jediterm.terminal.model.CharBuffer
 
Lexer - Interface in org.springframework.shell.command.parser
Interface to tokenize arguments into tokens.
Lexer.DefaultLexer - Class in org.springframework.shell.command.parser
Default implementation of a Lexer.
Lexer.LexerResult - Record Class in org.springframework.shell.command.parser
Representing result from Lexer tokenisation.
LexerResult(List<Token>, List<MessageResult>) - Constructor for record class org.springframework.shell.command.parser.Lexer.LexerResult
Creates an instance of a LexerResult record class.
LF - Static variable in class org.springframework.shell.test.jediterm.typeahead.Ascii
Line Feed ('\n'): A format effector which controls the movement of the printing position to the next printing line.
line() - Method in class org.springframework.shell.jline.ExtendedDefaultParser.ExtendedArgumentList
 
linePositionAbsolute(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
linePositionAbsolute(int) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
lineReader() - Method in class org.springframework.shell.boot.LineReaderAutoConfiguration
 
LineReaderAutoConfiguration - Class in org.springframework.shell.boot
 
LineReaderAutoConfiguration(Terminal, Completer, Parser, CommandCatalog, History, SpringShellProperties, UserConfigPathProvider) - Constructor for class org.springframework.shell.boot.LineReaderAutoConfiguration
 
lines() - Method in class org.springframework.shell.test.ShellScreen.DefaultShellScreen
 
lines() - Method in interface org.springframework.shell.test.ShellScreen
Gets a visible lines in a screen.
LinesBuffer - Class in org.springframework.shell.test.jediterm.terminal.model
Holds styled characters lines
LinesBuffer() - Constructor for class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
LinesBuffer(int) - Constructor for class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
listKey() - Method in class org.springframework.shell.style.StyleSettings
 
listLevelError() - Method in class org.springframework.shell.style.StyleSettings
 
listLevelInfo() - Method in class org.springframework.shell.style.StyleSettings
 
listLevelWarn() - Method in class org.springframework.shell.style.StyleSettings
 
listValue() - Method in class org.springframework.shell.style.StyleSettings
 
lock() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
log - Static variable in class org.springframework.shell.command.invocation.InvocableShellMethod
Public for wrapping with fallback logger.
longNames() - Element in annotation interface org.springframework.shell.command.annotation.Option
Long names of an option.
longNames(String...) - Method in class org.springframework.shell.command.CommandRegistration.DefaultHelpOptionsSpec
 
longNames(String...) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
longNames(String...) - Method in interface org.springframework.shell.command.CommandRegistration.HelpOptionsSpec
Sets long names options for help.
longNames(String...) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec
Define long option names.
loop(ComponentContext<?>) - Method in class org.springframework.shell.component.support.AbstractComponent
Enter into read loop.

M

makeCode(int...) - Static method in class org.springframework.shell.test.jediterm.terminal.util.CharUtils
 
MANDATORY_OPTION_MISSING - Enum constant in enum class org.springframework.shell.command.parser.ParserMessage
 
map(char) - Method in class org.springframework.shell.test.jediterm.terminal.emulator.charset.GraphicSetState
Returns the mapping for the given character.
map(char, int) - Method in class org.springframework.shell.test.jediterm.terminal.emulator.charset.GraphicSet
Maps a given character index to a concrete character.
map(int) - Method in enum class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSet
Maps the character with the given index to a character in this character set.
map(Class<? extends Throwable>, int) - Method in class org.springframework.shell.command.CommandRegistration.DefaultExitCodeSpec
 
map(Class<? extends Throwable>, int) - Method in interface org.springframework.shell.command.CommandRegistration.ExitCodeSpec
Define mapping from exception to code.
map(Function<Throwable, Integer>) - Method in class org.springframework.shell.command.CommandRegistration.DefaultExitCodeSpec
 
map(Function<Throwable, Integer>) - Method in interface org.springframework.shell.command.CommandRegistration.ExitCodeSpec
 
mapCharsetToGL(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
mapCharsetToGL(int) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
mapCharsetToGR(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
mapCharsetToGR(int) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
MapFormatter - Class in org.springframework.shell.table
A formatter suited for key-value pairs, that renders each mapping on a new line.
MapFormatter(String) - Constructor for class org.springframework.shell.table.MapFormatter
 
maskCharacter(Character) - Method in class org.springframework.shell.component.flow.BaseStringInput
 
maskCharacter(Character) - Method in interface org.springframework.shell.component.flow.StringInputSpec
Sets a mask character.
match(boolean, boolean, boolean, String, String) - Method in interface org.springframework.shell.support.search.SearchMatchAlgorithm
Match given text with pattern as a result.
match(String, String) - Method in class org.springframework.shell.support.search.SearchMatch.DefaultSearchMatch
 
match(String, String) - Method in interface org.springframework.shell.support.search.SearchMatch
Match a pattern into a given text.
Matchable - Interface in org.springframework.shell.component.support
 
matches(int, int, TableModel) - Method in interface org.springframework.shell.table.CellMatcher
 
matches(String) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.ItemState
 
matches(String) - Method in interface org.springframework.shell.component.support.Matchable
 
matches(String) - Method in class org.springframework.shell.component.support.SelectorItem.SelectorItemWrapper
 
matches(TypeDescriptor) - Method in interface org.springframework.shell.result.GenericResultHandler
 
max - Variable in class org.springframework.shell.table.SizeConstraints.Extent
 
max(int) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
max(int) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
max(int) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec
Sets a maximum number of items in a selector list;
max(int) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec
Sets a maximum number of items in a selector list;
mergeWith(TextStyle) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLineIntervalHighlighting
 
message() - Method in class org.springframework.shell.command.CommandHandlingResult.DefaultHandlingResult
 
message() - Method in interface org.springframework.shell.command.CommandHandlingResult
Gets a message for this CommandHandlingResult.
MessageResult - Record Class in org.springframework.shell.command.parser
Encapsulating ParserMessage with position and inserts.
MessageResult(ParserMessage, int, Object[]) - Constructor for record class org.springframework.shell.command.parser.MessageResult
Creates an instance of a MessageResult record class.
messageResults() - Method in record class org.springframework.shell.command.parser.Lexer.LexerResult
Returns the value of the messageResults record component.
messageResults() - Method in record class org.springframework.shell.command.parser.Parser.ParseResult
Returns the value of the messageResults record component.
method(Object, Method) - Method in class org.springframework.shell.command.CommandRegistration.DefaultTargetSpec
 
method(Object, Method) - Method in interface org.springframework.shell.command.CommandRegistration.TargetSpec
Register a method target.
method(Object, String, Class<?>...) - Method in class org.springframework.shell.command.CommandRegistration.DefaultTargetSpec
 
method(Object, String, Class<?>...) - Method in interface org.springframework.shell.command.CommandRegistration.TargetSpec
Register a method target.
METHOD - Enum constant in enum class org.springframework.shell.command.CommandRegistration.TargetInfo.TargetType
 
MethodCommandExceptionResolver - Class in org.springframework.shell.command.annotation
 
MethodCommandExceptionResolver(Object) - Constructor for class org.springframework.shell.command.annotation.MethodCommandExceptionResolver
 
MethodCommandExceptionResolver(Object, Terminal) - Constructor for class org.springframework.shell.command.annotation.MethodCommandExceptionResolver
 
methodParameter() - Method in class org.springframework.shell.ValueResult
The MethodParameter that was the target of the resolve operation.
MethodTargetRegistrar - Interface in org.springframework.shell
Strategy interface for registering commands.
middle - Enum constant in enum class org.springframework.shell.table.SimpleVerticalAligner
 
min - Variable in class org.springframework.shell.table.SizeConstraints.Extent
 
modelChanged() - Method in interface org.springframework.shell.test.jediterm.terminal.model.TerminalModelListener
 
moveBottomLinesTo(int, LinesBuffer) - Method in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
moveTopLinesTo(int, LinesBuffer) - Method in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
MultiItemSelector<T,I extends Nameable & Matchable & Enableable & Selectable & Itemable<T>> - Class in org.springframework.shell.component
Component able to pick multiple items.
MultiItemSelector(Terminal, List<I>, String, Comparator<I>) - Constructor for class org.springframework.shell.component.MultiItemSelector
 
MultiItemSelector.MultiItemSelectorContext<T,I extends Nameable & Matchable & Itemable<T>> - Interface in org.springframework.shell.component
MultiItemSelectorSpec - Interface in org.springframework.shell.component.flow
Interface for multi input spec builder.
myCharSizeHeight - Variable in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
myCharSizeWidth - Variable in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
myClientScrollOrigin - Variable in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
myDataStream - Variable in class org.springframework.shell.test.jediterm.terminal.DataStreamIteratingEmulator
 
myTerminal - Variable in class org.springframework.shell.test.jediterm.terminal.DataStreamIteratingEmulator
 
myTermSizeHeight - Variable in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
myTermSizeWidth - Variable in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 

N

name - Variable in class org.springframework.shell.component.support.AbstractSelectorComponent
 
name() - Method in record class org.springframework.shell.command.parser.DirectiveResult
Returns the value of the name record component.
name() - Method in class org.springframework.shell.component.flow.DefaultSelectItem
 
name() - Method in interface org.springframework.shell.component.flow.SelectItem
Gets a name.
name(String) - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
name(String) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
name(String) - Method in class org.springframework.shell.component.flow.BasePathInput
 
name(String) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
name(String) - Method in class org.springframework.shell.component.flow.BaseStringInput
 
name(String) - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec
Sets a name.
name(String) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec
Sets a name.
name(String) - Method in interface org.springframework.shell.component.flow.PathInputSpec
Sets a name.
name(String) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec
Sets a name.
name(String) - Method in interface org.springframework.shell.component.flow.StringInputSpec
Sets a name.
Nameable - Interface in org.springframework.shell.component.support
 
NamedValueInfo(List<String>, boolean, String) - Constructor for class org.springframework.shell.support.AbstractArgumentMethodArgumentResolver.NamedValueInfo
 
nameModifier(Function<String, String>) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
nameModifier(Function<String, String>) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec
Define an option name modifier.
newLine() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
newLine() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
next() - Method in class org.springframework.shell.test.jediterm.terminal.DataStreamIteratingEmulator
 
next() - Method in interface org.springframework.shell.test.jediterm.terminal.emulator.Emulator
 
next(Function<ConfirmationInput.ConfirmationInputContext, String>) - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
next(Function<ConfirmationInput.ConfirmationInputContext, String>) - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec
Define a function which may return id of a next component to go.
next(Function<MultiItemSelector.MultiItemSelectorContext<String, SelectorItem<String>>, String>) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
next(Function<MultiItemSelector.MultiItemSelectorContext<String, SelectorItem<String>>, String>) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec
Define a function which may return id of a next component to go.
next(Function<PathInput.PathInputContext, String>) - Method in class org.springframework.shell.component.flow.BasePathInput
 
next(Function<PathInput.PathInputContext, String>) - Method in interface org.springframework.shell.component.flow.PathInputSpec
Define a function which may return id of a next component to go.
next(Function<SingleItemSelector.SingleItemSelectorContext<String, SelectorItem<String>>, String>) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
next(Function<SingleItemSelector.SingleItemSelectorContext<String, SelectorItem<String>>, String>) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec
Define a function which may return id of a next component to go.
next(Function<StringInput.StringInputContext, String>) - Method in class org.springframework.shell.component.flow.BaseStringInput
 
next(Function<StringInput.StringInputContext, String>) - Method in interface org.springframework.shell.component.flow.StringInputSpec
Define a function which may return id of a next component to go.
nextLine() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
nextLine() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
nextTab(int) - Method in interface org.springframework.shell.test.jediterm.terminal.model.Tabulator
Returns the next tab stop that is at or after the given position.
NO_FOCUS - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel.TerminalCursorState
 
NO_INPUT - Static variable in class org.springframework.shell.Shell
Marker object returned to signify that there was no input to turn into a command execution.
NodeVisitor - Interface in org.springframework.shell.command.parser
Interface to vising nodes.
NONASCII - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.util.CharUtils.CharacterType
 
NONE - Enum constant in enum class org.springframework.shell.command.CommandRegistration.OptionArity
Used to indicate that arity is not set.
NONE - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.util.CharUtils.CharacterType
 
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).
NONE - Static variable in class org.springframework.shell.table.BorderSpecification
 
NONE - Static variable in enum class org.springframework.shell.table.BorderStyle
 
Noninteractive() - Constructor for class org.springframework.shell.boot.SpringShellProperties.Noninteractive
 
NONINTERACTIVE - Enum constant in enum class org.springframework.shell.context.InteractionMode
Non-interactive mode which is expected to exit and doesn't have any kind of running mode to keep shell alive.
nonInteractiveApplicationRunner(ObjectProvider<NonInteractiveShellRunnerCustomizer>) - Method in class org.springframework.shell.boot.ShellRunnerAutoConfiguration
 
NonInteractiveShellRunner - Class in org.springframework.shell.jline
A ShellRunner that executes commands without entering interactive shell mode.
NonInteractiveShellRunner(Shell, ShellContext) - Constructor for class org.springframework.shell.jline.NonInteractiveShellRunner
 
NonInteractiveShellRunnerCustomizer - Interface in org.springframework.shell.boot
Callback interface that can be implemented by beans wishing to customize the auto-configured NonInteractiveShellRunner.
nonInterative(String...) - Method in class org.springframework.shell.test.ShellTestClient.DefaultShellClient
 
nonInterative(String...) - Method in interface org.springframework.shell.test.ShellTestClient
Run non-interactive command session.
NONPRINTING - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.util.CharUtils.CharacterType
 
NonterminalAstNode - Class in org.springframework.shell.command.parser
Nonterminal node means that it can have children and doesn't necessarily terminal ast tree branch.
NonterminalAstNode(Token) - Constructor for class org.springframework.shell.command.parser.NonterminalAstNode
 
nonterminalNodes() - Method in record class org.springframework.shell.command.parser.Ast.AstResult
Returns the value of the nonterminalNodes record component.
NOOP - Enum constant in enum class org.springframework.shell.boot.SpringShellProperties.OptionNamingCase
 
NOOP - Static variable in class org.springframework.shell.command.support.OptionNameModifierSupport
 
normalize(boolean) - Method in interface org.springframework.shell.support.search.SearchMatch.Builder
Set a flag for normalize.
normalize(boolean) - Method in class org.springframework.shell.support.search.SearchMatch.DefaultBuilder
 
Normalize - Class in org.springframework.shell.support.search
 
Normalize() - Constructor for class org.springframework.shell.support.search.Normalize
 
normalized - Static variable in class org.springframework.shell.support.search.Normalize
 
normalizeRunes(String) - Static method in class org.springframework.shell.support.search.Normalize
 
NOT_ENOUGH_OPTION_ARGUMENTS - Enum constant in enum class org.springframework.shell.command.parser.ParserMessage
 
notUsesWords() - Method in class org.springframework.shell.ValueResultAsserts
 
notUsesWordsForValue() - Method in class org.springframework.shell.ValueResultAsserts
 
NoWrapSizeConstraints - Class in org.springframework.shell.table
A sizing strategy that will impose the longest line width on cells.
NoWrapSizeConstraints() - Constructor for class org.springframework.shell.table.NoWrapSizeConstraints
 
NUL - Static variable in class org.springframework.shell.test.jediterm.typeahead.Ascii
Null ('\0'): The all-zeros character which may serve to accomplish time fill and media fill.
NUL_CHAR - Static variable in class org.springframework.shell.test.jediterm.terminal.util.CharUtils
 
Null - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
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

of() - Static method in interface org.springframework.shell.command.CommandCatalog
Gets an instance of a default CommandCatalog.
of() - Static method in interface org.springframework.shell.command.CommandExitCode
Gets an instance of a default CommandExitCode.
of() - Static method in interface org.springframework.shell.command.CommandRegistration.HelpOptionInfo
 
of(boolean, String[], Character[], String) - Static method in interface org.springframework.shell.command.CommandRegistration.HelpOptionInfo
 
of(int) - Static method in interface org.springframework.shell.component.support.SelectorList
 
of(int, int, int, int[], SearchMatchAlgorithm) - Static method in interface org.springframework.shell.support.search.SearchMatchResult
Construct SearchMatchResult with given parameters.
of(Boolean) - Static method in interface org.springframework.shell.component.ConfirmationInput.ConfirmationInputContext
of(Object, Method) - Static method in interface org.springframework.shell.command.CommandRegistration.TargetInfo
 
of(String) - Static method in interface org.springframework.shell.command.CommandHandlingResult
Gets an instance of CommandHandlingResult.
of(String) - Static method in exception org.springframework.shell.command.CommandParser.CommandParserException
 
of(String[], Character[], String) - Static method in interface org.springframework.shell.command.CommandOption
Gets an instance of a default CommandOption.
of(String[], Character[], String, ResolvableType) - Static method in interface org.springframework.shell.command.CommandOption
Gets an instance of a default CommandOption.
of(String[], String[], Character[], String, ResolvableType, boolean, String, Integer, Integer, Integer, String, CompletionResolver) - Static method in interface org.springframework.shell.command.CommandOption
Gets an instance of a default CommandOption.
of(String[], CommandParser.CommandParserResults, Terminal, CommandRegistration) - Static method in interface org.springframework.shell.command.CommandContext
Gets an instance of a default CommandContext.
of(String, boolean) - Static method in class org.springframework.shell.style.PartsText.PartText
 
of(String, int) - Static method in record class org.springframework.shell.command.parser.Parser.ParseResult.ArgumentResult
 
of(String, Character) - Static method in interface org.springframework.shell.component.StringInput.StringInputContext
of(String, Integer) - Static method in interface org.springframework.shell.command.CommandHandlingResult
Gets an instance of CommandHandlingResult.
of(String, String) - Static method in interface org.springframework.shell.command.CommandAlias
Gets an instance of a default CommandAlias.
of(String, String) - Static method in record class org.springframework.shell.command.parser.DirectiveResult
 
of(String, String) - Static method in interface org.springframework.shell.component.flow.SelectItem
 
of(String, String, boolean, boolean) - Static method in interface org.springframework.shell.component.flow.SelectItem
 
of(String, List<CommandParser.CommandParserException>) - Static method in exception org.springframework.shell.command.CommandExecution.CommandParserExceptionsException
 
of(String, TokenType) - Static method in class org.springframework.shell.command.parser.Token
 
of(String, TokenType, int) - Static method in class org.springframework.shell.command.parser.Token
 
of(String, ThemeSettings) - Static method in interface org.springframework.shell.style.Theme
Create a Theme.
of(String, T) - Static method in interface org.springframework.shell.component.support.SelectorItem
 
of(String, T, boolean, boolean) - Static method in interface org.springframework.shell.component.support.SelectorItem
 
of(Path, SearchMatchResult) - Static method in class org.springframework.shell.component.PathSearch.ScoredPath
 
of(Collection<CommandResolver>, ShellContext) - Static method in interface org.springframework.shell.command.CommandCatalog
Gets an instance of a default CommandCatalog.
of(Consumer<CommandContext>) - Static method in interface org.springframework.shell.command.CommandRegistration.TargetInfo
 
of(Function<CommandContext, ?>) - Static method in interface org.springframework.shell.command.CommandRegistration.TargetInfo
 
of(List<? extends HandlerMethodArgumentResolver>) - Static method in interface org.springframework.shell.command.CommandExecution
Gets an instance of a default CommandExecution.
of(List<? extends HandlerMethodArgumentResolver>, Validator, Terminal, ConversionService) - Static method in interface org.springframework.shell.command.CommandExecution
Gets an instance of a default CommandExecution.
of(List<? extends HandlerMethodArgumentResolver>, Validator, Terminal, ConversionService, CommandCatalog) - Static method in interface org.springframework.shell.command.CommandExecution
Gets an instance of a default CommandExecution.
of(List<String>) - Static method in interface org.springframework.shell.test.ShellScreen
Get ShellScreen out of lines.
of(List<Function<Throwable, Integer>>) - Static method in interface org.springframework.shell.command.CommandExitCode
Gets an instance of a default CommandExitCode.
of(List<PathSearch.ScoredPath>, boolean) - Static method in class org.springframework.shell.component.PathSearch.PathScannerResult
 
of(List<PathSearch.ScoredPath>, long, long, boolean) - Static method in class org.springframework.shell.component.PathSearch.PathScannerResult
 
of(List<PartsText.PartText>) - Static method in class org.springframework.shell.style.PartsText
 
of(Terminal) - Static method in interface org.springframework.shell.test.ShellWriteSequence
Get a new instance of a ShellWriteSequence.
of(ConversionService, Map<String, CommandRegistration>, ParserConfig) - Static method in interface org.springframework.shell.command.CommandParser
Gets an instance of a default command parser.
of(CommandOption, Object) - Static method in interface org.springframework.shell.command.CommandParser.CommandParserResult
Gets an instance of a default CommandParser.CommandParserResult.
of(CommandOption, Object) - Static method in record class org.springframework.shell.command.parser.Parser.ParseResult.OptionResult
 
of(CommandRegistration, List<CommandParser.CommandParserResult>, List<String>, List<CommandParser.CommandParserException>) - Static method in interface org.springframework.shell.command.CommandParser.CommandParserResults
Gets an instance of a default CommandParser.CommandParserResults.
of(ParserMessage, int, Object...) - Static method in record class org.springframework.shell.command.parser.MessageResult
Constructs MessageResult with parser message, position and inserts.
of(PartsText.PartText...) - Static method in class org.springframework.shell.style.PartsText
 
offset - Variable in class org.springframework.shell.test.jediterm.terminal.ArrayTerminalDataStream
 
ofMinus() - Static method in interface org.springframework.shell.support.search.SearchMatchResult
 
ofPosition(String, int) - Static method in interface org.springframework.shell.component.PathSearch.PathSearchContext
 
ofPositions(String, int[]) - Static method in interface org.springframework.shell.component.PathSearch.PathSearchContext
Split given text into PartsText.PartText's by given positions.
ofType(Class<?>) - Static method in class org.springframework.shell.table.CellMatchers
 
ofZeros() - Static method in interface org.springframework.shell.support.search.SearchMatchResult
 
oldschool - Enum constant in enum class org.springframework.shell.table.BorderStyle
A simplistic style, using characters that ought to always be available in all systems (pipe and minus).
on(CellMatcher) - Method in class org.springframework.shell.table.TableBuilder.CellMatcherStub
 
on(CellMatcher) - Method in class org.springframework.shell.table.TableBuilder
 
OnCompletionCommandCondition - Class in org.springframework.shell.boot.condition
 
OnCompletionCommandCondition() - Constructor for class org.springframework.shell.boot.condition.OnCompletionCommandCondition
 
onContextClosedEvent(ContextClosedEvent) - Method in class org.springframework.shell.boot.LineReaderAutoConfiguration
 
ONE_OR_MORE - Enum constant in enum class org.springframework.shell.command.CommandRegistration.OptionArity
Define min(1), max(MAXINTEGER).
onEnterCommandArgumentNode(CommandArgumentNode) - Method in class org.springframework.shell.command.parser.AbstractNodeVisitor
Called when CommandArgumentNode is entered.
onEnterCommandArgumentNode(CommandArgumentNode) - Method in class org.springframework.shell.command.parser.Parser.DefaultNodeVisitor
 
onEnterCommandNode(CommandNode) - Method in class org.springframework.shell.command.parser.AbstractNodeVisitor
Called when CommandNode is entered.
onEnterCommandNode(CommandNode) - Method in class org.springframework.shell.command.parser.Parser.DefaultNodeVisitor
 
onEnterDirectiveNode(DirectiveNode) - Method in class org.springframework.shell.command.parser.AbstractNodeVisitor
Called when DirectiveNode is entered.
onEnterDirectiveNode(DirectiveNode) - Method in class org.springframework.shell.command.parser.Parser.DefaultNodeVisitor
 
onEnterOptionArgumentNode(OptionArgumentNode) - Method in class org.springframework.shell.command.parser.AbstractNodeVisitor
Called when OptionArgumentNode is entered.
onEnterOptionArgumentNode(OptionArgumentNode) - Method in class org.springframework.shell.command.parser.Parser.DefaultNodeVisitor
 
onEnterOptionNode(OptionNode) - Method in class org.springframework.shell.command.parser.AbstractNodeVisitor
Called when OptionNode is entered.
onEnterOptionNode(OptionNode) - Method in class org.springframework.shell.command.parser.Parser.DefaultNodeVisitor
 
onEnterRootCommandNode(CommandNode) - Method in class org.springframework.shell.command.parser.AbstractNodeVisitor
Called when CommandNode for root is entered.
onEnterRootCommandNode(CommandNode) - Method in class org.springframework.shell.command.parser.Parser.DefaultNodeVisitor
 
onExitCommandArgumentNode(CommandArgumentNode) - Method in class org.springframework.shell.command.parser.AbstractNodeVisitor
Called when CommandArgumentNode is exited.
onExitCommandArgumentNode(CommandArgumentNode) - Method in class org.springframework.shell.command.parser.Parser.DefaultNodeVisitor
 
onExitCommandNode(CommandNode) - Method in class org.springframework.shell.command.parser.AbstractNodeVisitor
Called when CommandNode is exited.
onExitCommandNode(CommandNode) - Method in class org.springframework.shell.command.parser.Parser.DefaultNodeVisitor
 
onExitDirectiveNode(DirectiveNode) - Method in class org.springframework.shell.command.parser.AbstractNodeVisitor
Called when DirectiveNode is exited.
onExitDirectiveNode(DirectiveNode) - Method in class org.springframework.shell.command.parser.Parser.DefaultNodeVisitor
 
onExitOptionArgumentNode(OptionArgumentNode) - Method in class org.springframework.shell.command.parser.AbstractNodeVisitor
Called when OptionArgumentNode is exited.
onExitOptionArgumentNode(OptionArgumentNode) - Method in class org.springframework.shell.command.parser.Parser.DefaultNodeVisitor
 
onExitOptionNode(OptionNode) - Method in class org.springframework.shell.command.parser.AbstractNodeVisitor
Called when OptionNode is exited.
onExitOptionNode(OptionNode) - Method in class org.springframework.shell.command.parser.Parser.DefaultNodeVisitor
 
onExitRootCommandNode(CommandNode) - Method in class org.springframework.shell.command.parser.AbstractNodeVisitor
Called when CommandNode for root is exited.
onExitRootCommandNode(CommandNode) - Method in class org.springframework.shell.command.parser.Parser.DefaultNodeVisitor
 
onPanelResize(RequestOrigin) - Method in interface org.springframework.shell.test.jediterm.terminal.ui.TerminalPanelListener
 
onTitleChanged(String) - Method in interface org.springframework.shell.test.jediterm.terminal.ui.TerminalPanelListener
 
OPERATION_BACKSPACE - Static variable in class org.springframework.shell.component.support.AbstractComponent
 
OPERATION_CHAR - Static variable in class org.springframework.shell.component.support.AbstractComponent
 
OPERATION_DOWN - Static variable in class org.springframework.shell.component.support.AbstractComponent
 
OPERATION_EXIT - Static variable in class org.springframework.shell.component.support.AbstractComponent
 
OPERATION_SELECT - Static variable in class org.springframework.shell.component.support.AbstractComponent
 
OPERATION_UP - Static variable in class org.springframework.shell.component.support.AbstractComponent
 
option() - Method in interface org.springframework.shell.command.CommandParser.CommandParserResult
Gets the CommandOption.
option() - Method in class org.springframework.shell.command.CommandParser.DefaultCommandParserResult
 
option() - Method in record class org.springframework.shell.command.parser.Parser.ParseResult.OptionResult
Returns the value of the option record component.
Option - Annotation Interface in org.springframework.shell.command.annotation
Annotation marking a method parameter to be a candicate for an option.
Option() - Constructor for class org.springframework.shell.boot.SpringShellProperties.Option
 
OPTION - Enum constant in enum class org.springframework.shell.command.parser.TokenType
 
OptionArgumentNode - Class in org.springframework.shell.command.parser
Node representing an option argument.
OptionArgumentNode(Token, OptionNode, String) - Constructor for class org.springframework.shell.command.parser.OptionArgumentNode
 
OptionMethodArgumentResolver - Class in org.springframework.shell.command.annotation.support
Resolver for @Option arguments.
OptionMethodArgumentResolver(ConversionService, ConfigurableBeanFactory) - Constructor for class org.springframework.shell.command.annotation.support.OptionMethodArgumentResolver
 
OptionNameModifierSupport - Class in org.springframework.shell.command.support
Support facilities for CommandRegistration.OptionNameModifier providing common naming types.
OptionNameModifierSupport() - Constructor for class org.springframework.shell.command.support.OptionNameModifierSupport
 
OptionNaming() - Constructor for class org.springframework.shell.boot.SpringShellProperties.OptionNaming
 
OptionNode - Class in org.springframework.shell.command.parser
Node representing an option.
OptionNode(Token, String) - Constructor for class org.springframework.shell.command.parser.OptionNode
 
OptionResult(CommandOption, Object) - Constructor for record class org.springframework.shell.command.parser.Parser.ParseResult.OptionResult
Creates an instance of a OptionResult record class.
optionResults() - Method in record class org.springframework.shell.command.parser.Parser.ParseResult
Returns the value of the optionResults record component.
OptionValues - Annotation Interface in org.springframework.shell.command.annotation
Annotation marking a method parameter which completion proposals should be used.
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.
order(int) - Method in class org.springframework.shell.component.flow.BaseInput
 
order(int) - Method in interface org.springframework.shell.component.flow.BaseInputSpec
Sets order of this component.
OrderedInputOperation() - Constructor for class org.springframework.shell.component.flow.ComponentFlow.OrderedInputOperation
 
org.springframework.shell - package org.springframework.shell
Contains core classes for Spring Shell, irrespective of the way commands are actually implemented.
org.springframework.shell.boot - package org.springframework.shell.boot
 
org.springframework.shell.boot.condition - package org.springframework.shell.boot.condition
 
org.springframework.shell.command - package org.springframework.shell.command
 
org.springframework.shell.command.annotation - package org.springframework.shell.command.annotation
 
org.springframework.shell.command.annotation.support - package org.springframework.shell.command.annotation.support
 
org.springframework.shell.command.invocation - package org.springframework.shell.command.invocation
 
org.springframework.shell.command.parser - package org.springframework.shell.command.parser
 
org.springframework.shell.command.support - package org.springframework.shell.command.support
 
org.springframework.shell.completion - package org.springframework.shell.completion
 
org.springframework.shell.component - package org.springframework.shell.component
 
org.springframework.shell.component.context - package org.springframework.shell.component.context
 
org.springframework.shell.component.flow - package org.springframework.shell.component.flow
 
org.springframework.shell.component.support - package org.springframework.shell.component.support
 
org.springframework.shell.config - package org.springframework.shell.config
 
org.springframework.shell.context - package org.springframework.shell.context
 
org.springframework.shell.exit - package org.springframework.shell.exit
 
org.springframework.shell.jline - package org.springframework.shell.jline
Contains classes that leverage the JLine library to hook into the Spring Shell REPL.
org.springframework.shell.result - package org.springframework.shell.result
Contains strategies for dealing with results of commands.
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
 
org.springframework.shell.style - package org.springframework.shell.style
 
org.springframework.shell.support - package org.springframework.shell.support
 
org.springframework.shell.support.search - package org.springframework.shell.support.search
 
org.springframework.shell.table - package org.springframework.shell.table
Allows the creation of tables that can be rendered using ASCII art.
org.springframework.shell.test - package org.springframework.shell.test
 
org.springframework.shell.test.autoconfigure - package org.springframework.shell.test.autoconfigure
 
org.springframework.shell.test.jediterm.terminal - package org.springframework.shell.test.jediterm.terminal
 
org.springframework.shell.test.jediterm.terminal.emulator - package org.springframework.shell.test.jediterm.terminal.emulator
 
org.springframework.shell.test.jediterm.terminal.emulator.charset - package org.springframework.shell.test.jediterm.terminal.emulator.charset
 
org.springframework.shell.test.jediterm.terminal.model - package org.springframework.shell.test.jediterm.terminal.model
 
org.springframework.shell.test.jediterm.terminal.ui - package org.springframework.shell.test.jediterm.terminal.ui
 
org.springframework.shell.test.jediterm.terminal.util - package org.springframework.shell.test.jediterm.terminal.util
 
org.springframework.shell.test.jediterm.typeahead - package org.springframework.shell.test.jediterm.typeahead
 
OriginMode - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
OS_NAME - Static variable in class org.springframework.shell.test.jediterm.terminal.ui.UIUtil
 
OS_VERSION - Static variable in class org.springframework.shell.test.jediterm.terminal.ui.UIUtil
 
OUTLINE - Static variable in class org.springframework.shell.table.BorderSpecification
 
overrideGL(int) - Method in class org.springframework.shell.test.jediterm.terminal.emulator.charset.GraphicSetState
Overrides the GL graphic set for the next written character.

P

paintBorder(BorderStyle, int) - Method in class org.springframework.shell.table.TableBuilder
 
Pair<A,B> - Class in org.springframework.shell.test.jediterm.terminal.util
 
Pair(A, B) - Constructor for class org.springframework.shell.test.jediterm.terminal.util.Pair
 
ParameterResolverAutoConfiguration - Class in org.springframework.shell.boot
 
ParameterResolverAutoConfiguration() - Constructor for class org.springframework.shell.boot.ParameterResolverAutoConfiguration
 
ParameterResolverMissingException - Exception in org.springframework.shell
Thrown when no ParameterResolver is found for a parameter during a resolve operation.
ParameterResolverMissingException(MethodParameter) - Constructor for exception org.springframework.shell.ParameterResolverMissingException
 
ParameterValidationException - Exception in org.springframework.shell
Thrown when one or more parameters fail bean validation constraints.
ParameterValidationException(Set<ConstraintViolation<Object>>) - Constructor for exception org.springframework.shell.ParameterValidationException
 
parameterValidationExceptionResultHandler(Terminal) - Method in class org.springframework.shell.result.ResultHandlerConfig
 
ParameterValidationExceptionResultHandler - Class in org.springframework.shell.result
Displays validation errors on the terminal.
ParameterValidationExceptionResultHandler(Terminal) - Constructor for class org.springframework.shell.result.ParameterValidationExceptionResultHandler
 
parse(String[]) - Method in class org.springframework.shell.command.CommandParser.AstCommandParser
 
parse(String[]) - Method in interface org.springframework.shell.command.CommandParser
Parse options with a given arguments.
parse(String, int, Parser.ParseContext) - Method in class org.springframework.shell.jline.ExtendedDefaultParser
 
parse(List<String>) - Method in class org.springframework.shell.command.parser.Parser.DefaultParser
 
parse(List<String>) - Method in interface org.springframework.shell.command.parser.Parser
Parse given arguments into a Parser.ParseResult.
parser() - Method in class org.springframework.shell.boot.JLineShellAutoConfiguration
 
Parser - Interface in org.springframework.shell.command.parser
Interface to parse command line arguments.
Parser.DefaultNodeVisitor - Class in org.springframework.shell.command.parser
Default implementation of a NodeVisitor.
Parser.DefaultParser - Class in org.springframework.shell.command.parser
Default implementation of a Parser.
Parser.ParseResult - Record Class in org.springframework.shell.command.parser
Results from a Parser containing needed information like resolved CommandRegistration, list of CommandOption instances, errors and directive.
Parser.ParseResult.ArgumentResult - Record Class in org.springframework.shell.command.parser
 
Parser.ParseResult.OptionResult - Record Class in org.springframework.shell.command.parser
 
ParserConfig - Class in org.springframework.shell.command.parser
 
ParserConfig() - Constructor for class org.springframework.shell.command.parser.ParserConfig
 
ParserConfig.Feature - Enum Class in org.springframework.shell.command.parser
 
ParseResult(CommandRegistration, List<Parser.ParseResult.OptionResult>, List<Parser.ParseResult.ArgumentResult>, List<MessageResult>, List<DirectiveResult>) - Constructor for record class org.springframework.shell.command.parser.Parser.ParseResult
Creates an instance of a ParseResult record class.
parserMessage() - Method in record class org.springframework.shell.command.parser.MessageResult
Returns the value of the parserMessage record component.
ParserMessage - Enum Class in org.springframework.shell.command.parser
Contains all the messages that can be produced during parsing.
ParserMessage.Type - Enum Class in org.springframework.shell.command.parser
 
PartsText - Class in org.springframework.shell.style
 
PartsText.PartText - Class in org.springframework.shell.style
 
PartsTextRenderer - Class in org.springframework.shell.style
 
PartsTextRenderer(ThemeResolver) - Constructor for class org.springframework.shell.style.PartsTextRenderer
 
PartText(String, boolean) - Constructor for class org.springframework.shell.style.PartsText.PartText
 
PASCAL - Enum constant in enum class org.springframework.shell.boot.SpringShellProperties.OptionNamingCase
 
PASCALCASE - Static variable in class org.springframework.shell.command.support.OptionNameModifierSupport
 
PathInput - Class in org.springframework.shell.component
Component for a simple path input.
PathInput(Terminal) - Constructor for class org.springframework.shell.component.PathInput
 
PathInput(Terminal, String) - Constructor for class org.springframework.shell.component.PathInput
 
PathInput(Terminal, String, Function<PathInput.PathInputContext, List<AttributedString>>) - Constructor for class org.springframework.shell.component.PathInput
 
PathInput.PathInputContext - Interface in org.springframework.shell.component
 
PathInputSpec - Interface in org.springframework.shell.component.flow
Interface for path input spec builder.
PathSearch - Class in org.springframework.shell.component
Component resolving Path based on base path and optional search term.
PathSearch(Terminal) - Constructor for class org.springframework.shell.component.PathSearch
 
PathSearch(Terminal, String) - Constructor for class org.springframework.shell.component.PathSearch
 
PathSearch(Terminal, String, PathSearch.PathSearchConfig) - Constructor for class org.springframework.shell.component.PathSearch
 
PathSearch(Terminal, String, PathSearch.PathSearchConfig, Function<PathSearch.PathSearchContext, List<AttributedString>>) - Constructor for class org.springframework.shell.component.PathSearch
 
PathSearch.PathScannerResult - Class in org.springframework.shell.component
Result from a path scanning.
PathSearch.PathSearchConfig - Class in org.springframework.shell.component
Class defining configuration for path search.
PathSearch.PathSearchContext - Interface in org.springframework.shell.component
Context for PathSearch.
PathSearch.PathSearchContext.PathViewItem - Class in org.springframework.shell.component
Domain class for path view item.
PathSearch.ScoredPath - Class in org.springframework.shell.component
Holder class keeping Path and SearchMatchResult.
PathSearchConfig() - Constructor for class org.springframework.shell.component.PathSearch.PathSearchConfig
 
PathViewItem(Path, PartsText, boolean) - Constructor for class org.springframework.shell.component.PathSearch.PathSearchContext.PathViewItem
 
position() - Method in record class org.springframework.shell.command.parser.MessageResult
Returns the value of the position record component.
position() - Method in record class org.springframework.shell.command.parser.Parser.ParseResult.ArgumentResult
Returns the value of the position record component.
position(Integer) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
position(Integer) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec
Define an optional hint for possible positional mapping.
positional() - Method in interface org.springframework.shell.command.CommandParser.CommandParserResults
Gets the unmapped positional arguments.
positional() - Method in class org.springframework.shell.command.CommandParser.DefaultCommandParserResults
 
postHandler(Consumer<ConfirmationInput.ConfirmationInputContext>) - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
postHandler(Consumer<ConfirmationInput.ConfirmationInputContext>) - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec
Adds a post-run context handler.
postHandler(Consumer<MultiItemSelector.MultiItemSelectorContext<String, SelectorItem<String>>>) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
postHandler(Consumer<MultiItemSelector.MultiItemSelectorContext<String, SelectorItem<String>>>) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec
Adds a post-run context handler.
postHandler(Consumer<PathInput.PathInputContext>) - Method in class org.springframework.shell.component.flow.BasePathInput
 
postHandler(Consumer<PathInput.PathInputContext>) - Method in interface org.springframework.shell.component.flow.PathInputSpec
Adds a post-run context handler.
postHandler(Consumer<SingleItemSelector.SingleItemSelectorContext<String, SelectorItem<String>>>) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
postHandler(Consumer<SingleItemSelector.SingleItemSelectorContext<String, SelectorItem<String>>>) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec
Adds a post-run context handler.
postHandler(Consumer<StringInput.StringInputContext>) - Method in class org.springframework.shell.component.flow.BaseStringInput
 
postHandler(Consumer<StringInput.StringInputContext>) - Method in interface org.springframework.shell.component.flow.StringInputSpec
Adds a post-run context handler.
postResize(int, int, RequestOrigin) - Method in class org.springframework.shell.test.jediterm.terminal.TerminalStarter
 
PRECEDENCE - Static variable in class org.springframework.shell.DefaultShellApplicationRunner
The precedence at which this runner is executed with respect to other ApplicationRunner beans
PRECEDENCE - Static variable in class org.springframework.shell.jline.InteractiveShellRunner
The precedence at which this runner is ordered by the DefaultApplicationRunner - which also controls the order it is consulted on the ability to handle the current shell.
PRECEDENCE - Static variable in class org.springframework.shell.jline.NonInteractiveShellRunner
The precedence at which this runner is ordered by the DefaultApplicationRunner - which also controls the order it is consulted on the ability to handle the current shell.
PRECEDENCE - Static variable in class org.springframework.shell.jline.ScriptShellRunner
The precedence at which this runner is ordered by the DefaultApplicationRunner - which also controls the order it is consulted on the ability to handle the current shell.
prefix() - Element in annotation interface org.springframework.shell.standard.ShellMethod
The prefix to use for assigning parameters by name.
preHandler(Consumer<ConfirmationInput.ConfirmationInputContext>) - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
preHandler(Consumer<ConfirmationInput.ConfirmationInputContext>) - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec
Adds a pre-run context handler.
preHandler(Consumer<MultiItemSelector.MultiItemSelectorContext<String, SelectorItem<String>>>) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
preHandler(Consumer<MultiItemSelector.MultiItemSelectorContext<String, SelectorItem<String>>>) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec
Adds a pre-run context handler.
preHandler(Consumer<PathInput.PathInputContext>) - Method in class org.springframework.shell.component.flow.BasePathInput
 
preHandler(Consumer<PathInput.PathInputContext>) - Method in interface org.springframework.shell.component.flow.PathInputSpec
Adds a pre-run context handler.
preHandler(Consumer<SingleItemSelector.SingleItemSelectorContext<String, SelectorItem<String>>>) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
preHandler(Consumer<SingleItemSelector.SingleItemSelectorContext<String, SelectorItem<String>>>) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec
Adds a pre-run context handler.
preHandler(Consumer<StringInput.StringInputContext>) - Method in class org.springframework.shell.component.flow.BaseStringInput
 
preHandler(Consumer<StringInput.StringInputContext>) - Method in interface org.springframework.shell.component.flow.StringInputSpec
Adds a pre-run context handler.
previousTab(int) - Method in interface org.springframework.shell.test.jediterm.terminal.model.Tabulator
Returns the previous tab stop that is before the given position.
PRINTING - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.util.CharUtils.CharacterType
 
process(int, StyledTextConsumer, int) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine
 
processChar(char, Terminal) - Method in class org.springframework.shell.test.jediterm.terminal.DataStreamIteratingEmulator
 
processChar(char, Terminal) - Method in class org.springframework.shell.test.jediterm.terminal.emulator.JediEmulator
 
processHistoryAndScreenLines(int, int, StyledTextConsumer) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
processLines(int, int, StyledTextConsumer) - Method in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
processLines(int, int, StyledTextConsumer, int) - Method in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
processScreenLines(int, int, StyledTextConsumer) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
promptProvider() - Method in class org.springframework.shell.boot.JLineShellAutoConfiguration
 
PromptProvider - Interface in org.springframework.shell.jline
Called at each REPL cycle to decide what the prompt should be.
properties() - Element in annotation interface org.springframework.shell.test.autoconfigure.ShellTest
Properties in form key=value that should be added to the Spring Environment before the test runs.
provide() - Method in interface org.springframework.shell.config.UserConfigPathProvider
Provides a path to a user config location.
provider() - Element in annotation interface org.springframework.shell.command.annotation.CommandAvailability
Names of provider beans for Availability.
provider() - Element in annotation interface org.springframework.shell.command.annotation.OptionValues
Names of beans for CompletionProvider.
pushBackBuffer(char[], int) - Method in class org.springframework.shell.test.jediterm.terminal.ArrayTerminalDataStream
 
pushBackBuffer(char[], int) - Method in interface org.springframework.shell.test.jediterm.terminal.TerminalDataStream
 
pushBackReordered(TerminalDataStream) - Method in class org.springframework.shell.test.jediterm.terminal.emulator.ControlSequence
 
pushChar(char) - Method in class org.springframework.shell.test.jediterm.terminal.ArrayTerminalDataStream
 
pushChar(char) - Method in interface org.springframework.shell.test.jediterm.terminal.TerminalDataStream
 
put(Object, Object) - Method in class org.springframework.shell.component.context.BaseComponentContext
 
put(Object, Object) - Method in interface org.springframework.shell.component.context.ComponentContext
Put an entry into a context.

Q

questionMark() - Method in class org.springframework.shell.style.FigureSettings
 
quit() - Method in class org.springframework.shell.boot.StandardCommandsAutoConfiguration
 
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.
QuitCommand() - Constructor for class org.springframework.shell.boot.SpringShellProperties.QuitCommand
 

R

rawText() - Method in interface org.springframework.shell.Input
Return the input as entered by the user.
read(char[], int, int) - Method in interface org.springframework.shell.test.jediterm.terminal.TtyConnector
 
read(BindingReader, KeyMap<String>, C) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent
 
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>, PathSearch.PathSearchContext) - Method in class org.springframework.shell.component.PathSearch
 
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.
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
 
readNonControlCharacters(int) - Method in class org.springframework.shell.test.jediterm.terminal.ArrayTerminalDataStream
 
readNonControlCharacters(int) - Method in interface org.springframework.shell.test.jediterm.terminal.TerminalDataStream
 
readNonControlCharacters(int) - Method in class org.springframework.shell.test.jediterm.terminal.TtyBasedArrayDataStream
 
ready() - Method in interface org.springframework.shell.test.jediterm.terminal.TtyConnector
 
register(Class<?>) - Method in class org.springframework.shell.command.annotation.support.CommandRegistrationBeanRegistrar
 
register(CommandCatalog) - Method in interface org.springframework.shell.MethodTargetRegistrar
Register mappings from <command keyword(s)> to actual behavior.
register(CommandCatalog) - Method in class org.springframework.shell.standard.StandardMethodTargetRegistrar
 
register(CommandRegistration...) - Method in class org.springframework.shell.command.CommandCatalog.DefaultCommandCatalog
 
register(CommandRegistration...) - Method in interface org.springframework.shell.command.CommandCatalog
register(Theme) - Method in class org.springframework.shell.style.ThemeRegistry
Register a theme.
registerBeanDefinitions(AnnotationMetadata, BeanDefinitionRegistry) - Method in class org.springframework.shell.command.annotation.support.CommandScanRegistrar
 
registerBeanDefinitions(AnnotationMetadata, BeanDefinitionRegistry) - Method in class org.springframework.shell.command.annotation.support.EnableCommandRegistrar
 
registerHints(RuntimeHints, ClassLoader) - Method in class org.springframework.shell.JnaRuntimeHints
 
registerMethodHint(ReflectionHints, Method) - Method in class org.springframework.shell.AvailabilityReflectiveProcessor
Register ReflectionHints against the specified Method.
registerReflectionHints(ReflectionHints, AnnotatedElement) - Method in class org.springframework.shell.AvailabilityReflectiveProcessor
 
registration() - Method in interface org.springframework.shell.command.CommandParser.CommandParserResults
Gets the registration.
registration() - Method in class org.springframework.shell.command.CommandParser.DefaultCommandParserResults
 
RegistrationOptionsCompletionResolver - Class in org.springframework.shell.completion
Default implementation of a CompletionResolver.
RegistrationOptionsCompletionResolver() - Constructor for class org.springframework.shell.completion.RegistrationOptionsCompletionResolver
 
registrations() - Method in interface org.springframework.shell.result.CommandNotFoundMessageProvider.ProviderContext
Gets a command registrations.
Remote - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.RequestOrigin
 
removeBottomEmptyLines(int, int) - Method in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
removeHiddenCommands(Map<String, CommandRegistration>) - Static method in class org.springframework.shell.Utils
Takes a map of command registrations and removes hidden commands from it.
removeModelListener(TerminalModelListener) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
removeTopLines(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
removeTypeAheadModelListener(TerminalModelListener) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
render(int) - Method in class org.springframework.shell.table.Table
 
render(int) - Method in interface org.springframework.shell.TerminalSizeAware
 
render(String, Map<String, Object>) - Method in class org.springframework.shell.style.TemplateExecutor
Render template with a given attributes.
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.
renderer(Function<ConfirmationInput.ConfirmationInputContext, List<AttributedString>>) - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
renderer(Function<ConfirmationInput.ConfirmationInputContext, List<AttributedString>>) - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec
Sets a renderer function.
renderer(Function<MultiItemSelector.MultiItemSelectorContext<String, SelectorItem<String>>, List<AttributedString>>) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
renderer(Function<MultiItemSelector.MultiItemSelectorContext<String, SelectorItem<String>>, List<AttributedString>>) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec
Sets a renderer function.
renderer(Function<PathInput.PathInputContext, List<AttributedString>>) - Method in class org.springframework.shell.component.flow.BasePathInput
 
renderer(Function<PathInput.PathInputContext, List<AttributedString>>) - Method in interface org.springframework.shell.component.flow.PathInputSpec
Sets a renderer function.
renderer(Function<SingleItemSelector.SingleItemSelectorContext<String, SelectorItem<String>>, List<AttributedString>>) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
renderer(Function<SingleItemSelector.SingleItemSelectorContext<String, SelectorItem<String>>, List<AttributedString>>) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec
Sets a renderer function.
renderer(Function<StringInput.StringInputContext, List<AttributedString>>) - Method in class org.springframework.shell.component.flow.BaseStringInput
 
renderer(Function<StringInput.StringInputContext, List<AttributedString>>) - Method in interface org.springframework.shell.component.flow.StringInputSpec
Sets a renderer function.
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.
RequestOrigin - Enum Class in org.springframework.shell.test.jediterm.terminal
 
required() - Element in annotation interface org.springframework.shell.command.annotation.Option
Mark option required.
required() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
required() - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec
Define option to be required.
required(boolean) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
required(boolean) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec
Define if option is required.
reset() - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder
 
reset() - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder
Resets existing builder.
reset() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
reset() - Method in class org.springframework.shell.test.jediterm.terminal.model.StyleState
 
reset() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
reset(List<Function<Throwable, Integer>>) - Method in interface org.springframework.shell.exit.ExitCodeMappings
Reset mappings into a given functions.
reset(List<T>) - Method in class org.springframework.shell.component.support.SelectorList.DefaultSelectorList
 
reset(List<T>) - Method in interface org.springframework.shell.component.support.SelectorList
 
resetEof() - Method in class org.springframework.shell.test.jediterm.terminal.DataStreamIteratingEmulator
 
resetEof() - Method in interface org.springframework.shell.test.jediterm.terminal.emulator.Emulator
 
resetScrollRegions() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
resetScrollRegions() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
resetState() - Method in class org.springframework.shell.test.jediterm.terminal.emulator.charset.GraphicSetState
Resets the state to its initial values.
resize(int) - Method in interface org.springframework.shell.test.jediterm.terminal.model.Tabulator
 
resize(int, int) - Method in interface org.springframework.shell.test.jediterm.terminal.TtyConnector
 
resize(int, int, RequestOrigin) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
resize(int, int, RequestOrigin) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
resize(int, int, RequestOrigin, CompletableFuture<?>) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
resize(int, int, RequestOrigin, CompletableFuture<?>) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
resize(Emulator, Terminal, TtyConnector, int, int, RequestOrigin, BiConsumer<Long, Runnable>) - Static method in class org.springframework.shell.test.jediterm.terminal.TerminalStarter
Resizes terminal and tty connector, should be called on a pooled thread.
resolve() - Method in interface org.springframework.shell.command.CommandResolver
Resolve command registrations.
resolve(Exception) - Method in class org.springframework.shell.command.annotation.MethodCommandExceptionResolver
 
resolve(Exception) - Method in interface org.springframework.shell.command.CommandExceptionResolver
Try to resolve the given exception that got thrown during command processing.
resolve(Exception) - Method in class org.springframework.shell.command.CommandParserExceptionResolver
 
resolveArgument(MethodParameter, Message<?>) - Method in class org.springframework.shell.command.CommandContextMethodArgumentResolver
 
resolveArgument(MethodParameter, Message<?>) - Method in class org.springframework.shell.command.CommandExecution.ParamNameHandlerMethodArgumentResolver
 
resolveArgument(MethodParameter, Message<?>) - Method in class org.springframework.shell.command.invocation.ShellMethodArgumentResolverComposite
Iterate over registered HandlerMethodArgumentResolvers and invoke the one that supports it.
resolveArgument(MethodParameter, Message<?>) - Method in class org.springframework.shell.support.AbstractArgumentMethodArgumentResolver
 
resolveArgumentInternal(MethodParameter, Message<?>, List<String>) - Method in class org.springframework.shell.command.annotation.support.OptionMethodArgumentResolver
 
resolveArgumentInternal(MethodParameter, Message<?>, List<String>) - Method in class org.springframework.shell.command.ArgumentHeaderMethodArgumentResolver
 
resolveArgumentInternal(MethodParameter, Message<?>, List<String>) - Method in class org.springframework.shell.standard.ShellOptionMethodArgumentResolver
 
resolveArgumentInternal(MethodParameter, Message<?>, List<String>) - Method in class org.springframework.shell.support.AbstractArgumentMethodArgumentResolver
Resolves the given parameter type and value name into an argument value.
resolvedValue() - Method in class org.springframework.shell.ValueResult
Represents the resolved value for the MethodParameter associated with this result.
resolveFigureTag(String) - Method in class org.springframework.shell.style.ThemeResolver
Resolve figure from a tag with activated theme.
resolveMethod(Exception) - Method in class org.springframework.shell.command.annotation.ExceptionResolverMethodResolver
Find a Method to handle the given exception.
resolveMethodByExceptionType(Class<? extends Throwable>) - Method in class org.springframework.shell.command.annotation.ExceptionResolverMethodResolver
Find a Method to handle the given exception type.
resolveMethodByThrowable(Throwable) - Method in class org.springframework.shell.command.annotation.ExceptionResolverMethodResolver
Find a Method to handle the given Throwable.
resolvePath(String) - Method in class org.springframework.shell.component.PathInput
Resolves a Path from a given raw path.
resolvePath(String) - Method in class org.springframework.shell.component.PathSearch
Resolves a Path from a given raw path.
resolver(CommandExceptionResolver) - Method in class org.springframework.shell.command.CommandRegistration.DefaultErrorHandlingSpec
 
resolver(CommandExceptionResolver) - Method in interface org.springframework.shell.command.CommandRegistration.ErrorHandlingSpec
resolveStyle(String) - Method in class org.springframework.shell.style.ThemeResolver
Resolve AttributedStyle from a spec.
resolveStyleTag(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.FigureSettings
 
resolveTag(String) - Method in class org.springframework.shell.style.StyleSettings
Resolve a theme setting from a given tag.
resourceLoader(ResourceLoader) - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder
 
resourceLoader(ResourceLoader) - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder
Sets a ResourceLoader.
restoreCursor() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
restoreCursor() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
restoreCursor(StoredCursor) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
restoreWindowTitleFromStack() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
restoreWindowTitleFromStack() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
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
Used for explicit configuration of ResultHandlers.
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(Set<ResultHandler<?>>) - Method in class org.springframework.shell.boot.SpringShellAutoConfiguration
 
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.
resultMode(ResultMode) - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
resultMode(ResultMode) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
resultMode(ResultMode) - Method in class org.springframework.shell.component.flow.BasePathInput
 
resultMode(ResultMode) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
resultMode(ResultMode) - Method in class org.springframework.shell.component.flow.BaseStringInput
 
resultMode(ResultMode) - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec
Sets a result mode.
resultMode(ResultMode) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec
Sets a result mode.
resultMode(ResultMode) - Method in interface org.springframework.shell.component.flow.PathInputSpec
Sets a result mode.
resultMode(ResultMode) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec
Sets a result mode.
resultMode(ResultMode) - Method in interface org.springframework.shell.component.flow.StringInputSpec
Sets a result mode.
ResultMode - Enum Class in org.springframework.shell.component.flow
Enumeration of a modes instructing how resultValue is handled.
results() - Method in interface org.springframework.shell.command.CommandParser.CommandParserResults
Gets the results.
results() - Method in class org.springframework.shell.command.CommandParser.DefaultCommandParserResults
 
resultValue(Boolean) - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
resultValue(Boolean) - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec
Sets a result value.
resultValue(String) - Method in class org.springframework.shell.component.flow.BasePathInput
 
resultValue(String) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
resultValue(String) - Method in class org.springframework.shell.component.flow.BaseStringInput
 
resultValue(String) - Method in interface org.springframework.shell.component.flow.PathInputSpec
Sets a result value.
resultValue(String) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec
Sets a result value.
resultValue(String) - Method in interface org.springframework.shell.component.flow.StringInputSpec
Sets a result value.
resultValues(List<String>) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
resultValues(List<String>) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec
Sets a result values.
reverseIndex() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
reverseIndex() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
ReverseVideo - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
ReverseWrapAround - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
right - Enum constant in enum class org.springframework.shell.table.SimpleHorizontalAligner
 
RIGHT - Static variable in class org.springframework.shell.table.BorderSpecification
 
rightPointingQuotation() - Method in class org.springframework.shell.style.FigureSettings
 
righwardsArror() - Method in class org.springframework.shell.style.FigureSettings
 
row(int) - Static method in class org.springframework.shell.table.CellMatchers
 
run() - Method in class org.springframework.shell.component.flow.ComponentFlow.DefaultComponentFlow
 
run() - Method in interface org.springframework.shell.component.flow.ComponentFlow
Run a wizard and returns a result from it.
run() - Method in interface org.springframework.shell.test.ShellTestClient.BaseShellSession
Run a session.
run() - Method in class org.springframework.shell.test.ShellTestClient.DefaultInteractiveShellSession
 
run() - Method in class org.springframework.shell.test.ShellTestClient.DefaultNonInteractiveShellSession
 
run() - Method in class org.springframework.shell.test.ShellTestClient.ShellRunnerTask
 
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(ApplicationArguments) - Method in interface org.springframework.shell.ShellRunner
Execute application.
run(ComponentContext<?>) - Method in class org.springframework.shell.component.support.AbstractComponent
Runs a component logic with a given context and returns updated context.
run(InputProvider) - Method in class org.springframework.shell.Shell
The main program loop: acquire input, try to match it to a command and evaluate.
runInternal(C) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent
 
runInternal(C) - Method in class org.springframework.shell.component.support.AbstractTextComponent
 
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.
runner() - Method in record class org.springframework.shell.test.ShellTestClient.ShellRunnerTaskData
Returns the value of the runner record component.
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

S

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.)
saveCursor() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
saveCursor() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
saveWindowTitleOnStack() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
saveWindowTitleOnStack() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
screen() - Method in interface org.springframework.shell.test.ShellTestClient.BaseShellSession
Read the screen.
screen() - Method in class org.springframework.shell.test.ShellTestClient.DefaultInteractiveShellSession
 
screen() - Method in class org.springframework.shell.test.ShellTestClient.DefaultNonInteractiveShellSession
 
screen() - Method in class org.springframework.shell.test.ShellTestClient.DefaultShellClient
 
screen() - Method in interface org.springframework.shell.test.ShellTestClient
Read the screen.
script(File) - Method in class org.springframework.shell.standard.commands.Script
 
script(Parser) - Method in class org.springframework.shell.boot.StandardCommandsAutoConfiguration
 
Script - Class in org.springframework.shell.standard.commands
A command that can read and execute other commands from a file.
Script() - Constructor for class org.springframework.shell.boot.SpringShellProperties.Script
 
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.
scriptApplicationRunner() - Method in class org.springframework.shell.boot.ShellRunnerAutoConfiguration
 
ScriptCommand() - Constructor for class org.springframework.shell.boot.SpringShellProperties.ScriptCommand
 
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
 
SCROLL_SPEED - Static variable in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
scrollArea(int, int, int) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
scrollArea(int, int, int) - Method in interface org.springframework.shell.test.jediterm.terminal.TerminalDisplay
 
scrollArea(int, int, int) - Method in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
scrollDown() - Method in class org.springframework.shell.component.support.SelectorList.DefaultSelectorList
 
scrollDown() - Method in interface org.springframework.shell.component.support.SelectorList
 
scrollDown(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
scrollDown(int) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
scrollUp() - Method in class org.springframework.shell.component.support.SelectorList.DefaultSelectorList
 
scrollUp() - Method in interface org.springframework.shell.component.support.SelectorList
 
scrollUp(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
scrollUp(int) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
scrollY() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
SearchMatch - Interface in org.springframework.shell.support.search
Interface defining a search match for text agains pattern.
SearchMatch.Builder - Interface in org.springframework.shell.support.search
Defines an interface for SearchMatch.
SearchMatch.DefaultBuilder - Class in org.springframework.shell.support.search
 
SearchMatch.DefaultSearchMatch - Class in org.springframework.shell.support.search
 
SearchMatchAlgorithm - Interface in org.springframework.shell.support.search
Interface to match given text with a pattern into a result.
SearchMatchResult - Interface in org.springframework.shell.support.search
Interface defining result used in SearchMatch.
SearchMatchResult.DefaultResult - Class in org.springframework.shell.support.search
 
second - Variable in class org.springframework.shell.test.jediterm.terminal.util.Pair
 
Selectable - Interface in org.springframework.shell.component.support
 
selected() - Method in class org.springframework.shell.component.flow.DefaultSelectItem
 
selected() - Method in interface org.springframework.shell.component.flow.SelectItem
Return if the item is selected.
selectItem(String, String) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
selectItem(String, String) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec
Adds a select item.
SelectItem - Interface in org.springframework.shell.component.flow
Interface for selectitem contract in selectors.
selectItems(List<SelectItem>) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
selectItems(List<SelectItem>) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec
Adds a list of select items.
selectItems(Map<String, String>) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
selectItems(Map<String, String>) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec
Adds a map of select items.
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, boolean) - Constructor for class org.springframework.shell.component.support.SelectorItem.SelectorItemWrapper
 
SelectorList<T extends Nameable> - Interface in org.springframework.shell.component.support
 
SelectorList.BaseProjectionItem<T extends Nameable> - Class in org.springframework.shell.component.support
 
SelectorList.DefaultSelectorList<T extends Nameable> - Class in org.springframework.shell.component.support
 
SelectorList.ProjectionItem<T> - Interface in org.springframework.shell.component.support
 
sendBytes(byte[]) - Method in interface org.springframework.shell.test.jediterm.terminal.TerminalOutputStream
sendBytes(byte[]) - Method in class org.springframework.shell.test.jediterm.terminal.TerminalStarter
 
sendBytes(byte[], boolean) - Method in interface org.springframework.shell.test.jediterm.terminal.TerminalOutputStream
 
sendBytes(byte[], boolean) - Method in class org.springframework.shell.test.jediterm.terminal.TerminalStarter
 
SendReceive - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
sendString(String) - Method in interface org.springframework.shell.test.jediterm.terminal.TerminalOutputStream
sendString(String) - Method in class org.springframework.shell.test.jediterm.terminal.TerminalStarter
 
sendString(String, boolean) - Method in interface org.springframework.shell.test.jediterm.terminal.TerminalOutputStream
 
sendString(String, boolean) - Method in class org.springframework.shell.test.jediterm.terminal.TerminalStarter
 
set(StyleState) - Method in class org.springframework.shell.test.jediterm.terminal.model.StyleState
 
setAltSendsEscape(boolean) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
setAltSendsEscape(boolean) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
setAnsiConformanceLevel(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
setAnsiConformanceLevel(int) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
setApplicationArrowKeys(boolean) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
setApplicationArrowKeys(boolean) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
setApplicationContext(ApplicationContext) - Method in class org.springframework.shell.standard.AbstractShellComponent
 
setApplicationKeypad(boolean) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
setApplicationKeypad(boolean) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
setArgumentResolvers(CommandExecution.CommandExecutionHandlerMethodArgumentResolvers) - Method in class org.springframework.shell.Shell
 
setAutoNewLine(boolean) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
setAutoNewLine(boolean) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
setBlinkingCursor(boolean) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
setBlinkingCursor(boolean) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
setBracketedPasteMode(boolean) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
setBracketedPasteMode(boolean) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
setBracketedPasteMode(boolean) - Method in interface org.springframework.shell.test.jediterm.terminal.TerminalDisplay
 
setBracketedPasteMode(boolean) - Method in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
setBuildProperties(BuildProperties) - Method in class org.springframework.shell.standard.commands.Version
 
setCaseType(SpringShellProperties.OptionNamingCase) - Method in class org.springframework.shell.boot.SpringShellProperties.OptionNaming
 
setClear(SpringShellProperties.ClearCommand) - Method in class org.springframework.shell.boot.SpringShellProperties.Command
 
setCommand(String) - Method in class org.springframework.shell.boot.SpringShellProperties.Help
 
setCommand(SpringShellProperties.Command) - Method in class org.springframework.shell.boot.SpringShellProperties
 
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.
setCommandsTemplate(String) - Method in class org.springframework.shell.boot.SpringShellProperties.HelpCommand
 
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.boot.SpringShellProperties.HelpCommand
 
setCommandTemplate(String) - Method in class org.springframework.shell.standard.commands.Help
Sets a location for a template rendering command help.
setCompletion(SpringShellProperties.CompletionCommand) - Method in class org.springframework.shell.boot.SpringShellProperties.Command
 
setCompletionResolvers(List<CompletionResolver>) - Method in class org.springframework.shell.Shell
 
setConfig(SpringShellProperties.Config) - Method in class org.springframework.shell.boot.SpringShellProperties
 
setContents(String, boolean) - Method in interface org.springframework.shell.test.jediterm.terminal.TerminalCopyPasteHandler
 
setConversionService(ConversionService) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
Sets a conversion service
setConversionService(ConversionService) - Method in class org.springframework.shell.Shell
 
setCoordAccessor(TerminalCoordinates) - Method in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
setCurrent(TextStyle) - Method in class org.springframework.shell.test.jediterm.terminal.model.StyleState
 
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.
setCursorVisible(boolean) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
setCursorVisible(boolean) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
setDefaultExpose(I) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent
Sets default expose item when component start.
setDefaultStyle(TextStyle) - Method in class org.springframework.shell.test.jediterm.terminal.model.StyleState
 
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.
setDesignation(CharacterSet) - Method in class org.springframework.shell.test.jediterm.terminal.emulator.charset.GraphicSet
Sets the designation of this graphic set.
setEnabled(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.ClearCommand
 
setEnabled(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.CompletionCommand
 
setEnabled(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.Help
 
setEnabled(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.HelpCommand
 
setEnabled(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.History
 
setEnabled(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.HistoryCommand
 
setEnabled(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.Interactive
 
setEnabled(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.Noninteractive
 
setEnabled(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.QuitCommand
 
setEnabled(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.Script
 
setEnabled(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.ScriptCommand
 
setEnabled(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.StacktraceCommand
 
setEnabled(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
setEnabled(Terminal, boolean) - Method in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
setEnv(String) - Method in class org.springframework.shell.boot.SpringShellProperties.Config
 
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
 
setExceptionResolvers(List<CommandExceptionResolver>) - Method in class org.springframework.shell.Shell
 
setExitCodeExceptionProvider(ExitCodeExceptionProvider) - Method in class org.springframework.shell.Shell
 
setGitProperties(GitProperties) - Method in class org.springframework.shell.standard.commands.Version
 
setGL(int) - Method in class org.springframework.shell.test.jediterm.terminal.emulator.charset.GraphicSetState
Selects the graphic set for GL.
setGR(int) - Method in class org.springframework.shell.test.jediterm.terminal.emulator.charset.GraphicSetState
Selects the graphic set for GR.
setGroupingMode(SpringShellProperties.HelpCommand.GroupingMode) - Method in class org.springframework.shell.boot.SpringShellProperties.HelpCommand
 
setHelp(SpringShellProperties.Help) - Method in class org.springframework.shell.boot.SpringShellProperties
 
setHelp(SpringShellProperties.HelpCommand) - Method in class org.springframework.shell.boot.SpringShellProperties.Command
 
setHistory(SpringShellProperties.History) - Method in class org.springframework.shell.boot.SpringShellProperties
 
setHistory(SpringShellProperties.HistoryCommand) - Method in class org.springframework.shell.boot.SpringShellProperties.Command
 
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.
setInteractive(SpringShellProperties.Interactive) - Method in class org.springframework.shell.boot.SpringShellProperties
 
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.
setLocation(String) - Method in class org.springframework.shell.boot.SpringShellProperties.Config
 
setLongNames(String[]) - Method in class org.springframework.shell.boot.SpringShellProperties.Help
 
setMaskCharacter(Character) - Method in class org.springframework.shell.component.StringInput
Sets a mask character for input and result value.
setMaskCharacter(Character) - Method in interface org.springframework.shell.component.StringInput.StringInputContext
Sets a mask character.
setMaxItems(int) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent
Set max items to show.
setMaxPathsSearch(int) - Method in class org.springframework.shell.component.PathSearch.PathSearchConfig
 
setMaxPathsShow(int) - Method in class org.springframework.shell.component.PathSearch.PathSearchConfig
 
setMessage(String) - 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 class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext
 
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
setMessageMethodArgumentResolvers(ShellMethodArgumentResolverComposite) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
Set HandlerMethodArgumentResolvers to use to use for resolving method argument values.
setModeEnabled(TerminalMode, boolean) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
setModeEnabled(TerminalMode, boolean) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
setName(String) - Method in class org.springframework.shell.boot.SpringShellProperties.History
 
setName(String) - Method in class org.springframework.shell.boot.SpringShellProperties.Theme
 
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.
setNaming(SpringShellProperties.OptionNaming) - Method in class org.springframework.shell.boot.SpringShellProperties.Option
 
setNoninteractive(SpringShellProperties.Noninteractive) - Method in class org.springframework.shell.boot.SpringShellProperties
 
setOption(SpringShellProperties.Option) - Method in class org.springframework.shell.boot.SpringShellProperties
 
setOption(TextStyle.Option, boolean) - Method in class org.springframework.shell.test.jediterm.terminal.TextStyle.Builder
 
setOrder(int) - Method in class org.springframework.shell.component.flow.BaseInput
 
setParameterNameDiscoverer(ParameterNameDiscoverer) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
Set the ParameterNameDiscoverer for resolving parameter names when needed (e.g.
setPathProvider(Function<String, Path>) - Method in class org.springframework.shell.component.PathInput
Sets a path provider.
setPathProvider(Function<String, Path>) - Method in class org.springframework.shell.component.PathSearch
Sets a path provider.
setPathScanner(Supplier<BiFunction<String, PathSearch.PathSearchContext, PathSearch.PathScannerResult>>) - Method in class org.springframework.shell.component.PathSearch.PathSearchConfig
 
setPathSearchConfig(PathSearch.PathSearchConfig) - Method in interface org.springframework.shell.component.PathSearch.PathSearchContext
Sets a path search config.
setPathViewItems(List<PathSearch.PathSearchContext.PathViewItem>) - Method in interface org.springframework.shell.component.PathSearch.PathSearchContext
Sets a path view items.
setPrintResults(boolean) - Method in class org.springframework.shell.component.support.AbstractComponent
Sets if results should be printed into a console, Defaults to true.
setQuit(SpringShellProperties.QuitCommand) - Method in class org.springframework.shell.boot.SpringShellProperties.Command
 
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.
setRootCommand(String) - Method in class org.springframework.shell.boot.SpringShellProperties.CompletionCommand
 
setScript(SpringShellProperties.Script) - Method in class org.springframework.shell.boot.SpringShellProperties
 
setScript(SpringShellProperties.ScriptCommand) - Method in class org.springframework.shell.boot.SpringShellProperties.Command
 
setScrollingRegion(int, int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
setScrollingRegion(int, int) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
setSearchCaseSensitive(boolean) - Method in class org.springframework.shell.component.PathSearch.PathSearchConfig
 
setSearchForward(boolean) - Method in class org.springframework.shell.component.PathSearch.PathSearchConfig
 
setSearchNormalize(boolean) - Method in class org.springframework.shell.component.PathSearch.PathSearchConfig
 
setShell(Shell) - Method in class org.springframework.shell.boot.CompleterAutoConfiguration.CompleterAdapter
 
setShortNames(Character[]) - Method in class org.springframework.shell.boot.SpringShellProperties.Help
 
setShowBuildArtifact(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
setShowBuildArtifact(boolean) - Method in class org.springframework.shell.standard.commands.Version
 
setShowBuildGroup(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
setShowBuildGroup(boolean) - Method in class org.springframework.shell.standard.commands.Version
 
setShowBuildName(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
setShowBuildName(boolean) - Method in class org.springframework.shell.standard.commands.Version
 
setShowBuildTime(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
setShowBuildTime(boolean) - Method in class org.springframework.shell.standard.commands.Version
 
setShowBuildVersion(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
setShowBuildVersion(boolean) - Method in class org.springframework.shell.standard.commands.Version
 
setShowGitBranch(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
setShowGitBranch(boolean) - Method in class org.springframework.shell.standard.commands.Version
 
setShowGitCommitId(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
setShowGitCommitId(boolean) - Method in class org.springframework.shell.standard.commands.Version
 
setShowGitCommitTime(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
setShowGitCommitTime(boolean) - Method in class org.springframework.shell.standard.commands.Version
 
setShowGitShortCommitId(boolean) - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
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.
setStacktrace(SpringShellProperties.StacktraceCommand) - Method in class org.springframework.shell.boot.SpringShellProperties.Command
 
setTabStop(int) - Method in interface org.springframework.shell.test.jediterm.terminal.model.Tabulator
Sets the tab stop to the given position.
setTabStopAtCursor() - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
setTabStopAtCursor() - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
setTemplate(String) - Method in class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
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.
setTerminalHeight(int) - Method in class org.springframework.shell.test.autoconfigure.SpringShellTestProperties
 
setTerminalOutput(TerminalOutputStream) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
setTerminalOutput(TerminalOutputStream) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
setTerminalPanelListener(TerminalPanelListener) - Method in class org.springframework.shell.test.jediterm.terminal.ui.JediTermWidget
 
setTerminalPanelListener(TerminalPanelListener) - Method in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
setTerminalPanelListener(TerminalPanelListener) - Method in interface org.springframework.shell.test.jediterm.terminal.ui.TerminalWidget
 
setTerminalStarter(TerminalStarter) - Method in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
setTerminalWidth(int) - Method in class org.springframework.shell.test.autoconfigure.SpringShellTestProperties
 
setTerminalWidth(Integer) - Method in class org.springframework.shell.component.context.BaseComponentContext
 
setTerminalWidth(Integer) - Method in interface org.springframework.shell.component.context.ComponentContext
Set terminal width.
setTheme(SpringShellProperties.Theme) - Method in class org.springframework.shell.boot.SpringShellProperties
 
setTtyConnector(TtyConnector) - Method in class org.springframework.shell.test.jediterm.terminal.ui.JediTermWidget
 
setValidator(Validator) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
 
setValidatorFactory(ValidatorFactory) - Method in class org.springframework.shell.Shell
 
setVersion(SpringShellProperties.VersionCommand) - Method in class org.springframework.shell.boot.SpringShellProperties.Command
 
setWindowTitle(String) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
setWindowTitle(String) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
setWindowTitle(String) - Method in interface org.springframework.shell.test.jediterm.terminal.TerminalDisplay
 
setWindowTitle(String) - Method in class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
setWrapped(boolean) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine
 
setX(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
setX(int) - Method in interface org.springframework.shell.test.jediterm.terminal.ui.TerminalCoordinates
 
setY(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
setY(int) - Method in interface org.springframework.shell.test.jediterm.terminal.ui.TerminalCoordinates
 
shell(ResultHandlerService, CommandCatalog, Terminal, ShellConversionServiceSupplier, ShellContext, ExitCodeMappings) - Method in class org.springframework.shell.boot.SpringShellAutoConfiguration
 
Shell - Class in org.springframework.shell
Main class implementing a shell loop.
Shell(ResultHandlerService, CommandCatalog, Terminal, ShellContext, ExitCodeMappings) - Constructor for class org.springframework.shell.Shell
 
ShellApplicationRunner - Interface in org.springframework.shell
Marker interface for a main spring shell ApplicationRunner.
ShellAssertions - Class in org.springframework.shell.test
Entry point for assertion methods for shell components.
ShellAssertions() - Constructor for class org.springframework.shell.test.ShellAssertions
 
ShellAutoConfiguration - Class in org.springframework.shell.test.autoconfigure
 
ShellAutoConfiguration() - Constructor for class org.springframework.shell.test.autoconfigure.ShellAutoConfiguration
 
ShellAutoConfiguration.TerminalStreams - Class in org.springframework.shell.test.autoconfigure
 
ShellCommandGroup - Annotation Interface in org.springframework.shell.standard
Used to indicate the default group of shell commands, either at the package or class level.
shellCommonComponentFlowCustomizer(ObjectProvider<Terminal>, ObjectProvider<ResourceLoader>, ObjectProvider<TemplateExecutor>) - Method in class org.springframework.shell.boot.ComponentFlowAutoConfiguration.ComponentFlowConfiguration
 
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.
shellContext() - Method in class org.springframework.shell.boot.ShellContextAutoConfiguration
 
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.
ShellContextAutoConfiguration - Class in org.springframework.shell.boot
 
ShellContextAutoConfiguration() - Constructor for class org.springframework.shell.boot.ShellContextAutoConfiguration
 
shellConversionServiceSupplier(ApplicationContext) - Method in class org.springframework.shell.boot.SpringShellAutoConfiguration
 
ShellConversionServiceSupplier - Interface in org.springframework.shell.config
Interface to provide shell spesific ConversionService.
shellExitCodeExceptionMapper() - Method in class org.springframework.shell.boot.ExitCodeAutoConfiguration
 
shellExitCodeMappingsExceptionMapper() - Method in class org.springframework.shell.boot.ExitCodeAutoConfiguration
 
ShellMethod - Annotation Interface in org.springframework.shell.standard
Used to mark a method as invokable via Spring Shell.
ShellMethodArgumentResolverComposite - Class in org.springframework.shell.command.invocation
Resolves method parameters by delegating to a list of registered HandlerMethodArgumentResolvers.
ShellMethodArgumentResolverComposite() - Constructor for class org.springframework.shell.command.invocation.ShellMethodArgumentResolverComposite
 
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
 
ShellRunner - Interface in org.springframework.shell
Interface for shell runners.
ShellRunnerAutoConfiguration - Class in org.springframework.shell.boot
 
ShellRunnerAutoConfiguration(Shell, PromptProvider, LineReader, Parser, ShellContext) - Constructor for class org.springframework.shell.boot.ShellRunnerAutoConfiguration
 
ShellRunnerTaskData(ShellRunner, ApplicationArguments, AtomicInteger) - Constructor for record class org.springframework.shell.test.ShellTestClient.ShellRunnerTaskData
Creates an instance of a ShellRunnerTaskData record class.
ShellScreen - Interface in org.springframework.shell.test
Interface representing a shell screen.
SHELLSCREEN - Static variable in class org.springframework.shell.test.ShellAssertions
Instance of a assert factory for ShellScreen.
ShellScreen.DefaultShellScreen - Class in org.springframework.shell.test
 
ShellScreenAssert - Class in org.springframework.shell.test
Asserts for ShellScreen.
ShellScreenAssert(ShellScreen) - Constructor for class org.springframework.shell.test.ShellScreenAssert
 
ShellTest - Annotation Interface in org.springframework.shell.test.autoconfigure
Annotation that can be used for a Shell test that focuses only on Shell components.
ShellTestClient - Interface in org.springframework.shell.test
Client for terminal session which can be used as a programmatic way to interact with a shell application.
ShellTestClient.BaseShellSession<T extends ShellTestClient.BaseShellSession<T>> - Interface in org.springframework.shell.test
 
ShellTestClient.Builder - Interface in org.springframework.shell.test
Builder interface for ShellClient.
ShellTestClient.DefaultBuilder - Class in org.springframework.shell.test
 
ShellTestClient.DefaultInteractiveShellSession - Class in org.springframework.shell.test
 
ShellTestClient.DefaultNonInteractiveShellSession - Class in org.springframework.shell.test
 
ShellTestClient.DefaultShellClient - Class in org.springframework.shell.test
 
ShellTestClient.InteractiveShellSession - Interface in org.springframework.shell.test
 
ShellTestClient.NonInteractiveShellSession - Interface in org.springframework.shell.test
 
ShellTestClient.ShellRunnerTask - Class in org.springframework.shell.test
 
ShellTestClient.ShellRunnerTaskData - Record Class in org.springframework.shell.test
 
ShellTestClientAutoConfiguration - Class in org.springframework.shell.test.autoconfigure
 
ShellTestClientAutoConfiguration() - Constructor for class org.springframework.shell.test.autoconfigure.ShellTestClientAutoConfiguration
 
ShellTestContextBootstrapper - Class in org.springframework.shell.test.autoconfigure
TestContextBootstrapper for @ShellTest support.
ShellTestContextBootstrapper() - Constructor for class org.springframework.shell.test.autoconfigure.ShellTestContextBootstrapper
 
shellThemeResolver(ThemeRegistry, SpringShellProperties, ThemeActive) - Method in class org.springframework.shell.boot.ThemingAutoConfiguration
 
ShellTypeExcludeFilter - Class in org.springframework.shell.test.autoconfigure
TypeExcludeFilter for @ShellTest.
ShellWriteSequence - Interface in org.springframework.shell.test
Interface sequencing various things into terminal aware text types.
ShellWriteSequence.DefaultShellWriteSequence - Class in org.springframework.shell.test
 
shortNames() - Element in annotation interface org.springframework.shell.command.annotation.Option
Short names of an option.
shortNames(Character...) - Method in class org.springframework.shell.command.CommandRegistration.DefaultHelpOptionsSpec
 
shortNames(Character...) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
shortNames(Character...) - Method in interface org.springframework.shell.command.CommandRegistration.HelpOptionsSpec
Sets short names options for help.
shortNames(Character...) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec
Define short option names.
SHOWING - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel.TerminalCursorState
 
SI - Static variable in class org.springframework.shell.test.jediterm.typeahead.Ascii
Shift In: A control character indicating that the code combinations which follow shall be interpreted according to the standard code table.
SimpleHorizontalAligner - Enum Class in org.springframework.shell.table
An horizontal alignment strategy that allows alignment to the left, center or right.
SimpleVerticalAligner - Enum Class in org.springframework.shell.table
Alignment strategy that allows simple vertical alignment to top, middle or bottom.
SingleItemSelector<T,I extends Nameable & Matchable & Enableable & Selectable & 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
SingleItemSelectorSpec - Interface in org.springframework.shell.component.flow
Interface for single item selector spec builder.
singleShiftSelect(int) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
singleShiftSelect(int) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
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.
sizeUpdated(int, int, int, int) - Method in interface org.springframework.shell.test.jediterm.terminal.model.JediTerminal.ResizeHandler
 
SmoothScroll - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
SNAKE - Enum constant in enum class org.springframework.shell.boot.SpringShellProperties.OptionNamingCase
 
SNAKECASE - Static variable in class org.springframework.shell.command.support.OptionNameModifierSupport
 
SO - Static variable in class org.springframework.shell.test.jediterm.typeahead.Ascii
Shift Out: A control character indicating that the code combinations which follow shall be interpreted as outside of the character set of the standard code table until a Shift In character is reached.
sort(Comparator<SelectorItem<String>>) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
sort(Comparator<SelectorItem<String>>) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
sort(Comparator<SelectorItem<String>>) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec
Sets a Comparator for sorting items.
sort(Comparator<SelectorItem<String>>) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec
Sets a Comparator for sorting items.
space() - Method in class org.springframework.shell.test.ShellWriteSequence.DefaultShellWriteSequence
 
space() - Method in interface org.springframework.shell.test.ShellWriteSequence
Sequence terminal space.
SPANISH - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSet
 
split(T[], Predicate<T>) - Static method in class org.springframework.shell.Utils
Split array into list of lists by predicate
SpringShellAutoConfiguration - Class in org.springframework.shell.boot
Creates supporting beans for running the Shell
SpringShellAutoConfiguration() - Constructor for class org.springframework.shell.boot.SpringShellAutoConfiguration
 
SpringShellProperties - Class in org.springframework.shell.boot
Configuration properties for shell.
SpringShellProperties() - Constructor for class org.springframework.shell.boot.SpringShellProperties
 
SpringShellProperties.ClearCommand - Class in org.springframework.shell.boot
 
SpringShellProperties.Command - Class in org.springframework.shell.boot
 
SpringShellProperties.CompletionCommand - Class in org.springframework.shell.boot
 
SpringShellProperties.Config - Class in org.springframework.shell.boot
 
SpringShellProperties.Help - Class in org.springframework.shell.boot
 
SpringShellProperties.HelpCommand - Class in org.springframework.shell.boot
 
SpringShellProperties.HelpCommand.GroupingMode - Enum Class in org.springframework.shell.boot
 
SpringShellProperties.History - Class in org.springframework.shell.boot
 
SpringShellProperties.HistoryCommand - Class in org.springframework.shell.boot
 
SpringShellProperties.Interactive - Class in org.springframework.shell.boot
 
SpringShellProperties.Noninteractive - Class in org.springframework.shell.boot
 
SpringShellProperties.Option - Class in org.springframework.shell.boot
 
SpringShellProperties.OptionNaming - Class in org.springframework.shell.boot
 
SpringShellProperties.OptionNamingCase - Enum Class in org.springframework.shell.boot
 
SpringShellProperties.QuitCommand - Class in org.springframework.shell.boot
 
SpringShellProperties.Script - Class in org.springframework.shell.boot
 
SpringShellProperties.ScriptCommand - Class in org.springframework.shell.boot
 
SpringShellProperties.StacktraceCommand - Class in org.springframework.shell.boot
 
SpringShellProperties.Theme - Class in org.springframework.shell.boot
 
SpringShellProperties.VersionCommand - Class in org.springframework.shell.boot
 
SpringShellTestProperties - Class in org.springframework.shell.test.autoconfigure
Configuration properties for shell test.
SpringShellTestProperties() - Constructor for class org.springframework.shell.test.autoconfigure.SpringShellTestProperties
 
stacktrace() - Method in class org.springframework.shell.standard.commands.Stacktrace
 
stacktrace(ObjectProvider<ThrowableResultHandler>) - Method in class org.springframework.shell.boot.StandardCommandsAutoConfiguration
 
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.
StacktraceCommand() - Constructor for class org.springframework.shell.boot.SpringShellProperties.StacktraceCommand
 
StandardAPIAutoConfiguration - Class in org.springframework.shell.boot
Sets up all required beans for supporting the standard Shell API.
StandardAPIAutoConfiguration() - Constructor for class org.springframework.shell.boot.StandardAPIAutoConfiguration
 
StandardCommandsAutoConfiguration - Class in org.springframework.shell.boot
Creates beans for standard commands.
StandardCommandsAutoConfiguration() - Constructor for class org.springframework.shell.boot.StandardCommandsAutoConfiguration
 
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
 
standardMethodTargetResolver(ApplicationContext, CommandRegistration.BuilderSupplier) - Method in class org.springframework.shell.boot.StandardAPIAutoConfiguration
 
start() - Method in class org.springframework.shell.test.jediterm.terminal.TerminalStarter
 
start() - Method in class org.springframework.shell.test.jediterm.terminal.ui.JediTermWidget
 
start() - Method in interface org.springframework.shell.test.jediterm.terminal.ui.TerminalSession
 
startsWithMoreMark() - Method in class org.springframework.shell.test.jediterm.terminal.emulator.ControlSequence
 
startsWithQuestionMark() - Method in class org.springframework.shell.test.jediterm.terminal.emulator.ControlSequence
 
state() - Method in record class org.springframework.shell.test.ShellTestClient.ShellRunnerTaskData
Returns the value of the state record component.
status() - Method in exception org.springframework.shell.ExitRequest
The exit code to be returned when the process exits.
STEADY_BLOCK - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.CursorShape
 
STEADY_UNDERLINE - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.CursorShape
 
STEADY_VERTICAL_BAR - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.CursorShape
 
stop() - Method in class org.springframework.shell.test.jediterm.terminal.ui.JediTermWidget
 
StoreCursor - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
StoredCursor - Class in org.springframework.shell.test.jediterm.terminal.model
 
StoredCursor(int, int, TextStyle, boolean, boolean, GraphicSetState) - Constructor for class org.springframework.shell.test.jediterm.terminal.model.StoredCursor
 
storeResult(boolean) - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
storeResult(boolean) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
storeResult(boolean) - Method in class org.springframework.shell.component.flow.BasePathInput
 
storeResult(boolean) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
storeResult(boolean) - Method in class org.springframework.shell.component.flow.BaseStringInput
 
storeResult(boolean) - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec
Automatically stores result from a ConfirmationInput.ConfirmationInputContext into ComponentContext with key given to builder.
storeResult(boolean) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec
Automatically stores result from a MultiItemSelector.MultiItemSelectorContext into ComponentContext with key given to builder.
storeResult(boolean) - Method in interface org.springframework.shell.component.flow.PathInputSpec
Automatically stores result from a StringInput.StringInputContext into ComponentContext with key given to builder.
storeResult(boolean) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec
Automatically stores result from a SingleItemSelector.SingleItemSelectorContext into ComponentContext with key given to builder.
storeResult(boolean) - Method in interface org.springframework.shell.component.flow.StringInputSpec
Automatically stores result from a StringInput.StringInputContext into ComponentContext with key given to builder.
stream() - Method in class org.springframework.shell.component.context.BaseComponentContext
 
stream() - Method in interface org.springframework.shell.component.context.ComponentContext
Stream key/value pairs from this 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
 
StringInputSpec - Interface in org.springframework.shell.component.flow
Interface for string input spec builder.
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
 
StyledTextConsumer - Interface in org.springframework.shell.test.jediterm.terminal
General interface that obtains styled range of characters at coordinates (x, y) when the screen starts at startRow
StyledTextConsumerAdapter - Class in org.springframework.shell.test.jediterm.terminal
 
StyledTextConsumerAdapter() - Constructor for class org.springframework.shell.test.jediterm.terminal.StyledTextConsumerAdapter
 
styles() - Method in class org.springframework.shell.style.ThemeSettings
StyleSettings - Class in org.springframework.shell.style
Base class defining a settings for styles.
StyleSettings() - Constructor for class org.springframework.shell.style.StyleSettings
 
StyleState - Class in org.springframework.shell.test.jediterm.terminal.model
 
StyleState() - Constructor for class org.springframework.shell.test.jediterm.terminal.model.StyleState
 
subBuffer(int, int) - Method in class org.springframework.shell.test.jediterm.terminal.model.CharBuffer
 
subBuffer(Pair<Integer, Integer>) - Method in class org.springframework.shell.test.jediterm.terminal.model.CharBuffer
 
SubCharBuffer - Class in org.springframework.shell.test.jediterm.terminal.model
 
SubCharBuffer(CharBuffer, int, int) - Constructor for class org.springframework.shell.test.jediterm.terminal.model.SubCharBuffer
 
subSequence(int, int) - Method in class org.springframework.shell.test.jediterm.terminal.model.CharBuffer
 
supportsParameter(MethodParameter) - Method in class org.springframework.shell.command.annotation.support.OptionMethodArgumentResolver
 
supportsParameter(MethodParameter) - Method in class org.springframework.shell.command.ArgumentHeaderMethodArgumentResolver
 
supportsParameter(MethodParameter) - Method in class org.springframework.shell.command.CommandContextMethodArgumentResolver
 
supportsParameter(MethodParameter) - Method in class org.springframework.shell.command.CommandExecution.ParamNameHandlerMethodArgumentResolver
 
supportsParameter(MethodParameter) - Method in class org.springframework.shell.command.invocation.ShellMethodArgumentResolverComposite
Whether the given method parameter is supported by any registered HandlerMethodArgumentResolver.
supportsParameter(MethodParameter) - Method in class org.springframework.shell.standard.ShellOptionMethodArgumentResolver
 
SWEDISH - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSet
 
SWISS - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSet
 

T

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
 
Tabulator - Interface in org.springframework.shell.test.jediterm.terminal.model
Provides a tabulator that keeps track of the tab stops of a terminal.
TAG_CHECKBOX_OFF - Static variable in class org.springframework.shell.style.FigureSettings
Figure used as a checkbox for off position.
TAG_CHECKBOX_ON - Static variable in class org.springframework.shell.style.FigureSettings
Figure used as a checkbox for on position.
TAG_DOWNWARDS_ARROR - Static variable in class org.springframework.shell.style.FigureSettings
Figure for down arrow.
TAG_ERROR - Static variable in class org.springframework.shell.style.FigureSettings
Figure indicating something about on a level of error.
TAG_HIGHLIGHT - Static variable in class org.springframework.shell.style.StyleSettings
Styling for something which is highlighted.
TAG_INFO - Static variable in class org.springframework.shell.style.FigureSettings
Figure indicating something about on a level of info.
TAG_ITEM_DISABLED - Static variable in class org.springframework.shell.style.StyleSettings
Styling for something i.e.
TAG_ITEM_ENABLED - Static variable in class org.springframework.shell.style.StyleSettings
Styling for something i.e.
TAG_ITEM_SELECTED - Static variable in class org.springframework.shell.style.StyleSettings
Styling for something i.e.
TAG_ITEM_SELECTOR - Static variable in class org.springframework.shell.style.StyleSettings
Styling for selector i.e.
TAG_ITEM_UNSELECTED - Static variable in class org.springframework.shell.style.StyleSettings
Styling for something i.e.
TAG_LEFT_POINTING_QUOTATION - Static variable in class org.springframework.shell.style.FigureSettings
Figure used as indicator pointing left.
TAG_LEFTWARDS_ARROR - Static variable in class org.springframework.shell.style.FigureSettings
Figure for left arrow.
TAG_LEVEL_ERROR - Static variable in class org.springframework.shell.style.StyleSettings
Styling for some arbitrary content indicating ERROR level.
TAG_LEVEL_INFO - Static variable in class org.springframework.shell.style.StyleSettings
Styling for some arbitrary content indicating INFO level.
TAG_LEVEL_WARN - Static variable in class org.springframework.shell.style.StyleSettings
Styling for some arbitrary content indicating WARN level.
TAG_LIST_KEY - Static variable in class org.springframework.shell.style.StyleSettings
Styling for keys or names in a lists: : list value1 : list value2
TAG_LIST_VALUE - Static variable in class org.springframework.shell.style.StyleSettings
Styling for keys or names in a lists: list key1 : list key2 :
TAG_QUESTION_MARK - Static variable in class org.springframework.shell.style.FigureSettings
Figure meant for question.
TAG_RIGHT_POINTING_QUOTATION - Static variable in class org.springframework.shell.style.FigureSettings
Figure used as indicator pointing left.
TAG_RIGHTWARDS_ARROR - Static variable in class org.springframework.shell.style.FigureSettings
Figure for right arrow.
TAG_TICK - Static variable in class org.springframework.shell.style.FigureSettings
Figure meant to be used as ok like a checkmark.
TAG_TITLE - Static variable in class org.springframework.shell.style.StyleSettings
Represents some arbitrary title.
TAG_UPWARDS_ARROR - Static variable in class org.springframework.shell.style.FigureSettings
Figure for up arrow.
TAG_VALUE - Static variable in class org.springframework.shell.style.StyleSettings
Represents some arbitrary value.
TAG_WARNING - Static variable in class org.springframework.shell.style.FigureSettings
Figure indicating something about on a level of warning.
tags() - Static method in class org.springframework.shell.style.FigureSettings
 
tags() - Static method in class org.springframework.shell.style.StyleSettings
Gets all tags.
template(String) - Method in class org.springframework.shell.component.flow.BaseConfirmationInput
 
template(String) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector
 
template(String) - Method in class org.springframework.shell.component.flow.BasePathInput
 
template(String) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector
 
template(String) - Method in class org.springframework.shell.component.flow.BaseStringInput
 
template(String) - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec
Sets a default renderer template location.
template(String) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec
Sets a default renderer template location.
template(String) - Method in interface org.springframework.shell.component.flow.PathInputSpec
Sets a default renderer template location.
template(String) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec
Sets a default renderer template location.
template(String) - Method in interface org.springframework.shell.component.flow.StringInputSpec
Sets a default renderer template location.
templateExecutor(TemplateExecutor) - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder
 
templateExecutor(TemplateExecutor) - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder
templateExecutor(ThemeResolver) - Method in class org.springframework.shell.boot.ThemingAutoConfiguration
 
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
 
terminal(Terminal) - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder
 
terminal(Terminal) - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder
Sets a Terminal.
terminal(ObjectProvider<TerminalCustomizer>) - Method in class org.springframework.shell.boot.JLineShellAutoConfiguration
 
Terminal - Interface in org.springframework.shell.test.jediterm.terminal
Executes terminal commands interpreted by Emulator, receives text
TerminalAstNode - Class in org.springframework.shell.command.parser
Terminal node means that it is end of ast tree branch.
TerminalAstNode(Token) - Constructor for class org.springframework.shell.command.parser.TerminalAstNode
 
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
 
TerminalCoordinates - Interface in org.springframework.shell.test.jediterm.terminal.ui
 
TerminalCopyPasteHandler - Interface in org.springframework.shell.test.jediterm.terminal
 
TerminalCustomizer - Interface in org.springframework.shell.boot
Callback interface that can be used to customize a Terminal via its TerminalBuilder.
TerminalDataStream - Interface in org.springframework.shell.test.jediterm.terminal
Represents data communication interface for terminal.
TerminalDataStream.EOF - Exception in org.springframework.shell.test.jediterm.terminal
 
TerminalDisplay - Interface in org.springframework.shell.test.jediterm.terminal
 
terminalHeight() - Element in annotation interface org.springframework.shell.test.autoconfigure.ShellTest
Set emulated terminal height.
TerminalLine - Class in org.springframework.shell.test.jediterm.terminal.model
 
TerminalLine() - Constructor for class org.springframework.shell.test.jediterm.terminal.model.TerminalLine
 
TerminalLine(TerminalLine.TextEntry) - Constructor for class org.springframework.shell.test.jediterm.terminal.model.TerminalLine
 
TerminalLine.TextEntry - Class in org.springframework.shell.test.jediterm.terminal.model
 
TerminalLineIntervalHighlighting - Class in org.springframework.shell.test.jediterm.terminal.model
 
TerminalMode - Enum Class in org.springframework.shell.test.jediterm.terminal
 
TerminalModelListener - Interface in org.springframework.shell.test.jediterm.terminal.model
 
terminalNodes() - Method in record class org.springframework.shell.command.parser.Ast.AstResult
Returns the value of the terminalNodes record component.
TerminalOutputStream - Interface in org.springframework.shell.test.jediterm.terminal
Sends a response from the terminal emulator.
TerminalPanel - Class in org.springframework.shell.test.jediterm.terminal.ui
 
TerminalPanel(TerminalTextBuffer, StyleState) - Constructor for class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel
 
TerminalPanel.TerminalCursorState - Enum Class in org.springframework.shell.test.jediterm.terminal.ui
 
TerminalPanelListener - Interface in org.springframework.shell.test.jediterm.terminal.ui
 
TerminalSession - Interface in org.springframework.shell.test.jediterm.terminal.ui
 
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
A ResultHandler that prints TerminalSizeAware according to the Terminal size.
TerminalSizeAwareResultHandler(Terminal) - Constructor for class org.springframework.shell.result.TerminalSizeAwareResultHandler
 
TerminalStarter - Class in org.springframework.shell.test.jediterm.terminal
Runs terminal emulator.
TerminalStarter(Terminal, TtyConnector, TerminalDataStream) - Constructor for class org.springframework.shell.test.jediterm.terminal.TerminalStarter
 
TerminalStreams() - Constructor for class org.springframework.shell.test.autoconfigure.ShellAutoConfiguration.TerminalStreams
 
TerminalTextBuffer - Class in org.springframework.shell.test.jediterm.terminal.model
Buffer for storing styled text data.
TerminalTextBuffer(int, int, StyleState) - Constructor for class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
TerminalTextBuffer(int, int, StyleState, int) - Constructor for class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
TerminalTypeAheadSettings - Class in org.springframework.shell.test.jediterm.terminal.model
 
TerminalTypeAheadSettings(boolean, long, TextStyle) - Constructor for class org.springframework.shell.test.jediterm.terminal.model.TerminalTypeAheadSettings
 
TerminalWidget - Interface in org.springframework.shell.test.jediterm.terminal.ui
 
terminalWidth() - Element in annotation interface org.springframework.shell.test.autoconfigure.ShellTest
Set emulated terminal width.
text() - Method in interface org.springframework.shell.result.CommandNotFoundMessageProvider.ProviderContext
Gets a raw input text.
text(String) - Method in class org.springframework.shell.test.ShellWriteSequence.DefaultShellWriteSequence
 
text(String) - Method in interface org.springframework.shell.test.ShellWriteSequence
Sequence text.
TextEntry(TextStyle, CharBuffer) - Constructor for class org.springframework.shell.test.jediterm.terminal.model.TerminalLine.TextEntry
 
TextStyle - Class in org.springframework.shell.test.jediterm.terminal
 
TextStyle() - Constructor for class org.springframework.shell.test.jediterm.terminal.TextStyle
 
TextStyle(EnumSet<TextStyle.Option>) - Constructor for class org.springframework.shell.test.jediterm.terminal.TextStyle
 
TextStyle.Builder - Class in org.springframework.shell.test.jediterm.terminal
 
TextStyle.Option - Enum Class in org.springframework.shell.test.jediterm.terminal
 
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.
Theme() - Constructor for class org.springframework.shell.boot.SpringShellProperties.Theme
 
themeActive() - Method in class org.springframework.shell.boot.ThemingAutoConfiguration
 
ThemeActive - Interface in org.springframework.shell.style
 
themeRegistry(ObjectProvider<Theme>) - Method in class org.springframework.shell.boot.ThemingAutoConfiguration
 
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
Base class defining a settings for themes.
ThemeSettings() - Constructor for class org.springframework.shell.style.ThemeSettings
Creates theme settings with dump styles and figures.
ThemeSettings(StyleSettings, FigureSettings) - Constructor for class org.springframework.shell.style.ThemeSettings
Creates theme settings with styles and figures.
ThemingAutoConfiguration - Class in org.springframework.shell.boot
 
ThemingAutoConfiguration() - Constructor for class org.springframework.shell.boot.ThemingAutoConfiguration
 
throwableResultHandler(Terminal, CommandCatalog, ShellContext, ObjectProvider<InteractiveShellRunner>) - Method in class org.springframework.shell.result.ResultHandlerConfig
 
ThrowableResultHandler - Class in org.springframework.shell.result
A ResultHandler that prints thrown exceptions messages in red.
ThrowableResultHandler(Terminal, CommandCatalog, ShellContext, ObjectProvider<InteractiveShellRunner>) - Constructor for class org.springframework.shell.result.ThrowableResultHandler
 
tick() - Method in class org.springframework.shell.style.FigureSettings
 
title() - Method in class org.springframework.shell.style.StyleSettings
 
toBottomRight() - Method in class org.springframework.shell.table.TableBuilder.BorderStub.TopLeft
 
toBuilder() - Method in class org.springframework.shell.test.jediterm.terminal.TextStyle
 
toCamelCase(String) - Static method in class org.springframework.shell.command.support.OptionNameModifierSupport
Convert given name to camelCase.
toHumanReadableText(String) - Static method in class org.springframework.shell.test.jediterm.terminal.util.CharUtils
 
toKebabCase(String) - Static method in class org.springframework.shell.command.support.OptionNameModifierSupport
Convert given name to kebab-case.
Token - Class in org.springframework.shell.command.parser
 
Token(String, TokenType) - Constructor for class org.springframework.shell.command.parser.Token
 
Token(String, TokenType, int) - Constructor for class org.springframework.shell.command.parser.Token
 
tokenize(List<String>) - Method in class org.springframework.shell.command.parser.Lexer.DefaultLexer
 
tokenize(List<String>) - Method in interface org.springframework.shell.command.parser.Lexer
Tokenize given command line arguments into a list of tokens.
tokens() - Method in record class org.springframework.shell.command.parser.Lexer.LexerResult
Returns the value of the tokens record component.
TokenType - Enum Class in org.springframework.shell.command.parser
 
TOO_MANY_OPTION_ARGUMENTS - Enum constant in enum class org.springframework.shell.command.parser.ParserMessage
 
top - Enum constant in enum class org.springframework.shell.table.SimpleVerticalAligner
 
TOP - Static variable in class org.springframework.shell.table.BorderSpecification
 
toPascalCase(String) - Static method in class org.springframework.shell.command.support.OptionNameModifierSupport
Convert given name to PascalCase.
toRowColumn(int, int) - Method in class org.springframework.shell.table.TableBuilder.BorderStub.TopLeft
 
toSnakeCase(String) - Static method in class org.springframework.shell.command.support.OptionNameModifierSupport
Convert given name to snake_case.
toString() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
 
toString() - Method in record class org.springframework.shell.command.parser.Ast.AstResult
Returns a string representation of this record class.
toString() - Method in class org.springframework.shell.command.parser.CommandNode
 
toString() - Method in record class org.springframework.shell.command.parser.DirectiveResult
Returns a string representation of this record class.
toString() - Method in record class org.springframework.shell.command.parser.Lexer.LexerResult
Returns a string representation of this record class.
toString() - Method in record class org.springframework.shell.command.parser.MessageResult
Returns a string representation of this record class.
toString() - Method in class org.springframework.shell.command.parser.OptionNode
 
toString() - Method in record class org.springframework.shell.command.parser.Parser.ParseResult.ArgumentResult
Returns a string representation of this record class.
toString() - Method in record class org.springframework.shell.command.parser.Parser.ParseResult.OptionResult
Returns a string representation of this record class.
toString() - Method in record class org.springframework.shell.command.parser.Parser.ParseResult
Returns a string representation of this record class.
toString() - Method in class org.springframework.shell.command.parser.Token
 
toString() - Method in class org.springframework.shell.CompletionProposal
 
toString() - Method in class org.springframework.shell.component.context.BaseComponentContext
 
toString() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext
 
toString() - Method in class org.springframework.shell.table.BorderSpecification
 
toString() - Method in class org.springframework.shell.test.jediterm.terminal.emulator.ControlSequence
 
toString() - Method in class org.springframework.shell.test.jediterm.terminal.model.CharBuffer
 
toString() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine.TextEntry
 
toString() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine
 
toString() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLineIntervalHighlighting
 
toString() - Method in class org.springframework.shell.test.jediterm.terminal.TtyBasedArrayDataStream
 
toString() - Method in class org.springframework.shell.test.jediterm.terminal.util.Pair
 
toString() - Method in record class org.springframework.shell.test.ShellTestClient.ShellRunnerTaskData
Returns a string representation of this record class.
toString(String, String, Locale) - Method in class org.springframework.shell.style.StringToStyleExpressionRenderer
 
toString(PartsText, String, Locale) - Method in class org.springframework.shell.style.PartsTextRenderer
 
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
 
trimTrailing(String) - Static method in class org.springframework.shell.test.jediterm.terminal.util.Util
 
tryLock() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
TtyBasedArrayDataStream - Class in org.springframework.shell.test.jediterm.terminal
Takes data from and sends it back to TTY input and output streams via TtyConnector
TtyBasedArrayDataStream(TtyConnector) - Constructor for class org.springframework.shell.test.jediterm.terminal.TtyBasedArrayDataStream
 
TtyBasedArrayDataStream(TtyConnector, Runnable) - Constructor for class org.springframework.shell.test.jediterm.terminal.TtyBasedArrayDataStream
 
TtyConnector - Interface in org.springframework.shell.test.jediterm.terminal
Interface to tty.
type(Type) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
type(Type) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec
Define a type for an option.
type(ResolvableType) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec
 
type(ResolvableType) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec
Define a ResolvableType for an option.

U

UIUtil - Class in org.springframework.shell.test.jediterm.terminal.ui
 
UIUtil() - Constructor for class org.springframework.shell.test.jediterm.terminal.ui.UIUtil
 
unavailable(String) - Static method in class org.springframework.shell.Availability
 
unCamelify(CharSequence) - Static method in class org.springframework.shell.Utils
Turn CamelCaseText into gnu-style-lowercase.
UNDERLINED - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TextStyle.Option
 
unlock() - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
unNullify() - Method in class org.springframework.shell.test.jediterm.terminal.model.CharBuffer
 
UNRECOGNISED_OPTION - Enum constant in enum class org.springframework.shell.command.parser.ParserMessage
 
unregister(String...) - Method in class org.springframework.shell.command.CommandCatalog.DefaultCommandCatalog
 
unregister(String...) - Method in interface org.springframework.shell.command.CommandCatalog
Unregister a CommandRegistration by its command name.
unregister(CommandRegistration...) - Method in class org.springframework.shell.command.CommandCatalog.DefaultCommandCatalog
 
unregister(CommandRegistration...) - Method in interface org.springframework.shell.command.CommandCatalog
Unregister a CommandRegistration.
UNRESOLVED - Static variable in class org.springframework.shell.Shell
Marker object to distinguish unresolved arguments from null, which is a valid value.
unsupported(char...) - Method in class org.springframework.shell.test.jediterm.terminal.emulator.JediEmulator
This method is used to handle unknown sequences.
upToCursor() - Method in class org.springframework.shell.CompletionContext
 
upwardsArrow() - Method in class org.springframework.shell.style.FigureSettings
 
US - Static variable in class org.springframework.shell.test.jediterm.typeahead.Ascii
Unit Separator: These four information separators may be used within data in optional fashion, except that their hierarchical relationship shall be: FS is the most inclusive, then GS, then RS, and US is least inclusive.
useAlternateBuffer(boolean) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
useAlternateBuffer(boolean) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
useAlternateBuffer(boolean) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
useDefaultFilters() - Element in annotation interface org.springframework.shell.test.autoconfigure.ShellTest
Determines if default filtering should be used with @SpringBootApplication.
User - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.RequestOrigin
 
UserConfigAutoConfiguration - Class in org.springframework.shell.boot
 
UserConfigAutoConfiguration() - Constructor for class org.springframework.shell.boot.UserConfigAutoConfiguration
 
userConfigPathProvider(SpringShellProperties) - Method in class org.springframework.shell.boot.UserConfigAutoConfiguration
 
UserConfigPathProvider - Interface in org.springframework.shell.config
Interface providing a Path to a location where user level runtime configuration files are strored.
usesWords(int...) - Method in class org.springframework.shell.ValueResultAsserts
 
usesWordsForValue(int...) - Method in class org.springframework.shell.ValueResultAsserts
 
Util - Class in org.springframework.shell.test.jediterm.terminal.util
 
Util() - Constructor for class org.springframework.shell.test.jediterm.terminal.util.Util
 
Utils - Class in org.springframework.shell
Some text utilities.
Utils() - Constructor for class org.springframework.shell.Utils
 

V

value() - Element in annotation interface org.springframework.shell.command.annotation.CommandScan
Alias for the CommandScan.basePackages() attribute.
value() - Element in annotation interface org.springframework.shell.command.annotation.EnableCommand
Defines candicate classes for shell commands.
value() - Element in annotation interface org.springframework.shell.command.annotation.ExceptionResolver
Exceptions handled by the annotated method.
value() - Element in annotation interface org.springframework.shell.command.annotation.ExitCode
Exit code value.
value() - Method in interface org.springframework.shell.command.CommandParser.CommandParserResult
Gets the value.
value() - Method in class org.springframework.shell.command.CommandParser.DefaultCommandParserResult
 
value() - Method in record class org.springframework.shell.command.parser.DirectiveResult
Returns the value of the value record component.
value() - Method in record class org.springframework.shell.command.parser.Parser.ParseResult.ArgumentResult
Returns the value of the value record component.
value() - Method in record class org.springframework.shell.command.parser.Parser.ParseResult.OptionResult
Returns the value of the value record component.
value() - Method in class org.springframework.shell.CompletionProposal
 
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.
value() - Method in class org.springframework.shell.style.StyleSettings
 
value(String) - Method in class org.springframework.shell.CompletionProposal
 
valueOf(char) - Static method in enum class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSet
Returns the CharacterSet for the given character.
valueOf(String) - Static method in enum class org.springframework.shell.boot.SpringShellProperties.HelpCommand.GroupingMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.shell.boot.SpringShellProperties.OptionNamingCase
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.shell.command.CommandRegistration.OptionArity
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.shell.command.CommandRegistration.TargetInfo.TargetType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.shell.command.parser.ParserConfig.Feature
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.shell.command.parser.ParserMessage.Type
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.shell.command.parser.ParserMessage
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.shell.command.parser.TokenType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.shell.component.flow.ResultMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext.MessageLevel
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.shell.context.InteractionMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.shell.table.BorderStyle
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.shell.table.SimpleHorizontalAligner
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.shell.table.SimpleVerticalAligner
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.shell.test.jediterm.terminal.CursorShape
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSet
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.shell.test.jediterm.terminal.RequestOrigin
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.shell.test.jediterm.terminal.TextStyle.Option
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel.TerminalCursorState
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.shell.test.jediterm.terminal.util.CharUtils.CharacterType
Returns the enum constant of this class with the specified name.
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.
ValueResult - Class in org.springframework.shell
A result for a successful resolve operation.
ValueResult(MethodParameter, Object) - Constructor for class org.springframework.shell.ValueResult
 
ValueResult(MethodParameter, Object, BitSet, BitSet) - Constructor for class org.springframework.shell.ValueResult
 
ValueResultAsserts - Class in org.springframework.shell
Assertions for ValueResult.
ValueResultAsserts(ValueResult) - Constructor for class org.springframework.shell.ValueResultAsserts
 
values() - Static method in enum class org.springframework.shell.boot.SpringShellProperties.HelpCommand.GroupingMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.shell.boot.SpringShellProperties.OptionNamingCase
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.shell.command.CommandRegistration.OptionArity
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.shell.command.CommandRegistration.TargetInfo.TargetType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.shell.command.parser.ParserConfig.Feature
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.shell.command.parser.ParserMessage.Type
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.shell.command.parser.ParserMessage
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.shell.command.parser.TokenType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.shell.component.flow.ResultMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext.MessageLevel
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.shell.context.InteractionMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.shell.table.BorderStyle
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.shell.table.SimpleHorizontalAligner
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.shell.table.SimpleVerticalAligner
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.shell.test.jediterm.terminal.CursorShape
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.shell.test.jediterm.terminal.emulator.charset.CharacterSet
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.shell.test.jediterm.terminal.RequestOrigin
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.shell.test.jediterm.terminal.TextStyle.Option
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.shell.test.jediterm.terminal.ui.TerminalPanel.TerminalCursorState
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.springframework.shell.test.jediterm.terminal.util.CharUtils.CharacterType
Returns an array containing the constants of this enum class, in the order they are declared.
VERIFY - Enum constant in enum class org.springframework.shell.component.flow.ResultMode
Verify a given resultValue with a component run.
version() - Method in class org.springframework.shell.standard.commands.Version
 
version(SpringShellProperties, ObjectProvider<BuildProperties>, ObjectProvider<GitProperties>, ObjectProvider<TemplateExecutor>) - Method in class org.springframework.shell.boot.StandardCommandsAutoConfiguration
 
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.
VersionCommand() - Constructor for class org.springframework.shell.boot.SpringShellProperties.VersionCommand
 
verticalGlyph() - Method in enum class org.springframework.shell.table.BorderStyle
 
visit(List<NonterminalAstNode>, List<TerminalAstNode>) - Method in class org.springframework.shell.command.parser.AbstractNodeVisitor
 
visit(List<NonterminalAstNode>, List<TerminalAstNode>) - Method in interface org.springframework.shell.command.parser.NodeVisitor
Visit lists of non terminal and terminal nodes.
VT - Static variable in class org.springframework.shell.test.jediterm.typeahead.Ascii
Vertical Tabulation ('\v'): A format effector which controls the movement of the printing position to the next in a series of predetermined printing lines.
VT102_RESPONSE - Static variable in class org.springframework.shell.test.jediterm.terminal.util.CharUtils
 

W

waitFor() - Method in interface org.springframework.shell.test.jediterm.terminal.TtyConnector
 
WARN - Enum constant in enum class org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext.MessageLevel
 
warning() - Method in class org.springframework.shell.style.FigureSettings
 
WARNING - Enum constant in enum class org.springframework.shell.command.parser.ParserMessage.Type
 
WideColumn - Enum constant in enum class org.springframework.shell.test.jediterm.terminal.TerminalMode
 
width(String[], int, int) - Method in class org.springframework.shell.table.AbsoluteWidthSizeConstraints
 
width(String[], int, int) - Method in class org.springframework.shell.table.AutoSizeConstraints
 
width(String[], int, int) - Method in class org.springframework.shell.table.KeyValueSizeConstraints
 
width(String[], int, int) - Method in class org.springframework.shell.table.NoWrapSizeConstraints
 
width(String[], int, int) - Method in interface org.springframework.shell.table.SizeConstraints
 
withAlias() - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder
 
withAlias() - Method in interface org.springframework.shell.command.CommandRegistration.Builder
Define an alias what this command should execute
withConfirmationInput(String) - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder
 
withConfirmationInput(String) - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder
Gets a builder for confirmation input.
withErrorHandling() - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder
 
withErrorHandling() - Method in interface org.springframework.shell.command.CommandRegistration.Builder
Define an error handling what this command should use
withExitCode() - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder
 
withExitCode() - Method in interface org.springframework.shell.command.CommandRegistration.Builder
Define an exit code what this command should execute
withHelpOptions() - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder
 
withHelpOptions() - Method in interface org.springframework.shell.command.CommandRegistration.Builder
Define help options what this command should use.
withMultiItemSelector(String) - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder
 
withMultiItemSelector(String) - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder
Gets a builder for multi item selector.
withOption() - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder
 
withOption() - Method in interface org.springframework.shell.command.CommandRegistration.Builder
Define an option what this command should user for.
withPathInput(String) - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder
 
withPathInput(String) - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder
Gets a builder for path input.
withSingleItemSelector(String) - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder
 
withSingleItemSelector(String) - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder
Gets a builder for single item selector.
withStringInput(String) - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder
 
withStringInput(String) - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder
Gets a builder for string input.
withTarget() - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder
 
withTarget() - Method in interface org.springframework.shell.command.CommandRegistration.Builder
Define a target what this command should execute
word() - Method in class org.springframework.shell.jline.ExtendedDefaultParser.ExtendedArgumentList
 
wordCursor() - Method in class org.springframework.shell.jline.ExtendedDefaultParser.ExtendedArgumentList
 
wordIndex() - Method in class org.springframework.shell.jline.ExtendedDefaultParser.ExtendedArgumentList
 
words() - Method in interface org.springframework.shell.Input
Return the input as a list of parsed "words", having split the raw input according to parsing rules (for example, handling quoted portions of the readInput as a single "word")
words() - Method in class org.springframework.shell.jline.ExtendedDefaultParser.ExtendedArgumentList
 
wordsUsed() - Method in class org.springframework.shell.ValueResult
Represents the full set of words used to resolve the MethodParameter.
wordsUsed(List<String>) - Method in class org.springframework.shell.ValueResult
 
wordsUsedForValue() - Method in class org.springframework.shell.ValueResult
Represents the full set of words used to resolve the value of this MethodParameter.
wordsUsedForValue(List<String>) - Method in class org.springframework.shell.ValueResult
 
wrap(String[], int) - Method in class org.springframework.shell.table.DebugTextWrapper
 
wrap(String[], int) - Method in class org.springframework.shell.table.DelimiterTextWrapper
 
wrap(String[], int) - Method in class org.springframework.shell.table.KeyValueTextWrapper
 
wrap(String[], int) - Method in interface org.springframework.shell.table.TextWrapper
 
write(byte[]) - Method in interface org.springframework.shell.test.jediterm.terminal.TtyConnector
 
write(String) - Method in interface org.springframework.shell.test.jediterm.terminal.TtyConnector
 
write(String) - Method in interface org.springframework.shell.test.ShellTestClient.BaseShellSession
Write plain text into a shell.
write(String) - Method in class org.springframework.shell.test.ShellTestClient.DefaultInteractiveShellSession
 
write(String) - Method in class org.springframework.shell.test.ShellTestClient.DefaultNonInteractiveShellSession
 
writeCharacters(String) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
writeCharacters(String) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
writeDoubleByte(char[]) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
writeDoubleByte(char[]) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 
writeSequence() - Method in interface org.springframework.shell.test.ShellTestClient.BaseShellSession
Get a write sequencer.
writeSequence() - Method in class org.springframework.shell.test.ShellTestClient.DefaultInteractiveShellSession
 
writeSequence() - Method in class org.springframework.shell.test.ShellTestClient.DefaultNonInteractiveShellSession
 
writeString(int, int, CharBuffer) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalTextBuffer
 
writeString(int, int, CharBuffer, TextStyle) - Method in class org.springframework.shell.test.jediterm.terminal.model.LinesBuffer
 
writeString(int, CharBuffer, TextStyle) - Method in class org.springframework.shell.test.jediterm.terminal.model.TerminalLine
 
writeString(String) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
writeUnwrappedString(String) - Method in class org.springframework.shell.test.jediterm.terminal.model.JediTerminal
 
writeUnwrappedString(String) - Method in interface org.springframework.shell.test.jediterm.terminal.Terminal
 

Z

ZERO - Enum constant in enum class org.springframework.shell.command.CommandRegistration.OptionArity
Define min(0), max(0).
ZERO_OR_MORE - Enum constant in enum class org.springframework.shell.command.CommandRegistration.OptionArity
Define min(0), max(MAXINTEGER).
ZERO_OR_ONE - Enum constant in enum class org.springframework.shell.command.CommandRegistration.OptionArity
Define min(0), max(1).

_

_OS_NAME - Static variable in class org.springframework.shell.test.jediterm.terminal.ui.UIUtil
 
A B C D E F G H I J K L M N O P Q R S T U V W Z _ 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form