Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- a - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- A - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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 aBeanFactory
. - AbstractArgumentMethodArgumentResolver.NamedValueInfo - Class in org.springframework.shell.support
-
Represents a named value declaration.
- AbstractCell<T> - Class in org.springframework.shell.component.view.control.cell
-
Base implementation of a
Cell
. - AbstractCell(T) - Constructor for class org.springframework.shell.component.view.control.cell.AbstractCell
- 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
- AbstractControl - Class in org.springframework.shell.component.view.control
-
Base implementation of a
Control
. - AbstractControl() - Constructor for class org.springframework.shell.component.view.control.AbstractControl
- AbstractListCell<T> - Class in org.springframework.shell.component.view.control.cell
-
Base implementation of a
ListCell
. - AbstractListCell(T) - Constructor for class org.springframework.shell.component.view.control.cell.AbstractListCell
- AbstractListCell(T, ListView.ItemStyle) - Constructor for class org.springframework.shell.component.view.control.cell.AbstractListCell
- 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 -
Base implementation of a
AbstractSelectorComponent.SelectorComponentContext
. - 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.
- AbstractTextCell<T> - Class in org.springframework.shell.component.view.control.cell
-
Base implementation of a
TextCell
. - AbstractTextCell(T, Function<T, String>) - Constructor for class org.springframework.shell.component.view.control.cell.AbstractTextCell
- AbstractTextCell(T, Function<T, String>, HorizontalAlign, VerticalAlign) - Constructor for class org.springframework.shell.component.view.control.cell.AbstractTextCell
- 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.
- AbstractView - Class in org.springframework.shell.component.view.control
- AbstractView() - Constructor for class org.springframework.shell.component.view.control.AbstractView
- 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. - ACCEPT - Static variable in class org.springframework.shell.component.view.control.ViewCommand
-
Accepts a current state.
- addItem(View, int, int, int, int, int, int) - Method in class org.springframework.shell.component.view.control.GridView
-
Adds a
View
and its position to the grid. - 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.
- alias() - Element in annotation interface org.springframework.shell.command.annotation.Command
-
Define alias as an array.
- 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.
- Alt - Static variable in class org.springframework.shell.component.view.event.MouseEvent.Modifier
- AltMask - Static variable in class org.springframework.shell.component.view.event.KeyEvent.KeyMask
- Ampersand - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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.
- AnimationEventLoopProcessor - Class in org.springframework.shell.component.view.event.processor
-
EventLoop.EventLoopProcessor
converting incoming message into animation tick messages. - AnimationEventLoopProcessor() - Constructor for class org.springframework.shell.component.view.event.processor.AnimationEventLoopProcessor
- ANTIQUEWHITE - Static variable in class org.springframework.shell.component.view.screen.Color
- ANTIQUEWHITE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- ANTIQUEWHITE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- ANTIQUEWHITE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- ANTIQUEWHITE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- apply(CompletionContext) - Method in class org.springframework.shell.completion.RegistrationOptionsCompletionResolver
- AppView - Class in org.springframework.shell.component.view.control
-
AppView
provides an opinionated terminal UI application view controlling main viewing area, menubar, statusbar and modal window system. - AppView(View, View, View) - Constructor for class org.springframework.shell.component.view.control.AppView
- AppView.AppViewEvent - Record Class in org.springframework.shell.component.view.control
-
ViewEvent
indicating direction for a next selection. - AppView.AppViewEventArgs - Record Class in org.springframework.shell.component.view.control
- AppView.AppViewEventArgs.Direction - Enum Class in org.springframework.shell.component.view.control
-
Direction where next selection should go.
- AppViewEvent(View, AppView.AppViewEventArgs) - Constructor for record class org.springframework.shell.component.view.control.AppView.AppViewEvent
-
Creates an instance of a
AppViewEvent
record class. - AppViewEventArgs(AppView.AppViewEventArgs.Direction) - Constructor for record class org.springframework.shell.component.view.control.AppView.AppViewEventArgs
-
Creates an instance of a
AppViewEventArgs
record class. - AQUAMARINE - Static variable in class org.springframework.shell.component.view.screen.Color
- AQUAMARINE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- AQUAMARINE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- AQUAMARINE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- AQUAMARINE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- args() - Method in record class org.springframework.shell.component.view.control.AppView.AppViewEvent
-
Returns the value of the
args
record component. - args() - Method in record class org.springframework.shell.component.view.control.ButtonView.ButtonViewSelectEvent
-
Returns the value of the
args
record component. - args() - Method in record class org.springframework.shell.component.view.control.DialogView.DialogViewCloseEvent
-
Returns the value of the
args
record component. - args() - Method in record class org.springframework.shell.component.view.control.InputView.InputViewTextChangeEvent
-
Returns the value of the
args
record component. - args() - Method in record class org.springframework.shell.component.view.control.ListView.ListViewOpenSelectedItemEvent
-
Returns the value of the
args
record component. - args() - Method in record class org.springframework.shell.component.view.control.ListView.ListViewSelectedItemChangedEvent
-
Returns the value of the
args
record component. - args() - Method in record class org.springframework.shell.component.view.control.MenuView.MenuViewOpenSelectedItemEvent
-
Returns the value of the
args
record component. - args() - Method in record class org.springframework.shell.component.view.control.MenuView.MenuViewSelectedItemChangedEvent
-
Returns the value of the
args
record component. - args() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewEndEvent
-
Returns the value of the
args
record component. - args() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewStartEvent
-
Returns the value of the
args
record component. - args() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewStateChangeEvent
-
Returns the value of the
args
record component. - args() - Method in record class org.springframework.shell.component.view.control.StatusBarView.StatusBarViewOpenSelectedItemEvent
-
Returns the value of the
args
record component. - args() - Method in record class org.springframework.shell.component.view.control.ViewDoneEvent.GenericViewDoneEvent
-
Returns the value of the
args
record component. - args() - Method in interface org.springframework.shell.component.view.control.ViewEvent
- argsOf(KeyEvent) - Static method in interface org.springframework.shell.component.view.event.KeyHandler
-
Construct
KeyHandler.KeyHandlerArgs
from aKeyEvent
. - argsOf(MouseEvent) - Static method in interface org.springframework.shell.component.view.event.MouseHandler
-
Construct
MouseHandler.MouseHandlerArgs
from aMouseEvent
. - 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(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. - 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.
- 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.
- 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
- Asterisk - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- AstNode - Class in org.springframework.shell.command.parser
-
Represents a node in an
abstract syntax tree
and knows aboutToken
. - 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. - 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'sAttributedCharSequence
. - AttributedCharSequenceResultHandler(Terminal) - Constructor for class org.springframework.shell.result.AttributedCharSequenceResultHandler
- 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 typeAvailability
from a target which is a class. - AvailabilityReflectiveProcessor() - Constructor for class org.springframework.shell.AvailabilityReflectiveProcessor
- available() - Static method in class org.springframework.shell.Availability
- await() - Method in interface org.springframework.shell.component.ViewComponent.ViewComponentRun
-
Await component termination.
- AZURE - Static variable in class org.springframework.shell.component.view.screen.Color
- AZURE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- AZURE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- AZURE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- AZURE4 - Static variable in class org.springframework.shell.component.view.screen.Color
B
- b - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- B - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- background() - Method in class org.springframework.shell.style.StyleSettings
- background() - Method in record class org.springframework.shell.style.ThemeResolver.ResolvedValues
-
Returns the value of the
background
record component. - background(Rectangle, int) - Method in interface org.springframework.shell.component.view.screen.Screen.Writer
-
Fill background with a given color.
- Backspace - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- Backtab - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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
- bindAll(KeyMap<Integer>) - Method in class org.springframework.shell.component.view.event.KeyBinder
- 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
- BISQUE - Static variable in class org.springframework.shell.component.view.screen.Color
- BISQUE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- BISQUE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- BISQUE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- BISQUE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- BLACK - Static variable in class org.springframework.shell.component.view.screen.Color
- BLUE - Static variable in class org.springframework.shell.component.view.screen.Color
- BLUE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- BLUE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- BLUE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- BLUE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- border(int, int, int, int) - Method in interface org.springframework.shell.component.view.screen.Screen.Writer
-
Write a border with a given rectangle coordinates.
- BORDER_BOTTOM - Static variable in interface org.springframework.shell.component.view.screen.ScreenItem
- BORDER_LEFT - Static variable in interface org.springframework.shell.component.view.screen.ScreenItem
- BORDER_RIGHT - Static variable in interface org.springframework.shell.component.view.screen.ScreenItem
- BORDER_TOP - Static variable in interface org.springframework.shell.component.view.screen.ScreenItem
- BOTTOM - Enum constant in enum class org.springframework.shell.geom.VerticalAlign
- BoxView - Class in org.springframework.shell.component.view.control
-
BoxView
is aView
with an empty background and optional border and title. - BoxView() - Constructor for class org.springframework.shell.component.view.control.BoxView
- BraceLeft - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- BraceRight - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- BROWN - Static variable in class org.springframework.shell.component.view.screen.Color
- BROWN1 - Static variable in class org.springframework.shell.component.view.screen.Color
- BROWN2 - Static variable in class org.springframework.shell.component.view.screen.Color
- BROWN3 - Static variable in class org.springframework.shell.component.view.screen.Color
- BROWN4 - Static variable in class org.springframework.shell.component.view.screen.Color
- build() - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder
- build() - Method in interface org.springframework.shell.command.CommandRegistration.Builder
-
Builds a
CommandRegistration
. - 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 class org.springframework.shell.component.message.ShellMessageBuilder
- build() - Method in interface org.springframework.shell.component.view.screen.Screen.WriterBuilder
-
Build a
Screen.Writer
. - build() - Method in class org.springframework.shell.component.view.TerminalUIBuilder
-
Build a new
TerminalUI
instance and configure it using this builder. - 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(View) - Method in class org.springframework.shell.component.ViewComponentBuilder
-
Build a new
ViewComponent
instance and configure it using this builder. - 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() - Static method in interface org.springframework.shell.support.search.SearchMatch
-
Gets an instance of a builder for a
SearchMatch
. - 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
- BURLYWOOD - Static variable in class org.springframework.shell.component.view.screen.Color
- BURLYWOOD1 - Static variable in class org.springframework.shell.component.view.screen.Color
- BURLYWOOD2 - Static variable in class org.springframework.shell.component.view.screen.Color
- BURLYWOOD3 - Static variable in class org.springframework.shell.component.view.screen.Color
- BURLYWOOD4 - Static variable in class org.springframework.shell.component.view.screen.Color
- Button() - Constructor for class org.springframework.shell.component.view.event.MouseEvent.Button
- Button1 - Static variable in class org.springframework.shell.component.view.event.MouseEvent.Button
- Button2 - Static variable in class org.springframework.shell.component.view.event.MouseEvent.Button
- Button3 - Static variable in class org.springframework.shell.component.view.event.MouseEvent.Button
- buttonBackground() - Method in class org.springframework.shell.style.StyleSettings
- ButtonMask - Static variable in class org.springframework.shell.component.view.event.MouseEvent.MouseMask
- ButtonView - Class in org.springframework.shell.component.view.control
-
ButtonView
is aView
with border and text acting as a button. - ButtonView() - Constructor for class org.springframework.shell.component.view.control.ButtonView
- ButtonView(String) - Constructor for class org.springframework.shell.component.view.control.ButtonView
- ButtonView(String, Runnable) - Constructor for class org.springframework.shell.component.view.control.ButtonView
- ButtonView.ButtonViewItemEventArgs - Record Class in org.springframework.shell.component.view.control
- ButtonView.ButtonViewSelectEvent - Record Class in org.springframework.shell.component.view.control
- ButtonViewItemEventArgs() - Constructor for record class org.springframework.shell.component.view.control.ButtonView.ButtonViewItemEventArgs
-
Creates an instance of a
ButtonViewItemEventArgs
record class. - ButtonViewSelectEvent(View, ButtonView.ButtonViewItemEventArgs) - Constructor for record class org.springframework.shell.component.view.control.ButtonView.ButtonViewSelectEvent
-
Creates an instance of a
ButtonViewSelectEvent
record class.
C
- c - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- C - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- CADETBLUE - Static variable in class org.springframework.shell.component.view.screen.Color
- CADETBLUE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- CADETBLUE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- CADETBLUE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- CADETBLUE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- CAMELCASE - Static variable in class org.springframework.shell.command.support.OptionNameModifierSupport
- cancel() - Method in interface org.springframework.shell.component.ViewComponent.ViewComponentRun
-
Cancel component run.
- canProcess(Message<?>) - Method in interface org.springframework.shell.component.view.event.EventLoop.EventLoopProcessor
-
Checks if this processor can process an event.
- canProcess(Message<?>) - Method in class org.springframework.shell.component.view.event.processor.AnimationEventLoopProcessor
- canProcess(Message<?>) - Method in class org.springframework.shell.component.view.event.processor.TaskEventLoopProcessor
- canRun(ApplicationArguments) - Method in interface org.springframework.shell.ShellRunner
-
Deprecated, for removal: This API element is subject to removal in a future version.
- capture() - Method in record class org.springframework.shell.component.view.event.KeyHandler.KeyHandlerResult
-
Returns the value of the
capture
record component. - capture() - Method in record class org.springframework.shell.component.view.event.MouseHandler.MouseHandlerResult
-
Returns the value of the
capture
record component. - 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
- Cell<T> - Interface in org.springframework.shell.component.view.control.cell
-
Base interface for all cells.
- CENTER - Enum constant in enum class org.springframework.shell.geom.HorizontalAlign
- CENTER - Enum constant in enum class org.springframework.shell.geom.VerticalAlign
- Char - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- CharMask - Static variable in class org.springframework.shell.component.view.event.KeyEvent.KeyMask
- CHARTREUSE - Static variable in class org.springframework.shell.component.view.screen.Color
- CHARTREUSE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- CHARTREUSE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- CHARTREUSE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- CHARTREUSE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- checkboxOff() - Method in class org.springframework.shell.style.FigureSettings
- checkboxOn() - Method in class org.springframework.shell.style.FigureSettings
- CHECKED - Enum constant in enum class org.springframework.shell.component.view.control.ListView.ItemStyle
-
The item will indicate checked/un-checked state.
- CHECKED - Enum constant in enum class org.springframework.shell.component.view.control.MenuView.MenuItemCheckStyle
-
The menu item will indicate checked/un-checked state.
- CHOCOLATE - Static variable in class org.springframework.shell.component.view.screen.Color
- CHOCOLATE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- CHOCOLATE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- CHOCOLATE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- CHOCOLATE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- clear() - Method in class org.springframework.shell.command.invocation.ShellMethodArgumentResolverComposite
-
Clear the list of configured resolvers and the resolver cache.
- clearItems() - Method in class org.springframework.shell.component.view.control.GridView
-
Remove all items.
- clip(int, int, int, int) - Method in class org.springframework.shell.component.view.screen.DefaultScreen
- clip(int, int, int, int) - Method in interface org.springframework.shell.component.view.screen.Screen
-
Clip a screen with a given bounds.
- 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.
- close() - Method in class org.springframework.shell.component.ViewComponentExecutor
- close() - Method in class org.springframework.shell.jline.FileInputProvider
- CloseBracket - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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
- Colon - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- color(int) - Method in interface org.springframework.shell.component.view.screen.Screen.WriterBuilder
-
Define a color this
Screen.Writer
operates on. - Color - Class in org.springframework.shell.component.view.screen
- Color() - Constructor for class org.springframework.shell.component.view.screen.Color
- Comma - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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.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 - 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 - Interface in org.springframework.shell.command
-
Interface defining contract to handle existing
CommandRegistration
s. - CommandCatalog.DefaultCommandCatalog - Class in org.springframework.shell.command
-
Default implementation of a
CommandCatalog
. - 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
resolvingCommandContext
. - 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(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
-
Context for
CommandNotFoundResultHandler
. - commandNotFoundResultHandler(Terminal, ObjectProvider<CommandNotFoundMessageProvider>) - Method in class org.springframework.shell.result.ResultHandlerConfig
- CommandNotFoundResultHandler - Class in org.springframework.shell.result
- 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
andCommandScanRegistrar
to register a bean definition(s) for a@Command
class. - CommandRegistrationBeanRegistrar(BeanDefinitionRegistry) - Constructor for class org.springframework.shell.command.annotation.support.CommandRegistrationBeanRegistrar
- 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
. - compareTo(PathSearch.ScoredPath) - Method in class org.springframework.shell.component.PathSearch.ScoredPath
- complete() - Method in class org.springframework.shell.CompletionProposal
- complete(boolean) - Method in class org.springframework.shell.CompletionProposal
- complete(CompletionContext) - Method in class org.springframework.shell.Shell
-
Gather completion proposals given some (incomplete) input the user has already typed in.
- CompletingParsedLine - Interface in org.springframework.shell
-
An extension of
ParsedLine
that, being aware of the quoting and escaping rules of theParser
that produced it, knows if and how a completion candidate should be escaped/quoted. - 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. - 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
- configure(View) - Method in class org.springframework.shell.component.view.TerminalUI
- configure(T) - Method in class org.springframework.shell.component.view.TerminalUIBuilder
-
Configure the provided
TerminalUI
instance using this builder. - 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.
- consumed() - Method in record class org.springframework.shell.component.view.event.KeyHandler.KeyHandlerResult
-
Returns the value of the
consumed
record component. - consumed() - Method in record class org.springframework.shell.component.view.event.MouseHandler.MouseHandlerResult
-
Returns the value of the
consumed
record component. - consumer() - Method in record class org.springframework.shell.component.view.event.KeyBindingConsumerArgs
-
Returns the value of the
consumer
record component. - consumer() - Method in record class org.springframework.shell.component.view.event.MouseBindingConsumerArgs
-
Returns the value of the
consumer
record component. - 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
- contains(int, int) - Method in record class org.springframework.shell.geom.Rectangle
- containsKey(Object) - Method in interface org.springframework.shell.component.context.ComponentContext
-
Check if a context contains a key.
- contextOf(Throwable, List<String>, Map<String, CommandRegistration>, String) - Static method in interface org.springframework.shell.result.CommandNotFoundMessageProvider
- Control - Interface in org.springframework.shell.component.view.control
-
Base interface for all controls.
- Control - Static variable in class org.springframework.shell.component.view.event.MouseEvent.Modifier
- CORAL - Static variable in class org.springframework.shell.component.view.screen.Color
- CORAL1 - Static variable in class org.springframework.shell.component.view.screen.Color
- CORAL2 - Static variable in class org.springframework.shell.component.view.screen.Color
- CORAL3 - Static variable in class org.springframework.shell.component.view.screen.Color
- CORAL4 - Static variable in class org.springframework.shell.component.view.screen.Color
- CORNSILK - Static variable in class org.springframework.shell.component.view.screen.Color
- CORNSILK1 - Static variable in class org.springframework.shell.component.view.screen.Color
- CORNSILK2 - Static variable in class org.springframework.shell.component.view.screen.Color
- CORNSILK3 - Static variable in class org.springframework.shell.component.view.screen.Color
- CORNSILK4 - Static variable in class org.springframework.shell.component.view.screen.Color
- 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 SpringMethodParameter
. - 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.support.AbstractArgumentMethodArgumentResolver
-
Create the
AbstractArgumentMethodArgumentResolver.NamedValueInfo
object for the given method parameter. - 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. - CtrlMask - Static variable in class org.springframework.shell.component.view.event.KeyEvent.KeyMask
- 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
- CursorDown - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- CursorLeft - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- CursorRight - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- CursorUp - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- customize(CommandCatalog) - Method in interface org.springframework.shell.command.CommandCatalogCustomizer
-
Customize a command catalog.
- customize(TerminalUI) - Method in interface org.springframework.shell.component.view.TerminalUICustomizer
-
Callback to customize a
TerminalUI
instance. - customizers(Collection<? extends TerminalUICustomizer>) - Method in class org.springframework.shell.component.view.TerminalUIBuilder
-
Set the
TerminalUICustomizer
that should be applied to theTerminalUI
. - CYAN - Static variable in class org.springframework.shell.component.view.screen.Color
- CYAN1 - Static variable in class org.springframework.shell.component.view.screen.Color
- CYAN2 - Static variable in class org.springframework.shell.component.view.screen.Color
- CYAN3 - Static variable in class org.springframework.shell.component.view.screen.Color
- CYAN4 - Static variable in class org.springframework.shell.component.view.screen.Color
D
- d - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- D - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- DARKGOLDENROD - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKGOLDENROD1 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKGOLDENROD2 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKGOLDENROD3 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKGOLDENROD4 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKOLIVE - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKOLIVE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKOLIVE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKOLIVE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKOLIVE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKORANGE - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKORANGE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKORANGE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKORANGE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKORANGE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKORCHID - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKORCHID1 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKORCHID2 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKORCHID3 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKORCHID4 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKSEAGREEN - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKSEAGREEN1 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKSEAGREEN2 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKSEAGREEN3 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKSEAGREEN4 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKSLATEGRAY - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKSLATEGRAY1 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKSLATEGRAY2 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKSLATEGRAY3 - Static variable in class org.springframework.shell.component.view.screen.Color
- DARKSLATEGRAY4 - Static variable in class org.springframework.shell.component.view.screen.Color
- data() - Method in record class org.springframework.shell.component.view.event.KeyEvent
-
Returns the value of the
data
record component. - DEEPPINK - Static variable in class org.springframework.shell.component.view.screen.Color
- DEEPPINK1 - Static variable in class org.springframework.shell.component.view.screen.Color
- DEEPPINK2 - Static variable in class org.springframework.shell.component.view.screen.Color
- DEEPPINK3 - Static variable in class org.springframework.shell.component.view.screen.Color
- DEEPPINK4 - Static variable in class org.springframework.shell.component.view.screen.Color
- DEEPSKYBLUE - Static variable in class org.springframework.shell.component.view.screen.Color
- DEEPSKYBLUE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- DEEPSKYBLUE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- DEEPSKYBLUE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- DEEPSKYBLUE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- DEFAULT_PRECEDENCE - Static variable in interface org.springframework.shell.command.CommandExceptionResolver
-
Default precedence related use of
Ordered
andOrder
. - 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
- DefaultCommandExecution(List<? extends HandlerMethodArgumentResolver>, Validator, Terminal, ShellContext, 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
- 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
- DefaultEventLoop - Class in org.springframework.shell.component.view.event
-
Default implementation of an
EventLoop
. - DefaultEventLoop() - Constructor for class org.springframework.shell.component.view.event.DefaultEventLoop
- DefaultEventLoop(List<EventLoop.EventLoopProcessor>) - Constructor for class org.springframework.shell.component.view.event.DefaultEventLoop
- DefaultHelpOptionInfo(boolean, String[], Character[], String) - Constructor for class org.springframework.shell.command.CommandRegistration.HelpOptionInfo.DefaultHelpOptionInfo
- 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
- 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.
- 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 theObject.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.SpinnerSettings
- 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.
- DefaultScreen - Class in org.springframework.shell.component.view.screen
-
Default implementation of a
Screen
. - DefaultScreen() - Constructor for class org.springframework.shell.component.view.screen.DefaultScreen
- DefaultScreen(int, int) - Constructor for class org.springframework.shell.component.view.screen.DefaultScreen
- 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 - Class in org.springframework.shell
-
Default
ShellApplicationRunner
which dispatches to the first orderedShellRunner
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
- DefaultShellContext(boolean) - 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(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.
- Delete - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- DELETE_CHAR_LEFT - Static variable in class org.springframework.shell.component.view.control.ViewCommand
-
Deletes the character on the left.
- DELETE_CHAR_RIGHT - Static variable in class org.springframework.shell.component.view.control.ViewCommand
-
Deletes the character on the right.
- 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
- destroy() - Method in class org.springframework.shell.component.view.control.AbstractView
-
Cleans running state of a
View
so that it can be left to get garbage collected. - destroy() - Method in class org.springframework.shell.component.view.event.DefaultEventLoop
- 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.
- dialogBackground() - Method in class org.springframework.shell.style.StyleSettings
- DialogView - Class in org.springframework.shell.component.view.control
-
DialogView
is aView
with border, number of buttons and area for a generic content. - DialogView() - Constructor for class org.springframework.shell.component.view.control.DialogView
- DialogView(View, List<ButtonView>) - Constructor for class org.springframework.shell.component.view.control.DialogView
- DialogView(View, ButtonView...) - Constructor for class org.springframework.shell.component.view.control.DialogView
- DialogView.DialogViewCloseEvent - Record Class in org.springframework.shell.component.view.control
- DialogView.DialogViewItemEventArgs - Record Class in org.springframework.shell.component.view.control
- DialogViewCloseEvent(View, DialogView.DialogViewItemEventArgs) - Constructor for record class org.springframework.shell.component.view.control.DialogView.DialogViewCloseEvent
-
Creates an instance of a
DialogViewCloseEvent
record class. - DialogViewItemEventArgs() - Constructor for record class org.springframework.shell.component.view.control.DialogView.DialogViewItemEventArgs
-
Creates an instance of a
DialogViewItemEventArgs
record class. - Dimension - Record Class in org.springframework.shell.geom
-
Record representing dimensions
width
andheight
. - Dimension(int, int) - Constructor for record class org.springframework.shell.geom.Dimension
-
Creates an instance of a
Dimension
record class. - direction() - Method in record class org.springframework.shell.component.view.control.AppView.AppViewEventArgs
-
Returns the value of the
direction
record component. - 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
andvalue
. - 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. - dispatch(Publisher<? extends Message<?>>) - Method in class org.springframework.shell.component.view.event.DefaultEventLoop
- dispatch(Publisher<? extends Message<?>>) - Method in interface org.springframework.shell.component.view.event.EventLoop
-
Dispatch
Message
s into anEventLoop
from aPublisher
. - dispatch(Message<?>) - Method in class org.springframework.shell.component.view.control.AbstractView
-
Dispatch a
Message
into an event loop. - dispatch(Message<?>) - Method in class org.springframework.shell.component.view.event.DefaultEventLoop
- dispatch(Message<?>) - Method in interface org.springframework.shell.component.view.event.EventLoop
-
Dispatch a
Message
into anEventLoop
. - dispatchKeyRunCommand(KeyEvent, AbstractView.KeyBindingValue) - Method in class org.springframework.shell.component.view.control.AbstractView
- dispatchMouseRunCommand(MouseEvent, AbstractView.MouseBindingValue) - Method in class org.springframework.shell.component.view.control.AbstractView
- dispatchRunnable(Runnable) - Method in class org.springframework.shell.component.view.control.AbstractView
- DisplayLines - Interface in org.springframework.shell.component.view.screen
-
Interface for an implementation which is able to return list of
AttributedString
usually used together withDisplay
. - displayText() - Method in class org.springframework.shell.CompletionProposal
- displayText(String) - Method in class org.springframework.shell.CompletionProposal
- DODGERBLUE - Static variable in class org.springframework.shell.component.view.screen.Color
- DODGERBLUE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- DODGERBLUE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- DODGERBLUE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- DODGERBLUE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- 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.
- Dollar - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- dontQuote() - Method in class org.springframework.shell.CompletionProposal
- dontQuote(boolean) - Method in class org.springframework.shell.CompletionProposal
- dot() - Method in class org.springframework.shell.style.SpinnerSettings
- Dot - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- DOTS1 - Static variable in interface org.springframework.shell.component.view.control.Spinner
- DOTS10 - Static variable in interface org.springframework.shell.component.view.control.Spinner
- DOTS11 - Static variable in interface org.springframework.shell.component.view.control.Spinner
- DOTS12 - Static variable in interface org.springframework.shell.component.view.control.Spinner
- DOTS13 - Static variable in interface org.springframework.shell.component.view.control.Spinner
- DOTS14 - Static variable in interface org.springframework.shell.component.view.control.Spinner
- DOTS2 - Static variable in interface org.springframework.shell.component.view.control.Spinner
- DOTS3 - Static variable in interface org.springframework.shell.component.view.control.Spinner
- DOTS4 - Static variable in interface org.springframework.shell.component.view.control.Spinner
- DOTS5 - Static variable in interface org.springframework.shell.component.view.control.Spinner
- DOTS6 - Static variable in interface org.springframework.shell.component.view.control.Spinner
- DOTS7 - Static variable in interface org.springframework.shell.component.view.control.Spinner
- DOTS8 - Static variable in interface org.springframework.shell.component.view.control.Spinner
- DOTS9 - Static variable in interface org.springframework.shell.component.view.control.Spinner
- DOUBLEDASH - Enum constant in enum class org.springframework.shell.command.parser.TokenType
- DoubleQuote - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- downwardsArror() - Method in class org.springframework.shell.style.FigureSettings
- Dragged - Static variable in class org.springframework.shell.component.view.event.MouseEvent.Type
- draw(Screen) - Method in class org.springframework.shell.component.view.control.AbstractView
-
Calls drawing logic in two stages.
- draw(Screen) - Method in class org.springframework.shell.component.view.control.cell.AbstractCell
- draw(Screen) - Method in interface org.springframework.shell.component.view.control.Control
- drawBackground(Screen) - Method in class org.springframework.shell.component.view.control.AbstractView
-
Internal drawing method for background.
- drawBackground(Screen) - Method in class org.springframework.shell.component.view.control.BoxView
- drawBackground(Screen) - Method in class org.springframework.shell.component.view.control.cell.AbstractCell
- drawBackground(Screen) - Method in class org.springframework.shell.component.view.control.cell.AbstractListCell
- drawBackground(Screen) - Method in class org.springframework.shell.component.view.control.cell.AbstractTextCell
- drawContent(Screen) - Method in class org.springframework.shell.component.view.control.cell.AbstractCell
- drawContent(Screen) - Method in class org.springframework.shell.component.view.control.cell.AbstractListCell
- drawContent(Screen) - Method in class org.springframework.shell.component.view.control.cell.AbstractTextCell
- drawInternal(Screen) - Method in class org.springframework.shell.component.view.control.AbstractView
-
Component internal drawing method.
- drawInternal(Screen) - Method in class org.springframework.shell.component.view.control.AppView
- drawInternal(Screen) - Method in class org.springframework.shell.component.view.control.BoxView
-
Possibly draws a box around this view and title in a box top boundary.
- drawInternal(Screen) - Method in class org.springframework.shell.component.view.control.ButtonView
- drawInternal(Screen) - Method in class org.springframework.shell.component.view.control.DialogView
- drawInternal(Screen) - Method in class org.springframework.shell.component.view.control.GridView
- drawInternal(Screen) - Method in class org.springframework.shell.component.view.control.InputView
- drawInternal(Screen) - Method in class org.springframework.shell.component.view.control.ListView
- drawInternal(Screen) - Method in class org.springframework.shell.component.view.control.MenuBarView
- drawInternal(Screen) - Method in class org.springframework.shell.component.view.control.MenuView
- drawInternal(Screen) - Method in class org.springframework.shell.component.view.control.ProgressView
- drawInternal(Screen) - Method in class org.springframework.shell.component.view.control.StatusBarView
- drawInternal(Screen) - Method in class org.springframework.shell.component.view.control.WindowView
- 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.SpinnerSettings
- 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.
E
- e - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- E - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- Eight - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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
-
Gets an empty
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
-
Creates an empty
MultiItemSelector.MultiItemSelectorContext
. - empty() - Static method in interface org.springframework.shell.component.PathInput.PathInputContext
-
Gets an empty
PathInput.PathInputContext
. - empty() - Static method in interface org.springframework.shell.component.PathSearch.PathSearchContext
-
Gets an empty
PathSearch.PathSearchContext
. - empty() - Static method in interface org.springframework.shell.component.SingleItemSelector.SingleItemSelectorContext
-
Creates an empty
SingleItemSelector.SingleItemSelectorContext
. - empty() - Static method in interface org.springframework.shell.component.StringInput.StringInputContext
-
Gets an empty
StringInput.StringInputContext
. - empty() - Static method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext
-
Creates an empty
AbstractSelectorComponent.SelectorComponentContext
. - empty(Function<C, String>) - Static method in interface org.springframework.shell.component.SingleItemSelector.SingleItemSelectorContext
-
Creates a
SingleItemSelector.SingleItemSelectorContext
. - empty(Function<T, String>) - Static method in interface org.springframework.shell.component.MultiItemSelector.MultiItemSelectorContext
-
Creates an
MultiItemSelector.MultiItemSelectorContext
. - EMPTY - Static variable in interface org.springframework.shell.component.view.control.ViewEventArgs
- EMPTY - Static variable in interface org.springframework.shell.Input
- 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
- Enter - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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 record class org.springframework.shell.component.view.control.AppView.AppViewEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.control.AppView.AppViewEventArgs
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.control.ButtonView.ButtonViewItemEventArgs
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.control.ButtonView.ButtonViewSelectEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.control.DialogView.DialogViewCloseEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.control.DialogView.DialogViewItemEventArgs
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.control.InputView.InputViewTextChangeEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.control.InputView.InputViewTextChangeEventArgs
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.control.ListView.ListViewItemEventArgs
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.control.ListView.ListViewOpenSelectedItemEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.control.ListView.ListViewSelectedItemChangedEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.control.MenuView.MenuViewItemEventArgs
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.control.MenuView.MenuViewOpenSelectedItemEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.control.MenuView.MenuViewSelectedItemChangedEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressState
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewEndEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewStartEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewStateChangeEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewStateEventArgs
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.control.StatusBarView.StatusBarViewItemEventArgs
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.control.StatusBarView.StatusBarViewOpenSelectedItemEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.control.ViewDoneEvent.GenericViewDoneEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.event.KeyBindingConsumerArgs
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.event.KeyEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.event.KeyHandler.KeyHandlerArgs
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.event.KeyHandler.KeyHandlerResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.event.MouseBindingConsumerArgs
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.event.MouseEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.event.MouseHandler.MouseHandlerArgs
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.component.view.event.MouseHandler.MouseHandlerResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.geom.Dimension
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.geom.Position
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.geom.Rectangle
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.springframework.shell.style.ThemeResolver.ResolvedValues
-
Indicates whether some other object is "equal to" this one.
- Equals - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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
- EuroSign - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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.
- event() - Method in record class org.springframework.shell.component.view.event.KeyBindingConsumerArgs
-
Returns the value of the
event
record component. - event() - Method in record class org.springframework.shell.component.view.event.KeyHandler.KeyHandlerArgs
-
Returns the value of the
event
record component. - event() - Method in record class org.springframework.shell.component.view.event.KeyHandler.KeyHandlerResult
-
Returns the value of the
event
record component. - event() - Method in record class org.springframework.shell.component.view.event.MouseBindingConsumerArgs
-
Returns the value of the
event
record component. - event() - Method in record class org.springframework.shell.component.view.event.MouseHandler.MouseHandlerArgs
-
Returns the value of the
event
record component. - event() - Method in record class org.springframework.shell.component.view.event.MouseHandler.MouseHandlerResult
-
Returns the value of the
event
record component. - EVENT_TYPE - Static variable in class org.springframework.shell.component.message.ShellMessageHeaderAccessor
-
Raw source message.
- EventLoop - Interface in org.springframework.shell.component.view.event
-
EventLoop
is a central place where all eventing will be orchestrated for a lifecycle of a component. - EventLoop.EventLoopProcessor - Interface in org.springframework.shell.component.view.event
-
Contract to process event loop messages, possibly translating an event into some other type of event or events.
- EventLoop.Type - Enum Class in org.springframework.shell.component.view.event
-
Type of an events handled by an
EventLoop
. - events() - Method in class org.springframework.shell.component.view.event.DefaultEventLoop
- events() - Method in interface org.springframework.shell.component.view.event.EventLoop
-
Return a
Flux
ofMessage
events. - events(EventLoop.Type, Class<T>) - Method in class org.springframework.shell.component.view.event.DefaultEventLoop
- events(EventLoop.Type, Class<T>) - Method in interface org.springframework.shell.component.view.event.EventLoop
-
Specialisation of
EventLoop.events()
which returns type safe stream filtered by given eventloop message type and message payload class type. - events(EventLoop.Type, ParameterizedTypeReference<T>) - Method in class org.springframework.shell.component.view.event.DefaultEventLoop
- events(EventLoop.Type, ParameterizedTypeReference<T>) - Method in interface org.springframework.shell.component.view.event.EventLoop
-
Specialisation of
EventLoop.events()
which returns type safe stream filtered by given eventloop message type and message payload class type. - 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. - ExclamationMark - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- exit() - Method in class org.springframework.shell.component.ViewComponent
-
Request exit from an execution loop.
- 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.
- 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 createsCompletingParsedLine
. - ExtendedDefaultParser() - Constructor for class org.springframework.shell.jline.ExtendedDefaultParser
- ExtendedDefaultParser.ExtendedArgumentList - Class in org.springframework.shell.jline
-
The result of a delimited buffer.
F
- f - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- F - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- f1 - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- f10 - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- f11 - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- f12 - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- f2 - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- f3 - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- f4 - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- f5 - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- f6 - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- f7 - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- f8 - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- f9 - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- figures() - Method in class org.springframework.shell.style.ThemeSettings
-
Gets a
FigureSettings
. - 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
- findProvidedArgument(MethodParameter, Object...) - Static method in class org.springframework.shell.command.invocation.InvocableShellMethod
- FIREBRICK - Static variable in class org.springframework.shell.component.view.screen.Color
- FIREBRICK1 - Static variable in class org.springframework.shell.component.view.screen.Color
- FIREBRICK2 - Static variable in class org.springframework.shell.component.view.screen.Color
- FIREBRICK3 - Static variable in class org.springframework.shell.component.view.screen.Color
- FIREBRICK4 - Static variable in class org.springframework.shell.component.view.screen.Color
- Five - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- focus() - Method in record class org.springframework.shell.component.view.event.KeyHandler.KeyHandlerResult
-
Returns the value of the
focus
record component. - focus() - Method in record class org.springframework.shell.component.view.event.MouseHandler.MouseHandlerResult
-
Returns the value of the
focus
record component. - focus(View, boolean) - Method in class org.springframework.shell.component.view.control.AbstractView
- focus(View, boolean) - Method in interface org.springframework.shell.component.view.control.View
-
Called when
View
gets or loses a focus. - foreground() - Method in record class org.springframework.shell.style.ThemeResolver.ResolvedValues
-
Returns the value of the
foreground
record component. - 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(boolean, int, Object...) - Method in enum class org.springframework.shell.command.parser.ParserMessage
-
Format message.
- formatMessage(Object...) - Method in enum class org.springframework.shell.command.parser.ParserMessage
-
Format message without code and position parts.
- 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
- Four - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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
- g - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- G - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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.
- 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
- GenericViewDoneEvent(View, ViewEventArgs) - Constructor for record class org.springframework.shell.component.view.control.ViewDoneEvent.GenericViewDoneEvent
-
Creates an instance of a
GenericViewDoneEvent
record class. - 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.
- getAction() - Method in class org.springframework.shell.component.view.control.MenuView.MenuItem
- getAction() - Method in class org.springframework.shell.component.view.control.StatusBarView.StatusItem
- 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.
- 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
- getBackground() - Method in interface org.springframework.shell.component.view.screen.ScreenItem
- getBackgroundColor() - Method in class org.springframework.shell.component.view.control.cell.AbstractCell
- getBackgroundStyle() - Method in class org.springframework.shell.component.view.control.BoxView
- getBackgroundStyle() - Method in class org.springframework.shell.component.view.control.ButtonView
- getBackgroundStyle() - Method in class org.springframework.shell.component.view.control.cell.AbstractListCell
- getBackgroundStyle() - Method in class org.springframework.shell.component.view.control.cell.AbstractTextCell
- getBackgroundStyle() - Method in class org.springframework.shell.component.view.control.DialogView
- getBackgroundStyle() - Method in class org.springframework.shell.component.view.control.MenuBarView
- getBackgroundStyle() - Method in class org.springframework.shell.component.view.control.StatusBarView
- getBackgroundStyle() - Method in class org.springframework.shell.component.view.control.WindowView
- 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.
- getBorder() - Method in interface org.springframework.shell.component.view.screen.ScreenItem
- 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.
- getBuilder() - Method in class org.springframework.shell.component.flow.BaseInput
- getCheckStyle() - Method in class org.springframework.shell.component.view.control.MenuView.MenuItem
-
Gets a check style.
- getChildren() - Method in class org.springframework.shell.command.parser.NonterminalAstNode
- getCode() - Method in enum class org.springframework.shell.command.parser.ParserMessage
- 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
- 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
- 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.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
- 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
- getContent() - Method in interface org.springframework.shell.component.view.screen.ScreenItem
- 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
- getCursorPosition() - Method in class org.springframework.shell.component.view.screen.DefaultScreen
- getCursorPosition() - Method in interface org.springframework.shell.component.view.screen.Screen
-
Gets a cursor position.
- 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.
- 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
- getDescription() - Method in class org.springframework.shell.component.view.control.ProgressView
-
Gets a progress description.
- getDescription() - Method in interface org.springframework.shell.component.view.control.ProgressView.ProgressContext
-
Get a
ProgressView
description. - getDirCount() - Method in class org.springframework.shell.component.PathSearch.PathScannerResult
- getDrawFunction() - Method in class org.springframework.shell.component.view.control.AbstractView
-
Gets a draw function.
- 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.
- getEscapeChars() - Method in class org.springframework.shell.jline.ExtendedDefaultParser
- getEventLoop() - Method in class org.springframework.shell.component.view.control.AbstractView
-
Get an
EventLoop
. - getEventLoop() - Method in class org.springframework.shell.component.view.TerminalUI
-
Gets an
EventLoop
. - getEventLoop() - Method in class org.springframework.shell.component.ViewComponent
-
Gets an
EventLoop
associated with this view component. - getEventType() - Method in class org.springframework.shell.component.message.ShellMessageHeaderAccessor
-
Get a
EventLoop.Type
header if present. - getEventType(Message<?>) - Static method in class org.springframework.shell.component.message.StaticShellMessageHeaderAccessor
-
Get a
EventLoop.Type
header if present. - 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
- getForeground() - Method in interface org.springframework.shell.component.view.screen.ScreenItem
- getForegroundColor() - Method in class org.springframework.shell.component.view.control.cell.AbstractCell
- getFrames() - Method in interface org.springframework.shell.component.view.control.Spinner
-
Gets a frame characters.
- getFunction() - Method in class org.springframework.shell.command.CommandRegistration.TargetInfo.DefaultTargetInfo
- getFunction() - Method in interface org.springframework.shell.command.CommandRegistration.TargetInfo
-
Get the function
- 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
- getHandlerTypes() - Method in interface org.springframework.shell.result.GenericResultHandler
- getHeader(String, Class<T>) - Method in class org.springframework.shell.component.message.ShellMessageHeaderAccessor
- getHelpOption() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration
- getHelpOption() - Method in interface org.springframework.shell.command.CommandRegistration
-
Gets a help option info.
- getHotKey() - Method in class org.springframework.shell.component.view.control.MenuBarView.MenuBarItem
- getHotKey() - Method in class org.springframework.shell.component.view.control.StatusBarView.StatusItem
- getHotKeyBindings() - Method in class org.springframework.shell.component.view.control.AbstractView
-
Get hotkey bindings.
- getHotKeyHandler() - Method in class org.springframework.shell.component.view.control.AbstractView
- getHotKeyHandler() - Method in class org.springframework.shell.component.view.control.AppView
- getHotKeyHandler() - Method in class org.springframework.shell.component.view.control.GridView
- getHotKeyHandler() - Method in interface org.springframework.shell.component.view.control.View
-
Gets a
View
hotkeyKeyHandler
. - getId() - Method in class org.springframework.shell.component.flow.BaseInput
- getId() - Method in class org.springframework.shell.component.flow.ComponentFlow.OrderedInputOperation
- getId(Message<?>) - Static method in class org.springframework.shell.component.message.StaticShellMessageHeaderAccessor
- getIndex() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.ItemState
- getIndicator() - Method in class org.springframework.shell.component.view.control.cell.AbstractListCell
- getInnerRect() - Method in class org.springframework.shell.component.view.control.BoxView
-
Gets an inner rectangle of this view.
- getInnerRect() - Method in class org.springframework.shell.component.view.control.WindowView
-
Gets an inner rectangle of this view.
- 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.
- getInputText() - Method in class org.springframework.shell.component.view.control.InputView
-
Get a current known input text.
- getInteractionMode() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration
- getInteractionMode() - Method in interface org.springframework.shell.command.CommandRegistration
-
Gets an
InteractionMode
. - getInteractionMode() - Method in class org.springframework.shell.context.DefaultShellContext
- getInteractionMode() - Method in interface org.springframework.shell.context.ShellContext
-
Gets an interaction mode.
- getInterval() - Method in interface org.springframework.shell.component.view.control.Spinner
-
Gets an interval which should be used to estimate how often frame should get changed.
- 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
- getItem() - Method in class org.springframework.shell.component.view.control.cell.AbstractCell
- getItem() - Method in interface org.springframework.shell.component.view.control.cell.Cell
-
Get item bound to a cell.
- 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.
- getItems() - Method in class org.springframework.shell.component.view.control.MenuBarView
-
Gets a menubar items.
- getItems() - Method in class org.springframework.shell.component.view.control.MenuBarView.MenuBarItem
- getItems() - Method in class org.springframework.shell.component.view.control.MenuView
-
Gets a menu items.
- getItems() - Method in class org.springframework.shell.component.view.control.MenuView.MenuItem
-
Gets sub menu items.
- getItems() - Method in class org.springframework.shell.component.view.control.StatusBarView
-
Gets a status items.
- getItems() - Method in class org.springframework.shell.component.view.screen.DefaultScreen
- getItems() - Method in interface org.springframework.shell.component.view.screen.Screen
-
Gets a screen 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.
- getItemStyle() - Method in class org.springframework.shell.component.view.control.cell.AbstractListCell
- getItemStyle() - Method in class org.springframework.shell.component.view.control.ListView
- getKeyBindings() - Method in class org.springframework.shell.component.view.control.AbstractView
-
Get key bindings.
- getKeyHandler() - Method in class org.springframework.shell.component.view.control.AbstractView
-
Handles keys by dispatching registered command runnable into an event loop.
- getKeyHandler() - Method in class org.springframework.shell.component.view.control.AppView
- getKeyHandler() - Method in class org.springframework.shell.component.view.control.ButtonView
- getKeyHandler() - Method in class org.springframework.shell.component.view.control.GridView
- getKeyHandler() - Method in class org.springframework.shell.component.view.control.InputView
- getKeyHandler() - Method in class org.springframework.shell.component.view.control.MenuBarView
- getKeyHandler() - Method in interface org.springframework.shell.component.view.control.View
-
Gets a
View
keyKeyHandler
. - 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.
- getLayer() - Method in class org.springframework.shell.component.view.control.AbstractView
- 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.
- getModal() - Method in interface org.springframework.shell.component.view.control.ViewService
-
Gets a current modal view.
- getModal() - Method in class org.springframework.shell.component.view.TerminalUI
- getMouseBindings() - Method in class org.springframework.shell.component.view.control.AbstractView
-
Get mouse bindings.
- getMouseHandler() - Method in class org.springframework.shell.component.view.control.AbstractView
-
Handles mouse events by dispatching registered consumers into an event loop.
- getMouseHandler() - Method in class org.springframework.shell.component.view.control.AppView
- getMouseHandler() - Method in class org.springframework.shell.component.view.control.ButtonView
- getMouseHandler() - Method in class org.springframework.shell.component.view.control.DialogView
- getMouseHandler() - Method in class org.springframework.shell.component.view.control.GridView
- getMouseHandler() - Method in class org.springframework.shell.component.view.control.MenuBarView
- getMouseHandler() - Method in class org.springframework.shell.component.view.control.StatusBarView
- getMouseHandler() - Method in interface org.springframework.shell.component.view.control.View
-
Gets a
View
mouseMouseHandler
. - 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.
- 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
- getOperation() - Method in class org.springframework.shell.component.flow.ComponentFlow.OrderedInputOperation
- 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
- 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.
- getPlainKey() - Method in record class org.springframework.shell.component.view.event.KeyEvent
- 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
- getPreferredDimension() - Method in class org.springframework.shell.component.view.control.ButtonView
- getPreferredDimension() - Method in class org.springframework.shell.component.view.control.MenuView
-
Gets a preferred dimension menu needs to show it's content.
- 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
- getPriority() - Method in class org.springframework.shell.component.message.ShellMessageHeaderAccessor
- getPriority(Message<?>) - Static method in class org.springframework.shell.component.message.StaticShellMessageHeaderAccessor
- 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
- 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.
- getReactorContext() - Method in class org.springframework.shell.component.message.ShellMessageHeaderAccessor
-
Get a
ContextView
header if present. - getReactorContext(Message<?>) - Static method in class org.springframework.shell.component.message.StaticShellMessageHeaderAccessor
-
Get a
ContextView
header if present. - getReason() - Method in class org.springframework.shell.Availability
- getRect() - Method in class org.springframework.shell.component.view.control.AbstractControl
- getRect() - Method in interface org.springframework.shell.component.view.control.Control
-
Gets rectanle of a bounded box for this
View
. - getRegistrations() - Method in class org.springframework.shell.command.CommandCatalog.DefaultCommandCatalog
- getRegistrations() - Method in interface org.springframework.shell.command.CommandCatalog
-
Gets all
CommandRegistration
s 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.
- 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.
- 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
- getScreenItems() - Method in class org.springframework.shell.component.view.screen.DefaultScreen
- getScreenLines() - Method in class org.springframework.shell.component.view.screen.DefaultScreen
- getScreenLines() - Method in interface org.springframework.shell.component.view.screen.DisplayLines
-
Gets a list of screen lines.
- 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
- getSettings() - Method in interface org.springframework.shell.style.Theme
-
Gets a theme settings.
- getShellContext() - Method in class org.springframework.shell.command.CommandContext.DefaultCommandContext
- getShellContext() - Method in interface org.springframework.shell.command.CommandContext
-
Gets a
ShellContext
associated withCommandContext
. - 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.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.
- getSpinner() - Method in interface org.springframework.shell.component.view.control.ProgressView.ProgressContext
-
Gets a
Spinner
frames. - 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.
- getState() - Method in class org.springframework.shell.component.view.control.ProgressView
-
Gets a state of this
ProgressView
. - getState() - Method in interface org.springframework.shell.component.view.control.ProgressView.ProgressContext
-
Get a state of a
ProgressView
. - getStyle() - Method in class org.springframework.shell.component.view.control.cell.AbstractCell
- getStyle() - Method in interface org.springframework.shell.component.view.screen.ScreenItem
- 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
- getTemplateExecutor() - Method in class org.springframework.shell.component.support.AbstractComponent
-
Gets a template executor.
- 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
. - getTerminalWidth() - Method in class org.springframework.shell.component.context.BaseComponentContext
- getTerminalWidth() - Method in interface org.springframework.shell.component.context.ComponentContext
-
Get terminal width.
- getText() - Method in exception org.springframework.shell.CommandNotFound
-
Gets a raw text input.
- getText() - Method in class org.springframework.shell.component.view.control.cell.AbstractListCell
- getText() - Method in class org.springframework.shell.style.PartsText.PartText
- getThemeName() - Method in class org.springframework.shell.component.view.control.AbstractControl
-
Gets a theme name.
- getThemeName() - Method in class org.springframework.shell.component.view.TerminalUI
-
Gets a
theme name
. - getThemeNames() - Method in class org.springframework.shell.style.ThemeRegistry
-
Gets all theme names registered.
- getThemeResolver() - Method in class org.springframework.shell.component.view.control.AbstractControl
-
Gets a
ThemeResolver
. - getThemeResolver() - Method in class org.springframework.shell.component.view.TerminalUI
-
Sets a
ThemeResolver
. - 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.
- getTimestamp(Message<?>) - Static method in class org.springframework.shell.component.message.StaticShellMessageHeaderAccessor
- getTitle() - Method in class org.springframework.shell.component.view.control.MenuBarView.MenuBarItem
- getTitle() - Method in class org.springframework.shell.component.view.control.MenuView.MenuItem
-
Get a
title
. - getTitle() - Method in class org.springframework.shell.component.view.control.StatusBarView.StatusItem
- getToken() - Method in class org.springframework.shell.command.parser.AstNode
- 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
- 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.
- getValues() - Method in interface org.springframework.shell.component.MultiItemSelector.MultiItemSelectorContext
-
Gets a values.
- getView() - Method in class org.springframework.shell.component.message.ShellMessageHeaderAccessor
- getView() - Method in interface org.springframework.shell.component.view.control.ProgressView.ProgressContext
-
Gets an encapsulating owner view.
- getView(Message<?>) - Static method in class org.springframework.shell.component.message.StaticShellMessageHeaderAccessor
- getViewCommands() - Method in class org.springframework.shell.component.view.control.AbstractView
- getViewCommands() - Method in interface org.springframework.shell.component.view.control.View
-
Get supported commands.
- getViewService() - Method in class org.springframework.shell.component.view.control.AbstractView
-
Get a
ViewService
- getViewService() - Method in class org.springframework.shell.component.view.TerminalUI
-
Gets a
ViewService
. - 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
- GOLD - Static variable in class org.springframework.shell.component.view.screen.Color
- GOLD1 - Static variable in class org.springframework.shell.component.view.screen.Color
- GOLD2 - Static variable in class org.springframework.shell.component.view.screen.Color
- GOLD3 - Static variable in class org.springframework.shell.component.view.screen.Color
- GOLD4 - Static variable in class org.springframework.shell.component.view.screen.Color
- GOLDENROD - Static variable in class org.springframework.shell.component.view.screen.Color
- GOLDENROD1 - Static variable in class org.springframework.shell.component.view.screen.Color
- GOLDENROD2 - Static variable in class org.springframework.shell.component.view.screen.Color
- GOLDENROD3 - Static variable in class org.springframework.shell.component.view.screen.Color
- GOLDENROD4 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREEN - Static variable in class org.springframework.shell.component.view.screen.Color
- GREEN1 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREEN2 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREEN3 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREEN4 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY0 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY100 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY11 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY15 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY19 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY23 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY27 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY3 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY30 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY35 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY37 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY39 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY42 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY46 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY50 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY53 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY54 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY58 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY62 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY63 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY66 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY69 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY7 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY70 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY74 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY78 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY82 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY84 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY85 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY89 - Static variable in class org.springframework.shell.component.view.screen.Color
- GREY93 - Static variable in class org.springframework.shell.component.view.screen.Color
- GridView - Class in org.springframework.shell.component.view.control
-
GridView
is a layout container with no initialviews
. - GridView() - Constructor for class org.springframework.shell.component.view.control.GridView
- group() - Element in annotation interface org.springframework.shell.command.annotation.Command
-
Define a command group.
- 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
H
- h - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- H - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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
. - handle(KeyHandler.KeyHandlerArgs) - Method in interface org.springframework.shell.component.view.event.KeyHandler
-
Handle Key event wrapped in a
KeyHandler.KeyHandlerArgs
. - handle(MouseHandler.MouseHandlerArgs) - Method in interface org.springframework.shell.component.view.event.MouseHandler
-
Handle mouse event wrapped in a
MouseHandler.MouseHandlerArgs
. - 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.support.AbstractArgumentMethodArgumentResolver
-
Invoked when a value is required, but
AbstractArgumentMethodArgumentResolver.resolveArgumentInternal(org.springframework.core.MethodParameter, org.springframework.messaging.Message<?>, java.util.List<java.lang.String>)
returnednull
and there is no default value. - 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
- has(int) - Method in record class org.springframework.shell.component.view.event.MouseEvent
- hasButton() - Method in record class org.springframework.shell.component.view.event.MouseEvent
- hasCtrl() - Method in record class org.springframework.shell.component.view.event.KeyEvent
- 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
- hasFocus() - Method in class org.springframework.shell.component.view.control.AbstractView
- hasFocus() - Method in class org.springframework.shell.component.view.control.AppView
- hasFocus() - Method in class org.springframework.shell.component.view.control.GridView
- hasFocus() - Method in interface org.springframework.shell.component.view.control.View
-
Gets if this
View
has a focus. - 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 record class org.springframework.shell.component.view.control.AppView.AppViewEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.control.AppView.AppViewEventArgs
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.control.ButtonView.ButtonViewItemEventArgs
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.control.ButtonView.ButtonViewSelectEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.control.DialogView.DialogViewCloseEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.control.DialogView.DialogViewItemEventArgs
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.control.InputView.InputViewTextChangeEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.control.InputView.InputViewTextChangeEventArgs
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.control.ListView.ListViewItemEventArgs
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.control.ListView.ListViewOpenSelectedItemEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.control.ListView.ListViewSelectedItemChangedEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.control.MenuView.MenuViewItemEventArgs
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.control.MenuView.MenuViewOpenSelectedItemEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.control.MenuView.MenuViewSelectedItemChangedEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressState
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewEndEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewStartEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewStateChangeEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewStateEventArgs
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.control.StatusBarView.StatusBarViewItemEventArgs
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.control.StatusBarView.StatusBarViewOpenSelectedItemEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.control.ViewDoneEvent.GenericViewDoneEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.event.KeyBindingConsumerArgs
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.event.KeyEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.event.KeyHandler.KeyHandlerArgs
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.event.KeyHandler.KeyHandlerResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.event.MouseBindingConsumerArgs
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.event.MouseEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.event.MouseHandler.MouseHandlerArgs
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.component.view.event.MouseHandler.MouseHandlerResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.geom.Dimension
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.geom.Position
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.geom.Rectangle
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.springframework.shell.style.ThemeResolver.ResolvedValues
-
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
- hasModifier() - Method in record class org.springframework.shell.component.view.event.MouseEvent
- hasPty() - Method in class org.springframework.shell.context.DefaultShellContext
- hasPty() - Method in interface org.springframework.shell.context.ShellContext
-
Gets if shell has a proper
pty
terminal. - hasTty() - Method in class org.springframework.shell.component.support.AbstractComponent
-
Checks if this component has an existing
tty
. - hasType() - Method in record class org.springframework.shell.component.view.event.MouseEvent
- HEADER_COMMAND_CONTEXT - Static variable in class org.springframework.shell.command.CommandContextMethodArgumentResolver
- height() - Method in record class org.springframework.shell.geom.Dimension
-
Returns the value of the
height
record component. - height() - Method in record class org.springframework.shell.geom.Rectangle
-
Returns the value of the
height
record component. - Help(String) - Constructor for class org.springframework.shell.Command.Help
- Help(String, String) - Constructor for class org.springframework.shell.Command.Help
- 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.
- highlight() - Method in class org.springframework.shell.style.StyleSettings
- HONEYDEW - Static variable in class org.springframework.shell.component.view.screen.Color
- HONEYDEW1 - Static variable in class org.springframework.shell.component.view.screen.Color
- HONEYDEW2 - Static variable in class org.springframework.shell.component.view.screen.Color
- HONEYDEW3 - Static variable in class org.springframework.shell.component.view.screen.Color
- HONEYDEW4 - Static variable in class org.springframework.shell.component.view.screen.Color
- HorizontalAlign - Enum Class in org.springframework.shell.geom
- HOTPINK - Static variable in class org.springframework.shell.component.view.screen.Color
- HOTPINK1 - Static variable in class org.springframework.shell.component.view.screen.Color
- HOTPINK2 - Static variable in class org.springframework.shell.component.view.screen.Color
- HOTPINK3 - Static variable in class org.springframework.shell.component.view.screen.Color
- HOTPINK4 - Static variable in class org.springframework.shell.component.view.screen.Color
- Hyphen - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
I
- i - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- I - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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
- INDIANRED - Static variable in class org.springframework.shell.component.view.screen.Color
- INDIANRED1 - Static variable in class org.springframework.shell.component.view.screen.Color
- INDIANRED2 - Static variable in class org.springframework.shell.component.view.screen.Color
- INDIANRED3 - Static variable in class org.springframework.shell.component.view.screen.Color
- INDIANRED4 - Static variable in class org.springframework.shell.component.view.screen.Color
- info() - Method in class org.springframework.shell.style.FigureSettings
- INFO - Enum constant in enum class org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext.MessageLevel
- init() - Method in class org.springframework.shell.component.view.control.AbstractView
-
Initialize a view.
- init() - Method in interface org.springframework.shell.component.view.control.View
- initInternal() - Method in class org.springframework.shell.component.view.control.AbstractView
-
Internal init method called from
AbstractView.init()
. - initInternal() - Method in class org.springframework.shell.component.view.control.ButtonView
- initInternal() - Method in class org.springframework.shell.component.view.control.GridView
- initInternal() - Method in class org.springframework.shell.component.view.control.InputView
- initInternal() - Method in class org.springframework.shell.component.view.control.ListView
- initInternal() - Method in class org.springframework.shell.component.view.control.MenuBarView
- initInternal() - Method in class org.springframework.shell.component.view.control.MenuView
- 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.
- InputView - Class in org.springframework.shell.component.view.control
-
InputView
is used as a text input. - InputView() - Constructor for class org.springframework.shell.component.view.control.InputView
- InputView.InputViewTextChangeEvent - Record Class in org.springframework.shell.component.view.control
- InputView.InputViewTextChangeEventArgs - Record Class in org.springframework.shell.component.view.control
- InputViewTextChangeEvent(View, InputView.InputViewTextChangeEventArgs) - Constructor for record class org.springframework.shell.component.view.control.InputView.InputViewTextChangeEvent
-
Creates an instance of a
InputViewTextChangeEvent
record class. - InputViewTextChangeEventArgs(String, String) - Constructor for record class org.springframework.shell.component.view.control.InputView.InputViewTextChangeEventArgs
-
Creates an instance of a
InputViewTextChangeEventArgs
record class. - inserts() - Method in record class org.springframework.shell.command.parser.MessageResult
-
Returns the value of the
inserts
record component. - 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(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 - 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.
- 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
- InvocableShellMethod - Class in org.springframework.shell.command.invocation
- 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.
- isAvailable() - Method in class org.springframework.shell.Availability
- 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.
- isDone() - Method in interface org.springframework.shell.component.ViewComponent.ViewComponentRun
-
Returns
true
if component run has completed. - 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 record class org.springframework.shell.geom.Rectangle
-
Determines whether the
Rectangle
is empty. - 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
- 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.
- isInitialCheckState() - Method in class org.springframework.shell.component.view.control.MenuView.MenuItem
-
Gets initial check state.
- isKey() - Method in record class org.springframework.shell.component.view.event.KeyEvent
- isKey(int) - Method in record class org.springframework.shell.component.view.event.KeyEvent
- isMatch() - Method in class org.springframework.shell.style.PartsText.PartText
- 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
- isReadOnly(String) - Method in class org.springframework.shell.component.message.ShellMessageHeaderAccessor
- 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
- isSelected() - Method in class org.springframework.shell.component.view.control.cell.AbstractListCell
- isShowBorder() - Method in class org.springframework.shell.component.view.control.BoxView
-
Returns if border is shown.
- isShowBorders() - Method in class org.springframework.shell.component.view.control.GridView
-
Returns if borders is shown.
- isShowCursor() - Method in class org.springframework.shell.component.view.screen.DefaultScreen
- isShowCursor() - Method in interface org.springframework.shell.component.view.screen.Screen
-
Gets if cursor is visible.
- 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
- isVoid() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
-
Return
true
if the method return type is void,false
otherwise. - item() - Method in class org.springframework.shell.component.flow.DefaultSelectItem
- item() - Method in interface org.springframework.shell.component.flow.SelectItem
-
Gets an item
- item() - Method in record class org.springframework.shell.component.view.control.ListView.ListViewItemEventArgs
-
Returns the value of the
item
record component. - item() - Method in record class org.springframework.shell.component.view.control.MenuView.MenuViewItemEventArgs
-
Returns the value of the
item
record component. - item() - Method in record class org.springframework.shell.component.view.control.StatusBarView.StatusBarViewItemEventArgs
-
Returns the value of the
item
record component. - 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
- IVORY - Static variable in class org.springframework.shell.component.view.screen.Color
- IVORY1 - Static variable in class org.springframework.shell.component.view.screen.Color
- IVORY2 - Static variable in class org.springframework.shell.component.view.screen.Color
- IVORY3 - Static variable in class org.springframework.shell.component.view.screen.Color
- IVORY4 - Static variable in class org.springframework.shell.component.view.screen.Color
J
- j - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- J - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- JLineInputProvider(LineReader, PromptProvider) - Constructor for class org.springframework.shell.jline.InteractiveShellRunner.JLineInputProvider
- JnaRuntimeHints - Class in org.springframework.shell
- JnaRuntimeHints() - Constructor for class org.springframework.shell.JnaRuntimeHints
K
- k - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- K - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- KEBABCASE - Static variable in class org.springframework.shell.command.support.OptionNameModifierSupport
- key() - Method in record class org.springframework.shell.component.view.event.KeyEvent
-
Returns the value of the
key
record component. - Key() - Constructor for class org.springframework.shell.component.view.event.KeyEvent.Key
- KEY - Enum constant in enum class org.springframework.shell.component.view.event.EventLoop.Type
-
Key bindings from a terminal.
- KeyBinder - Class in org.springframework.shell.component.view.event
- KeyBinder(Terminal) - Constructor for class org.springframework.shell.component.view.event.KeyBinder
- KeyBindingConsumer - Interface in org.springframework.shell.component.view.event
- KeyBindingConsumerArgs - Record Class in org.springframework.shell.component.view.event
- KeyBindingConsumerArgs(KeyBindingConsumer, KeyEvent) - Constructor for record class org.springframework.shell.component.view.event.KeyBindingConsumerArgs
-
Creates an instance of a
KeyBindingConsumerArgs
record class. - KeyEvent - Record Class in org.springframework.shell.component.view.event
-
mask special keys unicode keys ascii keys [ ] [ ] [ ] [ ] 31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 09 08 07 06 05 04 03 02 01 00
- KeyEvent(int, String) - Constructor for record class org.springframework.shell.component.view.event.KeyEvent
-
Creates an instance of a
KeyEvent
record class. - KeyEvent.Key - Class in org.springframework.shell.component.view.event
- KeyEvent.KeyMask - Class in org.springframework.shell.component.view.event
- keyEvents() - Method in class org.springframework.shell.component.view.event.DefaultEventLoop
- keyEvents() - Method in interface org.springframework.shell.component.view.event.EventLoop
-
Specialisation of
EventLoop.events()
which returns type safeKeyEvent
s. - KeyHandler - Interface in org.springframework.shell.component.view.event
-
Handles Key events in a form of
KeyHandler.KeyHandlerArgs
and returnsKeyHandler.KeyHandlerResult
. - KeyHandler.KeyHandlerArgs - Record Class in org.springframework.shell.component.view.event
-
Arguments for a
KeyHandler
. - KeyHandler.KeyHandlerResult - Record Class in org.springframework.shell.component.view.event
-
Result from a
KeyHandler
. - KeyHandlerArgs(KeyEvent) - Constructor for record class org.springframework.shell.component.view.event.KeyHandler.KeyHandlerArgs
-
Creates an instance of a
KeyHandlerArgs
record class. - KeyHandlerResult(KeyEvent, boolean, View, View) - Constructor for record class org.springframework.shell.component.view.event.KeyHandler.KeyHandlerResult
-
Creates an instance of a
KeyHandlerResult
record class. - KeyMask() - Constructor for class org.springframework.shell.component.view.event.KeyEvent.KeyMask
- KHAKI - Static variable in class org.springframework.shell.component.view.screen.Color
- KHAKI1 - Static variable in class org.springframework.shell.component.view.screen.Color
- KHAKI2 - Static variable in class org.springframework.shell.component.view.screen.Color
- KHAKI3 - Static variable in class org.springframework.shell.component.view.screen.Color
- KHAKI4 - Static variable in class org.springframework.shell.component.view.screen.Color
L
- l - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- L - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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. - LAVENDERBLUSH - Static variable in class org.springframework.shell.component.view.screen.Color
- LAVENDERBLUSH1 - Static variable in class org.springframework.shell.component.view.screen.Color
- LAVENDERBLUSH2 - Static variable in class org.springframework.shell.component.view.screen.Color
- LAVENDERBLUSH3 - Static variable in class org.springframework.shell.component.view.screen.Color
- LAVENDERBLUSH4 - Static variable in class org.springframework.shell.component.view.screen.Color
- layer(int) - Method in interface org.springframework.shell.component.view.screen.Screen.WriterBuilder
-
Define a
z-index
thisScreen.Writer
operates on. - LEFT - Enum constant in enum class org.springframework.shell.geom.HorizontalAlign
- LEFT - Static variable in class org.springframework.shell.component.view.control.ViewCommand
-
Moves the selection left by one.
- LeftParenthesis - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- leftPointingQuotation() - Method in class org.springframework.shell.style.FigureSettings
- leftwardsArrow() - Method in class org.springframework.shell.style.FigureSettings
- LEMONCHIFFON - Static variable in class org.springframework.shell.component.view.screen.Color
- LEMONCHIFFON1 - Static variable in class org.springframework.shell.component.view.screen.Color
- LEMONCHIFFON2 - Static variable in class org.springframework.shell.component.view.screen.Color
- LEMONCHIFFON3 - Static variable in class org.springframework.shell.component.view.screen.Color
- LEMONCHIFFON4 - Static variable in class org.springframework.shell.component.view.screen.Color
- 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. - LIGHTBLUE - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTBLUE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTBLUE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTBLUE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTBLUE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTCYAN - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTCYAN1 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTCYAN2 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTCYAN3 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTCYAN4 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTGOLDENROD - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTGOLDENROD1 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTGOLDENROD2 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTGOLDENROD3 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTGOLDENROD4 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTPINK - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTPINK1 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTPINK2 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTPINK3 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTPINK4 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTSALMON - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTSALMON1 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTSALMON2 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTSALMON3 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTSALMON4 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTSKYBLUE - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTSKYBLUE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTSKYBLUE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTSKYBLUE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTSKYBLUE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTSTEELBLUE - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTSTEELBLUE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTSTEELBLUE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTSTEELBLUE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTSTEELBLUE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTYELLOW - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTYELLOW1 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTYELLOW2 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTYELLOW3 - Static variable in class org.springframework.shell.component.view.screen.Color
- LIGHTYELLOW4 - Static variable in class org.springframework.shell.component.view.screen.Color
- line() - Method in class org.springframework.shell.jline.ExtendedDefaultParser.ExtendedArgumentList
- line() - Method in class org.springframework.shell.style.SpinnerSettings
- LINE_DOWN - Static variable in class org.springframework.shell.component.view.control.ViewCommand
-
Move line down.
- LINE_UP - Static variable in class org.springframework.shell.component.view.control.ViewCommand
-
Move line up.
- LINE1 - Static variable in interface org.springframework.shell.component.view.control.Spinner
- ListCell<T> - Interface in org.springframework.shell.component.view.control.cell
-
Extension of a
Cell
to make it aware of an item style and selection state. - ListCell.DefaultListCell<T> - Class in org.springframework.shell.component.view.control.cell
- 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
- ListView<T> - Class in org.springframework.shell.component.view.control
-
ListView
is aView
showing items in a vertical list. - ListView() - Constructor for class org.springframework.shell.component.view.control.ListView
- ListView(List<T>, ListView.ItemStyle) - Constructor for class org.springframework.shell.component.view.control.ListView
- ListView(ListView.ItemStyle) - Constructor for class org.springframework.shell.component.view.control.ListView
- ListView(T[], ListView.ItemStyle) - Constructor for class org.springframework.shell.component.view.control.ListView
- ListView.ItemStyle - Enum Class in org.springframework.shell.component.view.control
-
Specifies how a item shows selection state.
- ListView.ListViewItemEventArgs<T> - Record Class in org.springframework.shell.component.view.control
- ListView.ListViewOpenSelectedItemEvent<T> - Record Class in org.springframework.shell.component.view.control
-
ViewEvent
indicating that selected item has been requested to open. - ListView.ListViewSelectedItemChangedEvent<T> - Record Class in org.springframework.shell.component.view.control
-
ViewEvent
indicating that selected item has changed. - ListViewItemEventArgs(T) - Constructor for record class org.springframework.shell.component.view.control.ListView.ListViewItemEventArgs
-
Creates an instance of a
ListViewItemEventArgs
record class. - ListViewOpenSelectedItemEvent(View, ListView.ListViewItemEventArgs<T>) - Constructor for record class org.springframework.shell.component.view.control.ListView.ListViewOpenSelectedItemEvent
-
Creates an instance of a
ListViewOpenSelectedItemEvent
record class. - ListViewSelectedItemChangedEvent(View, ListView.ListViewItemEventArgs<T>) - Constructor for record class org.springframework.shell.component.view.control.ListView.ListViewSelectedItemChangedEvent
-
Creates an instance of a
ListViewSelectedItemChangedEvent
record class. - 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
- m - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- M - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- MAGENTA - Static variable in class org.springframework.shell.component.view.screen.Color
- MAGENTA1 - Static variable in class org.springframework.shell.component.view.screen.Color
- MAGENTA2 - Static variable in class org.springframework.shell.component.view.screen.Color
- MAGENTA3 - Static variable in class org.springframework.shell.component.view.screen.Color
- MAGENTA4 - Static variable in class org.springframework.shell.component.view.screen.Color
- MANDATORY_OPTION_MISSING - Enum constant in enum class org.springframework.shell.command.parser.ParserMessage
- 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
- MAROON - Static variable in class org.springframework.shell.component.view.screen.Color
- MAROON1 - Static variable in class org.springframework.shell.component.view.screen.Color
- MAROON2 - Static variable in class org.springframework.shell.component.view.screen.Color
- MAROON3 - Static variable in class org.springframework.shell.component.view.screen.Color
- MAROON4 - Static variable in class org.springframework.shell.component.view.screen.Color
- 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(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(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;
- MEDIUMORCHID - Static variable in class org.springframework.shell.component.view.screen.Color
- MEDIUMORCHID1 - Static variable in class org.springframework.shell.component.view.screen.Color
- MEDIUMORCHID2 - Static variable in class org.springframework.shell.component.view.screen.Color
- MEDIUMORCHID3 - Static variable in class org.springframework.shell.component.view.screen.Color
- MEDIUMORCHID4 - Static variable in class org.springframework.shell.component.view.screen.Color
- MEDIUMPURPLE - Static variable in class org.springframework.shell.component.view.screen.Color
- MEDIUMPURPLE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- MEDIUMPURPLE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- MEDIUMPURPLE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- MEDIUMPURPLE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- Menu(String) - Constructor for class org.springframework.shell.component.view.control.MenuView.Menu
-
Construct menu with a title.
- Menu(String, List<MenuView.MenuItem>) - Constructor for class org.springframework.shell.component.view.control.MenuView.Menu
-
Construct menu with a title and a menu items.
- Menu(String, MenuView.MenuItem[]) - Constructor for class org.springframework.shell.component.view.control.MenuView.Menu
-
Construct menu with a title and a menu items.
- menubarBackground() - Method in class org.springframework.shell.style.StyleSettings
- MenuBarItem(String) - Constructor for class org.springframework.shell.component.view.control.MenuBarView.MenuBarItem
- MenuBarItem(String, MenuView.MenuItem[]) - Constructor for class org.springframework.shell.component.view.control.MenuBarView.MenuBarItem
- MenuBarView - Class in org.springframework.shell.component.view.control
-
MenuBarView
showsitems
horizontally and is typically used in layouts which builds complete terminal UI's. - MenuBarView(MenuBarView.MenuBarItem[]) - Constructor for class org.springframework.shell.component.view.control.MenuBarView
-
Construct menubar view with menubar items.
- MenuBarView.MenuBarItem - Class in org.springframework.shell.component.view.control
-
MenuBarView.MenuBarItem
represents an item in aMenuBarView
. - MenuItem(String) - Constructor for class org.springframework.shell.component.view.control.MenuView.MenuItem
-
Construct menu item with a title.
- MenuItem(String, List<MenuView.MenuItem>) - Constructor for class org.springframework.shell.component.view.control.MenuView.MenuItem
- MenuItem(String, MenuView.MenuItem[]) - Constructor for class org.springframework.shell.component.view.control.MenuView.MenuItem
- MenuItem(String, MenuView.MenuItemCheckStyle) - Constructor for class org.springframework.shell.component.view.control.MenuView.MenuItem
-
Construct menu item with a title and a check style.
- MenuItem(String, MenuView.MenuItemCheckStyle, Runnable) - Constructor for class org.springframework.shell.component.view.control.MenuView.MenuItem
-
Construct menu item with a title, a check style and a runnable.
- MenuItem(String, MenuView.MenuItemCheckStyle, Runnable, boolean) - Constructor for class org.springframework.shell.component.view.control.MenuView.MenuItem
-
Construct menu item with a title, a check style, a runnable and initial checked state.
- MenuView - Class in org.springframework.shell.component.view.control
- MenuView() - Constructor for class org.springframework.shell.component.view.control.MenuView
-
Construct menu view with no initial menu items.
- MenuView(List<MenuView.MenuItem>) - Constructor for class org.springframework.shell.component.view.control.MenuView
-
Construct menu view with menu items.
- MenuView(MenuView.MenuItem[]) - Constructor for class org.springframework.shell.component.view.control.MenuView
-
Construct menu view with menu items.
- MenuView.Menu - Class in org.springframework.shell.component.view.control
-
MenuView.Menu
represents an item in aMenuView
being a specialisation ofMenuView.MenuItem
indicating it having a sub-menu. - MenuView.MenuItem - Class in org.springframework.shell.component.view.control
-
MenuView.MenuItem
represents an item in aMenuView
. - MenuView.MenuItemCheckStyle - Enum Class in org.springframework.shell.component.view.control
-
Specifies how a
MenuView.MenuItem
shows selection state. - MenuView.MenuViewItemEventArgs - Record Class in org.springframework.shell.component.view.control
- MenuView.MenuViewOpenSelectedItemEvent - Record Class in org.springframework.shell.component.view.control
-
ViewEvent
indicating that selected item has been requested to open. - MenuView.MenuViewSelectedItemChangedEvent - Record Class in org.springframework.shell.component.view.control
-
ViewEvent
indicating that selected item has changed. - MenuViewItemEventArgs(MenuView.MenuItem) - Constructor for record class org.springframework.shell.component.view.control.MenuView.MenuViewItemEventArgs
-
Creates an instance of a
MenuViewItemEventArgs
record class. - MenuViewOpenSelectedItemEvent(View, MenuView.MenuViewItemEventArgs) - Constructor for record class org.springframework.shell.component.view.control.MenuView.MenuViewOpenSelectedItemEvent
-
Creates an instance of a
MenuViewOpenSelectedItemEvent
record class. - MenuViewSelectedItemChangedEvent(View, MenuView.MenuViewItemEventArgs) - Constructor for record class org.springframework.shell.component.view.control.MenuView.MenuViewSelectedItemChangedEvent
-
Creates an instance of a
MenuViewSelectedItemChangedEvent
record class. - 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 andinserts
. - 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.
- MISTYROSE - Static variable in class org.springframework.shell.component.view.screen.Color
- MISTYROSE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- MISTYROSE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- MISTYROSE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- MISTYROSE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- Modifier() - Constructor for class org.springframework.shell.component.view.event.MouseEvent.Modifier
- ModifierMask - Static variable in class org.springframework.shell.component.view.event.MouseEvent.MouseMask
- mouse() - Method in record class org.springframework.shell.component.view.event.MouseEvent
-
Returns the value of the
mouse
record component. - Mouse - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- MOUSE - Enum constant in enum class org.springframework.shell.component.view.event.EventLoop.Type
-
Mouse bindings from a terminal.
- MouseBindingConsumer - Interface in org.springframework.shell.component.view.event
- MouseBindingConsumerArgs - Record Class in org.springframework.shell.component.view.event
- MouseBindingConsumerArgs(MouseBindingConsumer, MouseEvent) - Constructor for record class org.springframework.shell.component.view.event.MouseBindingConsumerArgs
-
Creates an instance of a
MouseBindingConsumerArgs
record class. - MouseEvent - Record Class in org.springframework.shell.component.view.event
-
unused modifier button type [ ] [ ] [ ] [ ] 31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 09 08 07 06 05 04 03 02 01 00
- MouseEvent(int, int, int) - Constructor for record class org.springframework.shell.component.view.event.MouseEvent
-
Creates an instance of a
MouseEvent
record class. - MouseEvent.Button - Class in org.springframework.shell.component.view.event
- MouseEvent.Modifier - Class in org.springframework.shell.component.view.event
- MouseEvent.MouseMask - Class in org.springframework.shell.component.view.event
- MouseEvent.Type - Class in org.springframework.shell.component.view.event
- mouseEvents() - Method in class org.springframework.shell.component.view.event.DefaultEventLoop
- mouseEvents() - Method in interface org.springframework.shell.component.view.event.EventLoop
-
Specialisation of
EventLoop.events()
which returns type safeMouseEvent
s. - MouseHandler - Interface in org.springframework.shell.component.view.event
-
Handles mouse events in a form of
MouseHandler.MouseHandlerArgs
and returnsMouseHandler.MouseHandlerResult
. - MouseHandler.MouseHandlerArgs - Record Class in org.springframework.shell.component.view.event
-
Arguments for a
MouseHandler
. - MouseHandler.MouseHandlerResult - Record Class in org.springframework.shell.component.view.event
-
Result from a
MouseHandler
. - MouseHandlerArgs(MouseEvent) - Constructor for record class org.springframework.shell.component.view.event.MouseHandler.MouseHandlerArgs
-
Creates an instance of a
MouseHandlerArgs
record class. - MouseHandlerResult(MouseEvent, boolean, View, View) - Constructor for record class org.springframework.shell.component.view.event.MouseHandler.MouseHandlerResult
-
Creates an instance of a
MouseHandlerResult
record class. - MouseMask() - Constructor for class org.springframework.shell.component.view.event.MouseEvent.MouseMask
- Moved - Static variable in class org.springframework.shell.component.view.event.MouseEvent.Type
- 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 -
Context
MultiItemSelector
. - MultiItemSelectorSpec - Interface in org.springframework.shell.component.flow
-
Interface for multi input spec builder.
N
- n - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- N - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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.
- NAVAJOWHITE - Static variable in class org.springframework.shell.component.view.screen.Color
- NAVAJOWHITE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- NAVAJOWHITE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- NAVAJOWHITE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- NAVAJOWHITE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- neverConsume() - Static method in interface org.springframework.shell.component.view.event.KeyHandler
-
Returns a handler that always returns a non-consumed result.
- neverConsume() - Static method in interface org.springframework.shell.component.view.event.MouseHandler
-
Returns a handler that always returns a non-consumed result.
- newText() - Method in record class org.springframework.shell.component.view.control.InputView.InputViewTextChangeEventArgs
-
Returns the value of the
newText
record component. - 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.
- NEXT - Enum constant in enum class org.springframework.shell.component.view.control.AppView.AppViewEventArgs.Direction
- NEXT_VIEW - Static variable in class org.springframework.shell.component.view.control.ViewCommand
-
Move focus to the next view.
- Nine - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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.
- NoButton - Static variable in class org.springframework.shell.component.view.event.MouseEvent.Button
- NOCHECK - Enum constant in enum class org.springframework.shell.component.view.control.ListView.ItemStyle
-
The item will be shown normally, with no check indicator.
- NOCHECK - Enum constant in enum class org.springframework.shell.component.view.control.MenuView.MenuItemCheckStyle
-
The menu item will be shown normally, with no check indicator.
- NodeVisitor - Interface in org.springframework.shell.command.parser
-
Interface to vising nodes.
- NONE - Enum constant in enum class org.springframework.shell.command.CommandRegistration.OptionArity
-
Used to indicate that arity is not set.
- 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.
- 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
- NonInteractiveShellRunner(Shell, ShellContext, String) - Constructor for class org.springframework.shell.jline.NonInteractiveShellRunner
- NonterminalAstNode - Class in org.springframework.shell.command.parser
-
Nonterminal
node means that it can have children and doesn't necessarily terminalast 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 - 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
- NumberSign - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
O
- o - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- O - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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() - Static method in record class org.springframework.shell.component.view.control.ButtonView.ButtonViewItemEventArgs
- of() - Static method in record class org.springframework.shell.component.view.control.DialogView.DialogViewItemEventArgs
- 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) - Static method in record class org.springframework.shell.component.view.event.KeyEvent
- of(int, int, int) - Static method in record class org.springframework.shell.component.view.event.MouseEvent
- of(int, int, int, boolean, long, long) - Static method in record class org.springframework.shell.component.view.control.ProgressView.ProgressState
- 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) - Static method in class org.springframework.shell.component.view.control.MenuView.MenuItem
-
Return a
MenuView.MenuItem
with a giventitle
. - of(String) - Static method in class org.springframework.shell.component.view.control.StatusBarView.StatusItem
- of(String) - Static method in record class org.springframework.shell.component.view.event.KeyEvent
- of(String[], int) - Static method in interface org.springframework.shell.component.view.control.Spinner
-
Construct
Spinner
from given frames and interval. - 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, ShellContext) - 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
-
Gets an
StringInput.StringInputContext
. - of(String, Integer) - Static method in interface org.springframework.shell.command.CommandHandlingResult
-
Gets an instance of
CommandHandlingResult
. - of(String, Runnable) - Static method in class org.springframework.shell.component.view.control.StatusBarView.StatusItem
- of(String, Runnable, Integer) - Static method in class org.springframework.shell.component.view.control.StatusBarView.StatusItem
- 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) - Static method in record class org.springframework.shell.component.view.control.InputView.InputViewTextChangeEventArgs
- 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, MenuView.MenuItem...) - Static method in class org.springframework.shell.component.view.control.MenuBarView.MenuBarItem
- of(String, MenuView.MenuItem...) - Static method in class org.springframework.shell.component.view.control.MenuView.Menu
- of(String, MenuView.MenuItemCheckStyle) - Static method in class org.springframework.shell.component.view.control.MenuView.MenuItem
- of(String, MenuView.MenuItemCheckStyle, Runnable) - Static method in class org.springframework.shell.component.view.control.MenuView.MenuItem
- of(String, MenuView.MenuItemCheckStyle, Runnable, boolean) - Static method in class org.springframework.shell.component.view.control.MenuView.MenuItem
- 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, ShellContext, ConversionService) - Static method in interface org.springframework.shell.command.CommandExecution
-
Gets an instance of a default
CommandExecution
. - of(List<? extends HandlerMethodArgumentResolver>, Validator, Terminal, ShellContext, ConversionService, CommandCatalog) - Static method in interface org.springframework.shell.command.CommandExecution
-
Gets an instance of a default
CommandExecution
. - 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(MouseEvent) - Static method in record class org.springframework.shell.component.view.event.MouseEvent
- 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(AppView.AppViewEventArgs.Direction) - Static method in record class org.springframework.shell.component.view.control.AppView.AppViewEventArgs
- of(MenuBarView.MenuBarItem...) - Static method in class org.springframework.shell.component.view.control.MenuBarView
-
Construct menubar view with menubar items.
- of(MenuView.MenuItem) - Static method in record class org.springframework.shell.component.view.control.MenuView.MenuViewItemEventArgs
- of(ProgressView.ProgressState) - Static method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewStateEventArgs
- of(StatusBarView.StatusItem) - Static method in record class org.springframework.shell.component.view.control.StatusBarView.StatusBarViewItemEventArgs
- of(View) - Static method in record class org.springframework.shell.component.view.control.ButtonView.ButtonViewSelectEvent
- of(View) - Static method in record class org.springframework.shell.component.view.control.DialogView.DialogViewCloseEvent
- of(View) - Static method in interface org.springframework.shell.component.view.control.ViewDoneEvent
-
Create a generic event with empty view args.
- of(View, String, String) - Static method in record class org.springframework.shell.component.view.control.InputView.InputViewTextChangeEvent
- of(View, AppView.AppViewEventArgs.Direction) - Static method in record class org.springframework.shell.component.view.control.AppView.AppViewEvent
- of(View, MenuView.MenuItem) - Static method in record class org.springframework.shell.component.view.control.MenuView.MenuViewOpenSelectedItemEvent
- of(View, MenuView.MenuItem) - Static method in record class org.springframework.shell.component.view.control.MenuView.MenuViewSelectedItemChangedEvent
- of(View, ProgressView.ProgressState) - Static method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewEndEvent
- of(View, ProgressView.ProgressState) - Static method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewStartEvent
- of(View, ProgressView.ProgressState) - Static method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewStateChangeEvent
- of(View, StatusBarView.StatusItem) - Static method in record class org.springframework.shell.component.view.control.StatusBarView.StatusBarViewOpenSelectedItemEvent
- of(View, T) - Static method in record class org.springframework.shell.component.view.control.ListView.ListViewOpenSelectedItemEvent
- of(View, T) - Static method in record class org.springframework.shell.component.view.control.ListView.ListViewSelectedItemChangedEvent
- of(PartsText.PartText...) - Static method in class org.springframework.shell.style.PartsText
- of(T) - Static method in record class org.springframework.shell.component.view.control.ListView.ListViewItemEventArgs
- of(T, Function<T, String>) - Static method in interface org.springframework.shell.component.view.control.cell.TextCell
-
Helper method to build a
TextCell
. - of(T, Function<T, String>, HorizontalAlign, VerticalAlign) - Static method in interface org.springframework.shell.component.view.control.cell.TextCell
-
Helper method to build a
TextCell
. - of(T, ListView.ItemStyle) - Static method in interface org.springframework.shell.component.view.control.cell.ListCell
-
Helper method to build a
ListCell
. - ofInterrupt() - Static method in class org.springframework.shell.component.message.ShellMessageBuilder
-
Create a
interrupt
message. - ofKeyEvent(KeyEvent) - Static method in class org.springframework.shell.component.message.ShellMessageBuilder
-
Create a message of a
KeyEvent
. - ofMinus() - Static method in interface org.springframework.shell.support.search.SearchMatchResult
- ofMouseEvent(MouseEvent) - Static method in class org.springframework.shell.component.message.ShellMessageBuilder
-
Create a message of a
MouseEvent
. - ofPercent() - Static method in class org.springframework.shell.component.view.control.ProgressView.ProgressViewItem
- ofPercent(int, HorizontalAlign) - Static method in class org.springframework.shell.component.view.control.ProgressView.ProgressViewItem
- 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. - ofRedraw() - Static method in class org.springframework.shell.component.message.ShellMessageBuilder
-
Create a
redraw
message. - ofSignal(String) - Static method in class org.springframework.shell.component.message.ShellMessageBuilder
-
Create a
signal
message. - ofSpinner() - Static method in class org.springframework.shell.component.view.control.ProgressView.ProgressViewItem
- ofSpinner(int, HorizontalAlign) - Static method in class org.springframework.shell.component.view.control.ProgressView.ProgressViewItem
- ofText() - Static method in class org.springframework.shell.component.view.control.ProgressView.ProgressViewItem
- ofText(int, HorizontalAlign) - Static method in class org.springframework.shell.component.view.control.ProgressView.ProgressViewItem
- ofView(View, Object) - Static method in class org.springframework.shell.component.message.ShellMessageBuilder
- ofViewFocus(String, View) - Static method in class org.springframework.shell.component.message.ShellMessageBuilder
- ofZeros() - Static method in interface org.springframework.shell.support.search.SearchMatchResult
- oldText() - Method in record class org.springframework.shell.component.view.control.InputView.InputViewTextChangeEventArgs
-
Returns the value of the
oldText
record component. - OLIVEDRAB - Static variable in class org.springframework.shell.component.view.screen.Color
- OLIVEDRAB1 - Static variable in class org.springframework.shell.component.view.screen.Color
- OLIVEDRAB2 - Static variable in class org.springframework.shell.component.view.screen.Color
- OLIVEDRAB3 - Static variable in class org.springframework.shell.component.view.screen.Color
- OLIVEDRAB4 - Static variable in class org.springframework.shell.component.view.screen.Color
- onDestroy(Disposable) - Method in class org.springframework.shell.component.view.control.AbstractView
-
Register
Disposable
to get disposed when view terminates. - onDestroy(Disposable) - Method in class org.springframework.shell.component.view.event.DefaultEventLoop
- onDestroy(Disposable) - Method in interface org.springframework.shell.component.view.event.EventLoop
-
Register
Disposable
to get disposed when event loop terminates. - One - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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
- OpenBracket - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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_UNICODE - 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 - 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
- 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.
- ORANGE - Static variable in class org.springframework.shell.component.view.screen.Color
- ORANGE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- ORANGE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- ORANGE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- ORANGE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- ORCHID - Static variable in class org.springframework.shell.component.view.screen.Color
- ORCHID1 - Static variable in class org.springframework.shell.component.view.screen.Color
- ORCHID2 - Static variable in class org.springframework.shell.component.view.screen.Color
- ORCHID3 - Static variable in class org.springframework.shell.component.view.screen.Color
- ORCHID4 - Static variable in class org.springframework.shell.component.view.screen.Color
- 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.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.message - package org.springframework.shell.component.message
- org.springframework.shell.component.support - package org.springframework.shell.component.support
- org.springframework.shell.component.view - package org.springframework.shell.component.view
- org.springframework.shell.component.view.control - package org.springframework.shell.component.view.control
- org.springframework.shell.component.view.control.cell - package org.springframework.shell.component.view.control.cell
- org.springframework.shell.component.view.event - package org.springframework.shell.component.view.event
- org.springframework.shell.component.view.event.processor - package org.springframework.shell.component.view.event.processor
- org.springframework.shell.component.view.screen - package org.springframework.shell.component.view.screen
- 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.geom - package org.springframework.shell.geom
- 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.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
P
- p - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- P - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- PALEGREEN - Static variable in class org.springframework.shell.component.view.screen.Color
- PALEGREEN1 - Static variable in class org.springframework.shell.component.view.screen.Color
- PALEGREEN2 - Static variable in class org.springframework.shell.component.view.screen.Color
- PALEGREEN3 - Static variable in class org.springframework.shell.component.view.screen.Color
- PALEGREEN4 - Static variable in class org.springframework.shell.component.view.screen.Color
- PALETURQUOISE - Static variable in class org.springframework.shell.component.view.screen.Color
- PALETURQUOISE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- PALETURQUOISE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- PALETURQUOISE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- PALETURQUOISE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- PALEVIOLETRED - Static variable in class org.springframework.shell.component.view.screen.Color
- PALEVIOLETRED1 - Static variable in class org.springframework.shell.component.view.screen.Color
- PALEVIOLETRED2 - Static variable in class org.springframework.shell.component.view.screen.Color
- PALEVIOLETRED3 - Static variable in class org.springframework.shell.component.view.screen.Color
- PALEVIOLETRED4 - Static variable in class org.springframework.shell.component.view.screen.Color
- 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 - 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 resolvedCommandRegistration
, list ofCommandOption
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
- 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
andSearchMatchResult
. - PathSearchConfig() - Constructor for class org.springframework.shell.component.PathSearch.PathSearchConfig
- PathViewItem(Path, PartsText, boolean) - Constructor for class org.springframework.shell.component.PathSearch.PathSearchContext.PathViewItem
- PEACHPUFF - Static variable in class org.springframework.shell.component.view.screen.Color
- PEACHPUFF1 - Static variable in class org.springframework.shell.component.view.screen.Color
- PEACHPUFF2 - Static variable in class org.springframework.shell.component.view.screen.Color
- PEACHPUFF3 - Static variable in class org.springframework.shell.component.view.screen.Color
- PEACHPUFF4 - Static variable in class org.springframework.shell.component.view.screen.Color
- Percent - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- PINK - Static variable in class org.springframework.shell.component.view.screen.Color
- PINK1 - Static variable in class org.springframework.shell.component.view.screen.Color
- PINK2 - Static variable in class org.springframework.shell.component.view.screen.Color
- PINK3 - Static variable in class org.springframework.shell.component.view.screen.Color
- PINK4 - Static variable in class org.springframework.shell.component.view.screen.Color
- Pipe - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- PLUM - Static variable in class org.springframework.shell.component.view.screen.Color
- PLUM1 - Static variable in class org.springframework.shell.component.view.screen.Color
- PLUM2 - Static variable in class org.springframework.shell.component.view.screen.Color
- PLUM3 - Static variable in class org.springframework.shell.component.view.screen.Color
- PLUM4 - Static variable in class org.springframework.shell.component.view.screen.Color
- Plus - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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.
- Position - Record Class in org.springframework.shell.geom
-
Record representing position
x
andy
. - Position(int, int) - Constructor for record class org.springframework.shell.geom.Position
-
Creates an instance of a
Position
record class. - 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.
- 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.
- 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.
- Pressed - Static variable in class org.springframework.shell.component.view.event.MouseEvent.Type
- PREVIOUS - Enum constant in enum class org.springframework.shell.component.view.control.AppView.AppViewEventArgs.Direction
- PRIORITY - Static variable in class org.springframework.shell.component.message.ShellMessageHeaderAccessor
- process(Message<?>) - Method in interface org.springframework.shell.component.view.event.EventLoop.EventLoopProcessor
-
Process a message and transform it into a new
Flux
ofMessage
instances. - process(Message<?>) - Method in class org.springframework.shell.component.view.event.processor.AnimationEventLoopProcessor
- process(Message<?>) - Method in class org.springframework.shell.component.view.event.processor.TaskEventLoopProcessor
- ProgressState(int, int, int, boolean, long, long) - Constructor for record class org.springframework.shell.component.view.control.ProgressView.ProgressState
-
Creates an instance of a
ProgressState
record class. - ProgressView - Class in org.springframework.shell.component.view.control
-
ProgressView
is used to show a progress indicator. - ProgressView() - Constructor for class org.springframework.shell.component.view.control.ProgressView
-
Construct view with
tickStart 0
andtickEnd 100
. - ProgressView(int, int) - Constructor for class org.springframework.shell.component.view.control.ProgressView
-
Construct view with
tickStart 0
andtickEnd 100
. - ProgressView(int, int, ProgressView.ProgressViewItem...) - Constructor for class org.springframework.shell.component.view.control.ProgressView
-
Construct view with given bounds for
tickStart
andtickEnd
. - ProgressView(ProgressView.ProgressViewItem...) - Constructor for class org.springframework.shell.component.view.control.ProgressView
- ProgressView.ProgressContext - Interface in org.springframework.shell.component.view.control
-
Context for
ProgressView
cell components. - ProgressView.ProgressState - Record Class in org.springframework.shell.component.view.control
-
Encapsulates a current running state of a
ProgressView
. - ProgressView.ProgressViewEndEvent - Record Class in org.springframework.shell.component.view.control
-
ViewEvent
indicating that proggress has been ended. - ProgressView.ProgressViewItem - Class in org.springframework.shell.component.view.control
-
Defines an item within a progress view.
- ProgressView.ProgressViewStartEvent - Record Class in org.springframework.shell.component.view.control
-
ViewEvent
indicating that proggress has been started. - ProgressView.ProgressViewStateChangeEvent - Record Class in org.springframework.shell.component.view.control
-
ViewEvent
indicating that proggress state has been changed. - ProgressView.ProgressViewStateEventArgs - Record Class in org.springframework.shell.component.view.control
-
ViewEventArgs
for events usingProgressView.ProgressState
. - ProgressViewEndEvent(View, ProgressView.ProgressViewStateEventArgs) - Constructor for record class org.springframework.shell.component.view.control.ProgressView.ProgressViewEndEvent
-
Creates an instance of a
ProgressViewEndEvent
record class. - ProgressViewItem(Function<ProgressView.ProgressContext, TextCell<ProgressView.ProgressContext>>, int, HorizontalAlign) - Constructor for class org.springframework.shell.component.view.control.ProgressView.ProgressViewItem
- ProgressViewStartEvent(View, ProgressView.ProgressViewStateEventArgs) - Constructor for record class org.springframework.shell.component.view.control.ProgressView.ProgressViewStartEvent
-
Creates an instance of a
ProgressViewStartEvent
record class. - ProgressViewStateChangeEvent(View, ProgressView.ProgressViewStateEventArgs) - Constructor for record class org.springframework.shell.component.view.control.ProgressView.ProgressViewStateChangeEvent
-
Creates an instance of a
ProgressViewStateChangeEvent
record class. - ProgressViewStateEventArgs(ProgressView.ProgressState) - Constructor for record class org.springframework.shell.component.view.control.ProgressView.ProgressViewStateEventArgs
-
Creates an instance of a
ProgressViewStateEventArgs
record class. - PromptProvider - Interface in org.springframework.shell.jline
-
Called at each REPL cycle to decide what the prompt should be.
- 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
. - PURPLE - Static variable in class org.springframework.shell.component.view.screen.Color
- PURPLE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- PURPLE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- PURPLE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- PURPLE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- 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
- q - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- Q - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- questionMark() - Method in class org.springframework.shell.style.FigureSettings
- QuestionMark - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
R
- r - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- R - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- RADIO - Enum constant in enum class org.springframework.shell.component.view.control.ListView.ItemStyle
-
The item is part of a radio group and will indicate selected state.
- RADIO - Enum constant in enum class org.springframework.shell.component.view.control.MenuView.MenuItemCheckStyle
-
The menu item is part of a menu radio group and will indicate selected state.
- rawText() - Method in interface org.springframework.shell.Input
-
Return the input as entered by the user.
- REACTOR_CONTEXT - Static variable in class org.springframework.shell.component.message.ShellMessageHeaderAccessor
-
Raw source message.
- 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
- Rectangle - Record Class in org.springframework.shell.geom
-
Record representing coordinates
x
,y
and itswidth
andheight
. - Rectangle(int, int, int, int) - Constructor for record class org.springframework.shell.geom.Rectangle
-
Creates an instance of a
Rectangle
record class. - RED - Static variable in class org.springframework.shell.component.view.screen.Color
- RED1 - Static variable in class org.springframework.shell.component.view.screen.Color
- RED2 - Static variable in class org.springframework.shell.component.view.screen.Color
- RED3 - Static variable in class org.springframework.shell.component.view.screen.Color
- RED4 - Static variable in class org.springframework.shell.component.view.screen.Color
- redraw() - Method in class org.springframework.shell.component.view.TerminalUI
-
Redraw a whole screen.
- 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(CommandRegistration...) - Method in class org.springframework.shell.command.CommandCatalog.DefaultCommandCatalog
- register(CommandRegistration...) - Method in interface org.springframework.shell.command.CommandCatalog
-
Register a
CommandRegistration
. - 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
- registerHotKeyBinding(Integer, Runnable) - Method in class org.springframework.shell.component.view.control.AbstractView
- registerHotKeyBinding(Integer, String) - Method in class org.springframework.shell.component.view.control.AbstractView
- registerHotKeyBinding(Integer, KeyBindingConsumer) - Method in class org.springframework.shell.component.view.control.AbstractView
- registerKeyBinding(Integer, Runnable) - Method in class org.springframework.shell.component.view.control.AbstractView
- registerKeyBinding(Integer, String) - Method in class org.springframework.shell.component.view.control.AbstractView
- registerKeyBinding(Integer, KeyBindingConsumer) - Method in class org.springframework.shell.component.view.control.AbstractView
- registerMethodHint(ReflectionHints, Method) - Method in class org.springframework.shell.AvailabilityReflectiveProcessor
-
Register
ReflectionHints
against the specifiedMethod
. - registerMouseBinding(Integer, Runnable) - Method in class org.springframework.shell.component.view.control.AbstractView
- registerMouseBinding(Integer, String) - Method in class org.springframework.shell.component.view.control.AbstractView
- registerMouseBinding(Integer, MouseBindingConsumer) - Method in class org.springframework.shell.component.view.control.AbstractView
- registerReflectionHints(ReflectionHints, AnnotatedElement) - Method in class org.springframework.shell.AvailabilityReflectiveProcessor
- registerViewCommand(String, Runnable) - Method in class org.springframework.shell.component.view.control.AbstractView
- 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.
- Released - Static variable in class org.springframework.shell.component.view.event.MouseEvent.Type
- removeHiddenCommands(Map<String, CommandRegistration>) - Static method in class org.springframework.shell.Utils
-
Takes a map of command registrations and removes hidden commands from it.
- 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.
- 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(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
- resize(int, int) - Method in class org.springframework.shell.component.view.screen.DefaultScreen
- resize(int, int) - Method in interface org.springframework.shell.component.view.screen.Screen
-
Resize a screen.
- 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.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. - ResolvedValues(int, int, int) - Constructor for record class org.springframework.shell.style.ThemeResolver.ResolvedValues
-
Creates an instance of a
ResolvedValues
record class. - 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 rawpath
. - resolvePath(String) - Method in class org.springframework.shell.component.PathSearch
-
Resolves a
Path
from a given rawpath
. - resolver(CommandExceptionResolver) - Method in class org.springframework.shell.command.CommandRegistration.DefaultErrorHandlingSpec
- resolver(CommandExceptionResolver) - Method in interface org.springframework.shell.command.CommandRegistration.ErrorHandlingSpec
- resolveSpinnerTag(String) - Method in class org.springframework.shell.style.ThemeResolver
-
Resolve spinner from a tag with activated theme.
- resolveStyle(String) - Method in class org.springframework.shell.style.ThemeResolver
-
Resolve
AttributedStyle
from aspec
. - resolveStyleTag(String) - Method in class org.springframework.shell.style.ThemeResolver
-
Resolve style from a tag with activated theme.
- resolveStyleTag(String, String) - Method in class org.springframework.shell.style.ThemeResolver
-
Resolve style from a tag with given theme.
- resolveTag(String) - Method in class org.springframework.shell.style.FigureSettings
- resolveTag(String) - Method in class org.springframework.shell.style.SpinnerSettings
- resolveTag(String) - Method in class org.springframework.shell.style.StyleSettings
-
Resolve a theme setting from a given tag.
- resolveThemeBackground(String, int, int) - Method in class org.springframework.shell.component.view.control.AbstractControl
-
Resolve background color using existing
ThemeResolver
andtheme name
. - resolveThemeForeground(String, int, int) - Method in class org.springframework.shell.component.view.control.AbstractControl
-
Resolve foreground color using existing
ThemeResolver
andtheme name
. - resolveThemeSpinner(String, Spinner, Spinner) - Method in class org.springframework.shell.component.view.control.AbstractControl
- resolveThemeSpinner(String, Spinner, Spinner) - Method in interface org.springframework.shell.component.view.control.ProgressView.ProgressContext
- resolveThemeStyle(String, int) - Method in class org.springframework.shell.component.view.control.AbstractControl
-
Resolve style using existing
ThemeResolver
andtheme name
. - resolveThemeStyle(String, int) - Method in interface org.springframework.shell.component.view.control.ProgressView.ProgressContext
-
Resolve style using existing
ThemeResolver
andtheme name
. - resolveValues(AttributedStyle) - Method in class org.springframework.shell.style.ThemeResolver
-
Resolve
style
,foreground color
andbackground color
from anAttributedStyle
. - 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
. - 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
ResultHandler
s. - ResultHandlerConfig() - Constructor for class org.springframework.shell.result.ResultHandlerConfig
- ResultHandlerNotFoundException - Exception in org.springframework.shell.result
- ResultHandlerNotFoundException(TypeDescriptor) - Constructor for exception org.springframework.shell.result.ResultHandlerNotFoundException
-
Create a new handling executor not found exception.
- ResultHandlerService - Interface in org.springframework.shell
-
A service interface for result handling.
- ResultHandlingException - Exception in org.springframework.shell.result
- ResultHandlingException(String) - Constructor for exception org.springframework.shell.result.ResultHandlingException
-
Construct a new result handling exception.
- ResultHandlingException(String, Throwable) - Constructor for exception org.springframework.shell.result.ResultHandlingException
-
Construct a new result handling exception.
- 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. - resultOf(KeyEvent, boolean, View) - Static method in interface org.springframework.shell.component.view.event.KeyHandler
- resultOf(MouseEvent, boolean, View, View) - Static method in interface org.springframework.shell.component.view.event.MouseHandler
- 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.
- RIGHT - Enum constant in enum class org.springframework.shell.geom.HorizontalAlign
- RIGHT - Static variable in class org.springframework.shell.component.view.control.ViewCommand
-
Moves the selection righ by one.
- RightParenthesis - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- rightPointingQuotation() - Method in class org.springframework.shell.style.FigureSettings
- righwardsArror() - Method in class org.springframework.shell.style.FigureSettings
- ROSYBROWN - Static variable in class org.springframework.shell.component.view.screen.Color
- ROSYBROWN1 - Static variable in class org.springframework.shell.component.view.screen.Color
- ROSYBROWN2 - Static variable in class org.springframework.shell.component.view.screen.Color
- ROSYBROWN3 - Static variable in class org.springframework.shell.component.view.screen.Color
- ROSYBROWN4 - Static variable in class org.springframework.shell.component.view.screen.Color
- ROYALBLUE - Static variable in class org.springframework.shell.component.view.screen.Color
- ROYALBLUE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- ROYALBLUE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- ROYALBLUE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- ROYALBLUE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- 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 class org.springframework.shell.component.view.TerminalUI
-
Run and start execution loop.
- run(String[]) - Method in class org.springframework.shell.jline.InteractiveShellRunner
- run(String[]) - Method in class org.springframework.shell.jline.NonInteractiveShellRunner
- run(String[]) - Method in class org.springframework.shell.jline.ScriptShellRunner
- run(String[]) - Method in interface org.springframework.shell.ShellRunner
-
Execute
ShellRunner
with given args. - run(ApplicationArguments) - Method in class org.springframework.shell.DefaultShellApplicationRunner
- run(ApplicationArguments) - Method in interface org.springframework.shell.ShellRunner
-
Deprecated, for removal: This API element is subject to removal in a future version.
- 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.
- runAsync() - Method in class org.springframework.shell.component.ViewComponent
-
Run a component asyncronously.
- runBlocking() - Method in class org.springframework.shell.component.ViewComponent
-
Run a view execution loop.
- 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.
- running() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressState
-
Returns the value of the
running
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
- runViewCommand(String) - Method in class org.springframework.shell.component.view.control.AbstractView
- runViewCommand(String) - Method in interface org.springframework.shell.component.view.control.View
-
Run command.
S
- s - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- S - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- SALMON - Static variable in class org.springframework.shell.component.view.screen.Color
- SALMON1 - Static variable in class org.springframework.shell.component.view.screen.Color
- SALMON2 - Static variable in class org.springframework.shell.component.view.screen.Color
- SALMON3 - Static variable in class org.springframework.shell.component.view.screen.Color
- SALMON4 - Static variable in class org.springframework.shell.component.view.screen.Color
- 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.)
- Screen - Interface in org.springframework.shell.component.view.screen
-
Screen
is representing a virtual area which is sitting between a user and lower leveljline
terminal providing convenient methods working with visible content. - Screen.Writer - Interface in org.springframework.shell.component.view.screen
-
Interface to write into a
Screen
. - Screen.WriterBuilder - Interface in org.springframework.shell.component.view.screen
-
Builder interface for a
Screen.Writer
. - ScreenItem - Interface in org.springframework.shell.component.view.screen
- 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
- scrollDown() - Method in class org.springframework.shell.component.support.SelectorList.DefaultSelectorList
- scrollDown() - Method in interface org.springframework.shell.component.support.SelectorList
- scrollUp() - Method in class org.springframework.shell.component.support.SelectorList.DefaultSelectorList
- scrollUp() - Method in interface org.springframework.shell.component.support.SelectorList
- SEAGREEN - Static variable in class org.springframework.shell.component.view.screen.Color
- SEAGREEN1 - Static variable in class org.springframework.shell.component.view.screen.Color
- SEAGREEN2 - Static variable in class org.springframework.shell.component.view.screen.Color
- SEAGREEN3 - Static variable in class org.springframework.shell.component.view.screen.Color
- SEAGREEN4 - Static variable in class org.springframework.shell.component.view.screen.Color
- SearchMatch - Interface in org.springframework.shell.support.search
-
Interface defining a search match for
text
againspattern
. - 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
- SEASHELL - Static variable in class org.springframework.shell.component.view.screen.Color
- SEASHELL1 - Static variable in class org.springframework.shell.component.view.screen.Color
- SEASHELL2 - Static variable in class org.springframework.shell.component.view.screen.Color
- SEASHELL3 - Static variable in class org.springframework.shell.component.view.screen.Color
- SEASHELL4 - Static variable in class org.springframework.shell.component.view.screen.Color
- 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 class org.springframework.shell.component.flow.BaseSingleItemSelector
- selectItems(List<SelectItem>) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec
-
Adds a list of select items.
- selectItems(List<SelectItem>) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec
-
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
- SemiColon - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- setAction(Runnable) - Method in class org.springframework.shell.component.view.control.ButtonView
- setAction(Runnable) - Method in class org.springframework.shell.component.view.control.MenuView.MenuItem
- setAction(Runnable) - Method in class org.springframework.shell.component.view.control.StatusBarView.StatusItem
- setArgumentResolvers(CommandExecution.CommandExecutionHandlerMethodArgumentResolvers) - Method in class org.springframework.shell.Shell
- setBackgroundColor(int) - Method in class org.springframework.shell.component.view.control.BoxView
-
Sets a background color.
- setBackgroundColor(int) - Method in class org.springframework.shell.component.view.control.cell.AbstractCell
- setBackgroundColor(int) - Method in interface org.springframework.shell.component.view.control.cell.Cell
-
Sets a background color.
- setBackgroundColor(int) - Method in class org.springframework.shell.component.view.control.WindowView
-
Sets a background color.
- setBorderPadding(int, int, int, int) - Method in class org.springframework.shell.component.view.control.BoxView
-
Sets a paddings for this view.
- setCellFactory(BiFunction<ListView<T>, T, ListCell<T>>) - Method in class org.springframework.shell.component.view.control.ListView
- setColumnSize(int...) - Method in class org.springframework.shell.component.view.control.GridView
-
Defines how the columns of the grid are distributed.
- setCommandsFromArgs(Function<String[], List<String>>) - Method in class org.springframework.shell.jline.NonInteractiveShellRunner
-
Sets the function that creates the command() to run from the input application arguments.
- setCompletionResolvers(List<CompletionResolver>) - Method in class org.springframework.shell.Shell
- setConversionService(ConversionService) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
-
Sets a conversion service
- setConversionService(ConversionService) - Method in class org.springframework.shell.Shell
- setCursorPosition(Position) - Method in class org.springframework.shell.component.view.screen.DefaultScreen
- setCursorPosition(Position) - Method in interface org.springframework.shell.component.view.screen.Screen
-
Sets a cursor position.
- 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.
- setDefaultExpose(I) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent
-
Sets default expose item when component start.
- 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.
- setDescription(String) - Method in class org.springframework.shell.component.view.control.ProgressView
-
Sets a progress description.
- setDrawFunction(BiFunction<Screen, Rectangle, Rectangle>) - Method in class org.springframework.shell.component.view.control.AbstractView
-
Sets a callback function which is invoked after a
View
has been drawn. - 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
- setEventLoop(EventLoop) - Method in class org.springframework.shell.component.view.control.AbstractView
-
Set an
EventLoop
. - setEventLoop(EventLoop) - Method in class org.springframework.shell.component.view.control.DialogView
- setEventLoop(EventLoop) - Method in interface org.springframework.shell.component.view.control.View
-
Sets an
EventLoop
. - setEventType(EventLoop.Type) - Method in class org.springframework.shell.component.message.ShellMessageBuilder
- setExceptionResolvers(List<CommandExceptionResolver>) - Method in class org.springframework.shell.Shell
- setExitCodeExceptionProvider(ExitCodeExceptionProvider) - Method in class org.springframework.shell.Shell
- setFocus(View) - Method in interface org.springframework.shell.component.view.control.ViewService
-
Sets a view to be focused.
- setFocus(View) - Method in class org.springframework.shell.component.view.TerminalUI
- setFocusedTitleColor(int) - Method in class org.springframework.shell.component.view.control.BoxView
-
Sets a focused title color.
- setFocusedTitleStyle(int) - Method in class org.springframework.shell.component.view.control.BoxView
-
Sets a focused title style.
- setForegroundColor(int) - Method in class org.springframework.shell.component.view.control.cell.AbstractCell
- setForegroundColor(int) - Method in interface org.springframework.shell.component.view.control.cell.Cell
-
Sets a foreground color.
- setFullScreenViewRect(BiFunction<Terminal, View, Rectangle>) - Method in class org.springframework.shell.component.view.TerminalUI
-
Sets a view rect function for full screen mode.
- setHeader(String, Object) - Method in class org.springframework.shell.component.message.ShellMessageBuilder
- setHorizontalAlign(HorizontalAlign) - Method in class org.springframework.shell.component.view.control.cell.AbstractTextCell
- setHorizontalAlign(HorizontalAlign) - Method in interface org.springframework.shell.component.view.control.cell.TextCell
-
Sets horizontal align for a text to draw.
- setHotKey(Integer) - Method in class org.springframework.shell.component.view.control.MenuBarView.MenuBarItem
- setHotKey(Integer) - Method in class org.springframework.shell.component.view.control.StatusBarView.StatusItem
- 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.
- setItem(T) - Method in class org.springframework.shell.component.view.control.cell.AbstractCell
- setItem(T) - Method in interface org.springframework.shell.component.view.control.cell.Cell
-
Sets an item to bound into a cell.
- 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.
- setItems(List<MenuBarView.MenuBarItem>) - Method in class org.springframework.shell.component.view.control.MenuBarView
-
Sets items.
- setItems(List<MenuView.MenuItem>) - Method in class org.springframework.shell.component.view.control.MenuView
-
Sets a new menu items.
- setItems(List<StatusBarView.StatusItem>) - Method in class org.springframework.shell.component.view.control.StatusBarView
-
Sets items.
- setItems(List<T>) - Method in class org.springframework.shell.component.view.control.ListView
- 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
- setItemStyle(ListView.ItemStyle) - Method in class org.springframework.shell.component.view.control.cell.AbstractListCell
- setItemStyle(ListView.ItemStyle) - Method in interface org.springframework.shell.component.view.control.cell.ListCell
-
Set
ListView.ItemStyle
. - setLayer(int) - Method in class org.springframework.shell.component.view.control.AbstractView
- setLayer(int) - Method in class org.springframework.shell.component.view.control.DialogView
- setLayer(int) - Method in interface org.springframework.shell.component.view.control.View
-
Sets a layer index this
View
operates on. - setLineParser(Parser) - Method in class org.springframework.shell.jline.NonInteractiveShellRunner
-
Sets the line parser used to parse commands.
- 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
- setMenuBarVisible(boolean) - Method in class org.springframework.shell.component.view.control.AppView
-
Sets visibility for a
menubar
. - 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. - setMinSize(int, int) - Method in class org.springframework.shell.component.view.control.GridView
-
Sets an absolute minimum width for rows and an absolute minimum height for columns.
- setModal(View) - Method in interface org.springframework.shell.component.view.control.ViewService
-
Sets a new modal view.
- setModal(View) - Method in class org.springframework.shell.component.view.TerminalUI
- 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.
- setNonfullScreenViewRect(BiFunction<Terminal, View, Rectangle>) - Method in class org.springframework.shell.component.view.TerminalUI
-
Sets a view rect function for full screen mode.
- 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
. - setPriority(Integer) - Method in class org.springframework.shell.component.message.ShellMessageBuilder
- setQuoteChars(char[]) - Method in class org.springframework.shell.jline.ExtendedDefaultParser
- setReadOnlyHeaders(String...) - Method in class org.springframework.shell.component.message.ShellMessageHeaderAccessor
-
Specify a list of headers which should be considered as read only and prohibited from being populated in the message.
- setRect(int, int, int, int) - Method in class org.springframework.shell.component.view.control.AbstractControl
- setRect(int, int, int, int) - Method in class org.springframework.shell.component.view.control.BoxView
- setRect(int, int, int, int) - Method in interface org.springframework.shell.component.view.control.Control
-
Sets bounds where this
Control
should operate. - setRect(int, int, int, int) - Method in class org.springframework.shell.component.view.control.DialogView
- 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
- 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.
- setRoot(View, boolean) - Method in class org.springframework.shell.component.view.TerminalUI
-
Sets a root view.
- setRowSize(int...) - Method in class org.springframework.shell.component.view.control.GridView
-
For documentation see
GridView.setColumnSize(int...)
as it's equivalent for rows. - 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
- setSelected(boolean) - Method in class org.springframework.shell.component.view.control.cell.AbstractListCell
- setSelected(boolean) - Method in interface org.springframework.shell.component.view.control.cell.ListCell
-
Set selection state.
- setSelected(int) - Method in class org.springframework.shell.component.view.control.MenuBarView
-
Sets a selected index.
- setShowBorder(boolean) - Method in class org.springframework.shell.component.view.control.BoxView
-
Defines if border is shown.
- setShowBorders(boolean) - Method in class org.springframework.shell.component.view.control.GridView
-
Defines if borders is shown.
- setShowCursor(boolean) - Method in class org.springframework.shell.component.view.screen.DefaultScreen
- setShowCursor(boolean) - Method in interface org.springframework.shell.component.view.screen.Screen
-
Sets if cursor should be visible.
- setSpinner(Spinner) - Method in class org.springframework.shell.component.view.control.ProgressView
-
Sets an explicit spinner to use.
- setStatusBarVisible(boolean) - Method in class org.springframework.shell.component.view.control.AppView
-
Sets visibility for a
statusbar
. - setStyle(int) - Method in class org.springframework.shell.component.view.control.cell.AbstractCell
- setStyle(int) - Method in interface org.springframework.shell.component.view.control.cell.Cell
-
Sets a style.
- 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.
- 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.
- setText(String) - Method in class org.springframework.shell.component.view.control.ButtonView
- setThemeName(String) - Method in class org.springframework.shell.component.view.control.AbstractControl
-
Sets a theme name to use.
- setThemeName(String) - Method in class org.springframework.shell.component.view.control.AppView
- setThemeName(String) - Method in interface org.springframework.shell.component.view.control.Control
-
Sets a theme name to use.
- setThemeName(String) - Method in class org.springframework.shell.component.view.control.MenuBarView
- setThemeName(String) - Method in class org.springframework.shell.component.view.TerminalUI
-
Sets a
theme name
. - setThemeResolver(ThemeResolver) - Method in class org.springframework.shell.component.view.control.AbstractControl
-
Sets a
ThemeResolver
. - setThemeResolver(ThemeResolver) - Method in class org.springframework.shell.component.view.control.AppView
- setThemeResolver(ThemeResolver) - Method in interface org.springframework.shell.component.view.control.Control
-
Sets a
ThemeResolver
. - setThemeResolver(ThemeResolver) - Method in class org.springframework.shell.component.view.control.MenuBarView
- setThemeResolver(ThemeResolver) - Method in class org.springframework.shell.component.view.TerminalUI
-
Sets a
ThemeResolver
. - setTickValue(int) - Method in class org.springframework.shell.component.view.control.ProgressView
-
Sets a tick value.
- setTitle(String) - Method in class org.springframework.shell.component.view.control.BoxView
-
Sets a title.
- setTitleAlign(HorizontalAlign) - Method in class org.springframework.shell.component.view.control.BoxView
-
Sets a title align.
- setTitleColor(int) - Method in class org.springframework.shell.component.view.control.BoxView
-
Sets a title color.
- setTitleStyle(int) - Method in class org.springframework.shell.component.view.control.BoxView
-
Sets a title style.
- setUseTerminalWidth(boolean) - Method in class org.springframework.shell.component.ViewComponent
-
Sets if full terminal width should be used for a view.
- setValidator(Validator) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod
- setValidatorFactory(ValidatorFactory) - Method in class org.springframework.shell.Shell
- setVerticalAlign(VerticalAlign) - Method in class org.springframework.shell.component.view.control.cell.AbstractTextCell
- setVerticalAlign(VerticalAlign) - Method in interface org.springframework.shell.component.view.control.cell.TextCell
-
Sets vertical align for a text to draw.
- setView(View) - Method in class org.springframework.shell.component.message.ShellMessageBuilder
- setViewService(ViewService) - Method in class org.springframework.shell.component.view.control.AbstractView
-
Set a
ViewService
- setViewService(ViewService) - Method in interface org.springframework.shell.component.view.control.View
-
Sets a
ViewService
. - Seven - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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
. - 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.
- ShellConversionServiceSupplier - Interface in org.springframework.shell.config
-
Interface to provide shell spesific
ConversionService
. - ShellMessageBuilder<T> - Class in org.springframework.shell.component.message
-
Shell spesific message builder.
- ShellMessageHeaderAccessor - Class in org.springframework.shell.component.message
-
Adds standard shell Headers.
- ShellMessageHeaderAccessor(Message<?>) - Constructor for class org.springframework.shell.component.message.ShellMessageHeaderAccessor
- 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
- ShellRunner - Interface in org.springframework.shell
-
Interface for shell runners.
- Shift - Static variable in class org.springframework.shell.component.view.event.MouseEvent.Modifier
- ShiftMask - Static variable in class org.springframework.shell.component.view.event.KeyEvent.KeyMask
- shortcut(Integer, Runnable) - Method in class org.springframework.shell.component.view.control.AbstractView
- 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.
- SIENNA - Static variable in class org.springframework.shell.component.view.screen.Color
- SIENNA1 - Static variable in class org.springframework.shell.component.view.screen.Color
- SIENNA2 - Static variable in class org.springframework.shell.component.view.screen.Color
- SIENNA3 - Static variable in class org.springframework.shell.component.view.screen.Color
- SIENNA4 - Static variable in class org.springframework.shell.component.view.screen.Color
- SIGNAL - Enum constant in enum class org.springframework.shell.component.view.event.EventLoop.Type
-
Signals dispatched from a terminal.
- signalEvents() - Method in class org.springframework.shell.component.view.event.DefaultEventLoop
- signalEvents() - Method in interface org.springframework.shell.component.view.event.EventLoop
-
Specialisation of
EventLoop.events()
which returns type safe {code signal} events. - 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 -
Context
SingleItemSelector
. - SingleItemSelectorSpec - Interface in org.springframework.shell.component.flow
-
Interface for single item selector spec builder.
- SingleQuote - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- Six - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- SKYBLUE - Static variable in class org.springframework.shell.component.view.screen.Color
- SKYBLUE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- SKYBLUE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- SKYBLUE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- SKYBLUE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- Slash - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- SLATEBLUE - Static variable in class org.springframework.shell.component.view.screen.Color
- SLATEBLUE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- SLATEBLUE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- SLATEBLUE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- SLATEBLUE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- SLATEGRAY - Static variable in class org.springframework.shell.component.view.screen.Color
- SLATEGRAY1 - Static variable in class org.springframework.shell.component.view.screen.Color
- SLATEGRAY2 - Static variable in class org.springframework.shell.component.view.screen.Color
- SLATEGRAY3 - Static variable in class org.springframework.shell.component.view.screen.Color
- SLATEGRAY4 - Static variable in class org.springframework.shell.component.view.screen.Color
- SNAKECASE - Static variable in class org.springframework.shell.command.support.OptionNameModifierSupport
- SNOW - Static variable in class org.springframework.shell.component.view.screen.Color
- SNOW1 - Static variable in class org.springframework.shell.component.view.screen.Color
- SNOW2 - Static variable in class org.springframework.shell.component.view.screen.Color
- SNOW3 - Static variable in class org.springframework.shell.component.view.screen.Color
- SNOW4 - Static variable in class org.springframework.shell.component.view.screen.Color
- 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 - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- SpecialMask - Static variable in class org.springframework.shell.component.view.event.KeyEvent.KeyMask
- Spinner - Interface in org.springframework.shell.component.view.control
-
Spinner
represents how user is notified that something is happening using a traditional spinner concept. - spinners() - Method in class org.springframework.shell.style.ThemeSettings
-
Gets a
SpinnerSettings
. - SpinnerSettings - Class in org.springframework.shell.style
-
Base class defining a settings for spinners.
- SpinnerSettings() - Constructor for class org.springframework.shell.style.SpinnerSettings
- split(T[], Predicate<T>) - Static method in class org.springframework.shell.Utils
-
Split array into list of lists by predicate
- SPRINGGREEN - Static variable in class org.springframework.shell.component.view.screen.Color
- SPRINGGREEN1 - Static variable in class org.springframework.shell.component.view.screen.Color
- SPRINGGREEN2 - Static variable in class org.springframework.shell.component.view.screen.Color
- SPRINGGREEN3 - Static variable in class org.springframework.shell.component.view.screen.Color
- SPRINGGREEN4 - Static variable in class org.springframework.shell.component.view.screen.Color
- start() - Method in class org.springframework.shell.component.view.control.ProgressView
-
Starts a runtime logic.
- start(Runnable) - Method in class org.springframework.shell.component.ViewComponentExecutor
-
Execute runnable and return state which can be used for further operations.
- startTime() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressState
-
Returns the value of the
startTime
record component. - state() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewStateEventArgs
-
Returns the value of the
state
record component. - StaticShellMessageHeaderAccessor - Class in org.springframework.shell.component.message
-
Lightweight type-safe header accessor avoiding object creation just to access a header.
- status() - Method in exception org.springframework.shell.ExitRequest
-
The exit code to be returned when the process exits.
- statusbarBackground() - Method in class org.springframework.shell.style.StyleSettings
- StatusBarView - Class in org.springframework.shell.component.view.control
-
StatusBarView
showsitems
horizontally and is typically used in layouts which builds complete terminal UI's. - StatusBarView() - Constructor for class org.springframework.shell.component.view.control.StatusBarView
- StatusBarView(List<StatusBarView.StatusItem>) - Constructor for class org.springframework.shell.component.view.control.StatusBarView
- StatusBarView(StatusBarView.StatusItem[]) - Constructor for class org.springframework.shell.component.view.control.StatusBarView
- StatusBarView.StatusBarViewItemEventArgs - Record Class in org.springframework.shell.component.view.control
- StatusBarView.StatusBarViewOpenSelectedItemEvent - Record Class in org.springframework.shell.component.view.control
-
ViewEvent
indicating that selected item has been requested to open. - StatusBarView.StatusItem - Class in org.springframework.shell.component.view.control
-
StatusBarView.StatusItem
represents an item in aStatusBarView
. - StatusBarViewItemEventArgs(StatusBarView.StatusItem) - Constructor for record class org.springframework.shell.component.view.control.StatusBarView.StatusBarViewItemEventArgs
-
Creates an instance of a
StatusBarViewItemEventArgs
record class. - StatusBarViewOpenSelectedItemEvent(View, StatusBarView.StatusBarViewItemEventArgs) - Constructor for record class org.springframework.shell.component.view.control.StatusBarView.StatusBarViewOpenSelectedItemEvent
-
Creates an instance of a
StatusBarViewOpenSelectedItemEvent
record class. - StatusItem(String) - Constructor for class org.springframework.shell.component.view.control.StatusBarView.StatusItem
- StatusItem(String, Runnable) - Constructor for class org.springframework.shell.component.view.control.StatusBarView.StatusItem
- StatusItem(String, Runnable, Integer) - Constructor for class org.springframework.shell.component.view.control.StatusBarView.StatusItem
- STEELBLUE - Static variable in class org.springframework.shell.component.view.screen.Color
- STEELBLUE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- STEELBLUE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- STEELBLUE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- STEELBLUE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- stop() - Method in class org.springframework.shell.component.view.control.ProgressView
-
Stops a runtime logic.
- stop() - Method in class org.springframework.shell.component.ViewComponentExecutor
-
Stop a
ViewComponent
which has been previously started with this executor. - 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
intoComponentContext
with key given to builder. - storeResult(boolean) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec
-
Automatically stores result from a
MultiItemSelector.MultiItemSelectorContext
intoComponentContext
with key given to builder. - storeResult(boolean) - Method in interface org.springframework.shell.component.flow.PathInputSpec
-
Automatically stores result from a
StringInput.StringInputContext
intoComponentContext
with key given to builder. - storeResult(boolean) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec
-
Automatically stores result from a
SingleItemSelector.SingleItemSelectorContext
intoComponentContext
with key given to builder. - storeResult(boolean) - Method in interface org.springframework.shell.component.flow.StringInputSpec
-
Automatically stores result from a
StringInput.StringInputContext
intoComponentContext
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 intojline
StyleExpression
based on theming settings. - StringToStyleExpressionRenderer(ThemeResolver) - Constructor for class org.springframework.shell.style.StringToStyleExpressionRenderer
- style() - Method in record class org.springframework.shell.style.ThemeResolver.ResolvedValues
-
Returns the value of the
style
record component. - style(int) - Method in interface org.springframework.shell.component.view.screen.Screen.WriterBuilder
-
Define a style this
Screen.Writer
operates on. - STYLE_BLINK - Static variable in interface org.springframework.shell.component.view.screen.ScreenItem
- STYLE_BOLD - Static variable in interface org.springframework.shell.component.view.screen.ScreenItem
- STYLE_CONCEAL - Static variable in interface org.springframework.shell.component.view.screen.ScreenItem
- STYLE_CROSSEDOUT - Static variable in interface org.springframework.shell.component.view.screen.ScreenItem
- STYLE_FAINT - Static variable in interface org.springframework.shell.component.view.screen.ScreenItem
- STYLE_INVERSE - Static variable in interface org.springframework.shell.component.view.screen.ScreenItem
- STYLE_ITALIC - Static variable in interface org.springframework.shell.component.view.screen.ScreenItem
- STYLE_UNDERLINE - Static variable in interface org.springframework.shell.component.view.screen.ScreenItem
- styles() - Method in class org.springframework.shell.style.ThemeSettings
-
Gets a
StyleSettings
. - StyleSettings - Class in org.springframework.shell.style
-
Base class defining a settings for styles.
- StyleSettings() - Constructor for class org.springframework.shell.style.StyleSettings
- subscribeTo(Publisher<? extends Message<?>>) - Method in class org.springframework.shell.component.view.event.DefaultEventLoop
- 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
. - SYSTEM - Enum constant in enum class org.springframework.shell.component.view.event.EventLoop.Type
-
System bindinds like redraw.
- systemEvents() - Method in class org.springframework.shell.component.view.event.DefaultEventLoop
- systemEvents() - Method in interface org.springframework.shell.component.view.event.EventLoop
-
Specialisation of
EventLoop.events()
which returns type safe {code system} events.
T
- t - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- T - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- Tab - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- TAG_BACKGROUND - Static variable in class org.springframework.shell.style.StyleSettings
-
Styling for something which has a background.
- TAG_BUTTON_BACKGROUND - Static variable in class org.springframework.shell.style.StyleSettings
-
Styling for button background.
- 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_DIALOG_BACKGROUND - Static variable in class org.springframework.shell.style.StyleSettings
-
Styling for dialog background.
- TAG_DOT - Static variable in class org.springframework.shell.style.SpinnerSettings
-
Spinner with dot characters.
- 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_LINE - Static variable in class org.springframework.shell.style.SpinnerSettings
-
Spinner with line characters.
- 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_MENUBAR_BACKGROUND - Static variable in class org.springframework.shell.style.StyleSettings
-
Styling for menubar background.
- 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_STATUSBAR_BACKGROUND - Static variable in class org.springframework.shell.style.StyleSettings
-
Styling for statusbar background.
- 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.SpinnerSettings
- tags() - Static method in class org.springframework.shell.style.StyleSettings
-
Gets all tags.
- TAN - Static variable in class org.springframework.shell.component.view.screen.Color
- TAN1 - Static variable in class org.springframework.shell.component.view.screen.Color
- TAN2 - Static variable in class org.springframework.shell.component.view.screen.Color
- TAN3 - Static variable in class org.springframework.shell.component.view.screen.Color
- TAN4 - Static variable in class org.springframework.shell.component.view.screen.Color
- TASK - Enum constant in enum class org.springframework.shell.component.view.event.EventLoop.Type
- TaskEventLoopProcessor - Class in org.springframework.shell.component.view.event.processor
- TaskEventLoopProcessor() - Constructor for class org.springframework.shell.component.view.event.processor.TaskEventLoopProcessor
- 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
-
Sets a
TemplateExecutor
. - 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
. - TerminalAstNode - Class in org.springframework.shell.command.parser
-
Terminal
node means that it is end ofast 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
- terminalNodes() - Method in record class org.springframework.shell.command.parser.Ast.AstResult
-
Returns the value of the
terminalNodes
record component. - terminalSizeAwareResultHandler(Terminal) - Method in class org.springframework.shell.result.ResultHandlerConfig
- TerminalSizeAwareResultHandler - Class in org.springframework.shell.result
-
A ResultHandler that prints
TerminalSizeAware
according to theTerminal
size. - TerminalSizeAwareResultHandler(Terminal) - Constructor for class org.springframework.shell.result.TerminalSizeAwareResultHandler
- TerminalUI - Class in org.springframework.shell.component.view
-
TerminalUI
is a main component orchestrating terminal, eventloop, key/mouse events and view structure to work together. - TerminalUI(Terminal) - Constructor for class org.springframework.shell.component.view.TerminalUI
-
Constructs a handler with a given terminal.
- TerminalUIBuilder - Class in org.springframework.shell.component.view
-
Builder that can be used to configure and create a
TerminalUI
. - TerminalUIBuilder(Terminal, Set<TerminalUICustomizer>, ThemeResolver, String) - Constructor for class org.springframework.shell.component.view.TerminalUIBuilder
-
Create a new
TerminalUIBuilder
instance. - TerminalUIBuilder(Terminal, TerminalUICustomizer...) - Constructor for class org.springframework.shell.component.view.TerminalUIBuilder
-
Create a new
TerminalUIBuilder
instance. - TerminalUICustomizer - Interface in org.springframework.shell.component.view
-
Callback interface that can be used to customize a
TerminalUI
. - text() - Method in interface org.springframework.shell.result.CommandNotFoundMessageProvider.ProviderContext
-
Gets a raw input text.
- text(String, int, int) - Method in interface org.springframework.shell.component.view.screen.Screen.Writer
- text(String, Rectangle, HorizontalAlign, VerticalAlign) - Method in interface org.springframework.shell.component.view.screen.Screen.Writer
-
Write aligned text within a bounds.
- TextCell<T> - Interface in org.springframework.shell.component.view.control.cell
-
Extension of a
Cell
to make it aware of an item style and selection state. - TextCell.DefaultTextCell<T> - Class in org.springframework.shell.component.view.control.cell
- Theme - Interface in org.springframework.shell.style
-
Contract representing a theme with its name and settings.
- ThemeActive - Interface in org.springframework.shell.style
- themeName(String) - Method in class org.springframework.shell.component.view.TerminalUIBuilder
-
Sets a
theme name
forTerminalUI
to build. - themeNames() - Method in class org.springframework.shell.style.ThemeResolver
-
Return all known theme names.
- 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(ThemeResolver) - Method in class org.springframework.shell.component.view.TerminalUIBuilder
-
Sets a
ThemeResolver
forTerminalUI
to build. - 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
- ThemeResolver.ResolvedValues - Record Class in org.springframework.shell.style
-
Stores resolved values for
ThemeResolver.resolveValues(AttributedStyle)
. - 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) - Constructor for class org.springframework.shell.style.ThemeSettings
-
Creates theme settings with styles.
- ThemeSettings(StyleSettings, FigureSettings) - Constructor for class org.springframework.shell.style.ThemeSettings
-
Creates theme settings with styles and figures.
- ThemeSettings(StyleSettings, FigureSettings, SpinnerSettings) - Constructor for class org.springframework.shell.style.ThemeSettings
-
Creates theme settings with styles, figures and spinners.
- thenConditionally(KeyHandler, Predicate<KeyHandler.KeyHandlerResult>) - Method in interface org.springframework.shell.component.view.event.KeyHandler
-
Returns a composed handler that first handles
this
handler and then handlesother
handler ifpredicate
against result fromthis
matches. - thenConditionally(MouseHandler, Predicate<MouseHandler.MouseHandlerResult>) - Method in interface org.springframework.shell.component.view.event.MouseHandler
-
Returns a composed handler that first handles
this
handler and then handlesother
handler ifpredicate
against result fromthis
matches. - thenIfConsumed(KeyHandler) - Method in interface org.springframework.shell.component.view.event.KeyHandler
-
Returns a composed handler that first handles
this
handler and then handlesother
ifthis
consumed an event. - thenIfConsumed(MouseHandler) - Method in interface org.springframework.shell.component.view.event.MouseHandler
-
Returns a composed handler that first handles
this
handler and then handlesother
ifthis
consumed an event. - thenIfNotConsumed(KeyHandler) - Method in interface org.springframework.shell.component.view.event.KeyHandler
-
Returns a composed handler that first handles
this
handler and then handlesother
ifthis
did not consume an event. - thenIfNotConsumed(MouseHandler) - Method in interface org.springframework.shell.component.view.event.MouseHandler
-
Returns a composed handler that first handles
this
handler and then handlesother
ifthis
did not consume an event. - THISTLE - Static variable in class org.springframework.shell.component.view.screen.Color
- THISTLE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- THISTLE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- THISTLE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- THISTLE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- Three - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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
- tickAdvance(int) - Method in class org.springframework.shell.component.view.control.ProgressView
-
Advance
tickValue
by a given count. - tickEnd() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressState
-
Returns the value of the
tickEnd
record component. - tickStart() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressState
-
Returns the value of the
tickStart
record component. - tickValue() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressState
-
Returns the value of the
tickValue
record component. - Tilde - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- title() - Method in class org.springframework.shell.style.StyleSettings
- toCamelCase(String) - Static method in class org.springframework.shell.command.support.OptionNameModifierSupport
-
Convert given name to
camelCase
. - toggle(MenuView.MenuItem) - Method in class org.springframework.shell.component.view.control.MenuView
-
Toggle
MenuView.MenuItem
checked state. - toggleMenuBarVisibility() - Method in class org.springframework.shell.component.view.control.AppView
-
Toggles a
menubar
visibility. - toggleStatusBarVisibility() - Method in class org.springframework.shell.component.view.control.AppView
-
Toggles a
statusbar
visibility. - 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
- toMap() - Method in class org.springframework.shell.component.message.ShellMessageHeaderAccessor
- TOMATO - Static variable in class org.springframework.shell.component.view.screen.Color
- TOMATO1 - Static variable in class org.springframework.shell.component.view.screen.Color
- TOMATO2 - Static variable in class org.springframework.shell.component.view.screen.Color
- TOMATO3 - Static variable in class org.springframework.shell.component.view.screen.Color
- TOMATO4 - Static variable in class org.springframework.shell.component.view.screen.Color
- TOO_MANY_OPTION_ARGUMENTS - Enum constant in enum class org.springframework.shell.command.parser.ParserMessage
- TOP - Enum constant in enum class org.springframework.shell.geom.VerticalAlign
- toPascalCase(String) - Static method in class org.springframework.shell.command.support.OptionNameModifierSupport
-
Convert given name to
PascalCase
. - 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 record class org.springframework.shell.component.view.control.AppView.AppViewEvent
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.control.AppView.AppViewEventArgs
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.control.ButtonView.ButtonViewItemEventArgs
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.control.ButtonView.ButtonViewSelectEvent
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.control.DialogView.DialogViewCloseEvent
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.control.DialogView.DialogViewItemEventArgs
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.control.InputView.InputViewTextChangeEvent
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.control.InputView.InputViewTextChangeEventArgs
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.control.ListView.ListViewItemEventArgs
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.control.ListView.ListViewOpenSelectedItemEvent
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.control.ListView.ListViewSelectedItemChangedEvent
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.control.MenuView.MenuViewItemEventArgs
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.control.MenuView.MenuViewOpenSelectedItemEvent
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.control.MenuView.MenuViewSelectedItemChangedEvent
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressState
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewEndEvent
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewStartEvent
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewStateChangeEvent
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewStateEventArgs
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.control.StatusBarView.StatusBarViewItemEventArgs
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.control.StatusBarView.StatusBarViewOpenSelectedItemEvent
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.control.ViewDoneEvent.GenericViewDoneEvent
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.event.KeyBindingConsumerArgs
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.event.KeyEvent
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.event.KeyHandler.KeyHandlerArgs
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.event.KeyHandler.KeyHandlerResult
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.event.MouseBindingConsumerArgs
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.event.MouseEvent
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.event.MouseHandler.MouseHandlerArgs
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.component.view.event.MouseHandler.MouseHandlerResult
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.geom.Dimension
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.geom.Position
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.geom.Rectangle
-
Returns a string representation of this record class.
- toString() - Method in record class org.springframework.shell.style.ThemeResolver.ResolvedValues
-
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
- TURQUOISE - Static variable in class org.springframework.shell.component.view.screen.Color
- TURQUOISE1 - Static variable in class org.springframework.shell.component.view.screen.Color
- TURQUOISE2 - Static variable in class org.springframework.shell.component.view.screen.Color
- TURQUOISE3 - Static variable in class org.springframework.shell.component.view.screen.Color
- TURQUOISE4 - Static variable in class org.springframework.shell.component.view.screen.Color
- Two - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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. - Type() - Constructor for class org.springframework.shell.component.view.event.MouseEvent.Type
- TypeMask - Static variable in class org.springframework.shell.component.view.event.MouseEvent.MouseMask
U
- u - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- U - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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.
- Unicode - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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. - updateTime() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressState
-
Returns the value of the
updateTime
record component. - upToCursor() - Method in class org.springframework.shell.CompletionContext
- upwardsArrow() - Method in class org.springframework.shell.style.FigureSettings
- USER - Enum constant in enum class org.springframework.shell.component.view.event.EventLoop.Type
-
User bindinds for custom events.
- UserConfigPathProvider - Interface in org.springframework.shell.config
-
Interface providing a
Path
to a location where user level runtime configuration files are strored. - Utils - Class in org.springframework.shell
-
Some text utilities.
- Utils() - Constructor for class org.springframework.shell.Utils
V
- v - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- V - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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() - Method in class org.springframework.shell.style.StyleSettings
- value(String) - Method in class org.springframework.shell.CompletionProposal
- 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.component.view.control.AppView.AppViewEventArgs.Direction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.shell.component.view.control.ListView.ItemStyle
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.shell.component.view.control.MenuView.MenuItemCheckStyle
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.shell.component.view.event.EventLoop.Type
-
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.geom.HorizontalAlign
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.shell.geom.VerticalAlign
-
Returns the enum constant of this class with the specified name.
- 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
- 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.component.view.control.AppView.AppViewEventArgs.Direction
-
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.view.control.ListView.ItemStyle
-
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.view.control.MenuView.MenuItemCheckStyle
-
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.view.event.EventLoop.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.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.geom.HorizontalAlign
-
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.geom.VerticalAlign
-
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. - verifyType(String, Object) - Method in class org.springframework.shell.component.message.ShellMessageHeaderAccessor
- VerticalAlign - Enum Class in org.springframework.shell.geom
- view() - Method in record class org.springframework.shell.component.view.control.AppView.AppViewEvent
-
Returns the value of the
view
record component. - view() - Method in record class org.springframework.shell.component.view.control.ButtonView.ButtonViewSelectEvent
-
Returns the value of the
view
record component. - view() - Method in record class org.springframework.shell.component.view.control.DialogView.DialogViewCloseEvent
-
Returns the value of the
view
record component. - view() - Method in record class org.springframework.shell.component.view.control.InputView.InputViewTextChangeEvent
-
Returns the value of the
view
record component. - view() - Method in record class org.springframework.shell.component.view.control.ListView.ListViewOpenSelectedItemEvent
-
Returns the value of the
view
record component. - view() - Method in record class org.springframework.shell.component.view.control.ListView.ListViewSelectedItemChangedEvent
-
Returns the value of the
view
record component. - view() - Method in record class org.springframework.shell.component.view.control.MenuView.MenuViewOpenSelectedItemEvent
-
Returns the value of the
view
record component. - view() - Method in record class org.springframework.shell.component.view.control.MenuView.MenuViewSelectedItemChangedEvent
-
Returns the value of the
view
record component. - view() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewEndEvent
-
Returns the value of the
view
record component. - view() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewStartEvent
-
Returns the value of the
view
record component. - view() - Method in record class org.springframework.shell.component.view.control.ProgressView.ProgressViewStateChangeEvent
-
Returns the value of the
view
record component. - view() - Method in record class org.springframework.shell.component.view.control.StatusBarView.StatusBarViewOpenSelectedItemEvent
-
Returns the value of the
view
record component. - view() - Method in record class org.springframework.shell.component.view.control.ViewDoneEvent.GenericViewDoneEvent
-
Returns the value of the
view
record component. - view() - Method in interface org.springframework.shell.component.view.control.ViewEvent
- View - Interface in org.springframework.shell.component.view.control
-
Base interface for all views.
- VIEW - Enum constant in enum class org.springframework.shell.component.view.event.EventLoop.Type
-
View bindinds from views.
- VIEW - Static variable in class org.springframework.shell.component.message.ShellMessageHeaderAccessor
- ViewCommand - Class in org.springframework.shell.component.view.control
-
Commands which can be performed by the application or bound to keys in a
View
. - ViewCommand() - Constructor for class org.springframework.shell.component.view.control.ViewCommand
- ViewComponent - Class in org.springframework.shell.component
-
Handles view execution in a non-fullscreen setup.
- ViewComponent(TerminalUI, Terminal, ViewComponentExecutor, View) - Constructor for class org.springframework.shell.component.ViewComponent
-
Construct view component with a given
Terminal
andView
. - ViewComponent.ViewComponentRun - Interface in org.springframework.shell.component
-
Represent run state of an async run of a component.
- ViewComponentBuilder - Class in org.springframework.shell.component
-
Builder that can be used to configure and create a
ViewComponent
. - ViewComponentBuilder(TerminalUIBuilder, ViewComponentExecutor, Terminal) - Constructor for class org.springframework.shell.component.ViewComponentBuilder
- ViewComponentExecutor - Class in org.springframework.shell.component
-
Executor for
ViewComponent
. - ViewComponentExecutor() - Constructor for class org.springframework.shell.component.ViewComponentExecutor
- ViewDoneEvent - Interface in org.springframework.shell.component.view.control
- ViewDoneEvent.GenericViewDoneEvent - Record Class in org.springframework.shell.component.view.control
- ViewEvent - Interface in org.springframework.shell.component.view.control
-
Base interface for view events.
- ViewEventArgs - Interface in org.springframework.shell.component.view.control
-
Base interface for view event args.
- viewEvents(Class<T>) - Method in class org.springframework.shell.component.view.event.DefaultEventLoop
- viewEvents(Class<T>) - Method in interface org.springframework.shell.component.view.event.EventLoop
-
Specialisation of
EventLoop.events()
which returns type safeViewEvent
s. - viewEvents(Class<T>, View) - Method in class org.springframework.shell.component.view.event.DefaultEventLoop
- viewEvents(Class<T>, View) - Method in interface org.springframework.shell.component.view.event.EventLoop
-
Specialisation of
EventLoop.events()
which returns type safeViewEvent
s. - viewEvents(ParameterizedTypeReference<T>) - Method in class org.springframework.shell.component.view.event.DefaultEventLoop
- viewEvents(ParameterizedTypeReference<T>) - Method in interface org.springframework.shell.component.view.event.EventLoop
-
Specialisation of
EventLoop.events()
which returns type safeViewEvent
s. - viewEvents(ParameterizedTypeReference<T>, View) - Method in class org.springframework.shell.component.view.event.DefaultEventLoop
- viewEvents(ParameterizedTypeReference<T>, View) - Method in interface org.springframework.shell.component.view.event.EventLoop
-
Specialisation of
EventLoop.events()
which returns type safeViewEvent
s. - ViewService - Interface in org.springframework.shell.component.view.control
-
Provides services for a
View
like handling modals. - VIOLETRED - Static variable in class org.springframework.shell.component.view.screen.Color
- VIOLETRED1 - Static variable in class org.springframework.shell.component.view.screen.Color
- VIOLETRED2 - Static variable in class org.springframework.shell.component.view.screen.Color
- VIOLETRED3 - Static variable in class org.springframework.shell.component.view.screen.Color
- VIOLETRED4 - Static variable in class org.springframework.shell.component.view.screen.Color
- 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.
W
- w - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- W - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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
- WHEAT - Static variable in class org.springframework.shell.component.view.screen.Color
- WHEAT1 - Static variable in class org.springframework.shell.component.view.screen.Color
- WHEAT2 - Static variable in class org.springframework.shell.component.view.screen.Color
- WHEAT3 - Static variable in class org.springframework.shell.component.view.screen.Color
- WHEAT4 - Static variable in class org.springframework.shell.component.view.screen.Color
- Wheel - Static variable in class org.springframework.shell.component.view.event.MouseEvent.Type
- WheelDown - Static variable in class org.springframework.shell.component.view.event.MouseEvent.Button
- WheelUp - Static variable in class org.springframework.shell.component.view.event.MouseEvent.Button
- WHITE - Static variable in class org.springframework.shell.component.view.screen.Color
- width() - Method in record class org.springframework.shell.geom.Dimension
-
Returns the value of the
width
record component. - width() - Method in record class org.springframework.shell.geom.Rectangle
-
Returns the value of the
width
record component. - WindowView - Class in org.springframework.shell.component.view.control
-
WindowView
is aView
defining area within view itself. - WindowView() - Constructor for class org.springframework.shell.component.view.control.WindowView
- 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.
- withPayload(T) - Static method in class org.springframework.shell.component.message.ShellMessageBuilder
-
Create a builder for a new
Message
instance with the provided payload. - 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
- writerBuilder() - Method in class org.springframework.shell.component.view.screen.DefaultScreen
- writerBuilder() - Method in interface org.springframework.shell.component.view.screen.Screen
-
Gets a new instance of a
Screen.WriterBuilder
.
X
- x - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- x() - Method in record class org.springframework.shell.component.view.event.MouseEvent
-
Returns the value of the
x
record component. - x() - Method in record class org.springframework.shell.geom.Position
-
Returns the value of the
x
record component. - x() - Method in record class org.springframework.shell.geom.Rectangle
-
Returns the value of the
x
record component. - X - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
Y
- y - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- y() - Method in record class org.springframework.shell.component.view.event.MouseEvent
-
Returns the value of the
y
record component. - y() - Method in record class org.springframework.shell.geom.Position
-
Returns the value of the
y
record component. - y() - Method in record class org.springframework.shell.geom.Rectangle
-
Returns the value of the
y
record component. - Y - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- YELLOW - Static variable in class org.springframework.shell.component.view.screen.Color
- YELLOW1 - Static variable in class org.springframework.shell.component.view.screen.Color
- YELLOW2 - Static variable in class org.springframework.shell.component.view.screen.Color
- YELLOW3 - Static variable in class org.springframework.shell.component.view.screen.Color
- YELLOW4 - Static variable in class org.springframework.shell.component.view.screen.Color
Z
- z - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- Z - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- Zero - Static variable in class org.springframework.shell.component.view.event.KeyEvent.Key
- 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).
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form