All Classes and Interfaces
Class
Description
Abstract base class to resolve method arguments from a named value, e.g.
Represents a named value declaration.
Base class for components.
AbstractSelectorComponent<T,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>,I extends Nameable & Matchable & Enableable & Selectable & Itemable<T>>
Base component for selectors which provide selectable lists.
AbstractSelectorComponent.BaseSelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>
Base implementation of a
AbstractSelectorComponent.SelectorComponentContext.Class keeping item state.
AbstractSelectorComponent.SelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>>
Context interface on a selector component sharing content.
Base class for components which work on a simple text input.
AbstractTextComponent.BaseTextComponentContext<T,C extends AbstractTextComponent.TextComponentContext<T,C>>
AbstractTextComponent.TextComponentContext<T,C extends AbstractTextComponent.TextComponentContext<T,C>>
Message levels which can be used to alter how message is shown.
Resolver for
@Header arguments.A
ResultHandler that knows how to render JLine's AttributedCharSequence.Indicates whether or not a command is currently available.
Base implementation of a
ComponentContext.Base impl for
ConfirmationInputSpec.Base impl for specs.
Base spec for other specs.
Base impl for
MultiItemSelectorSpec.Base impl for
PathInputSpec.Base impl for
SingleItemSelectorSpec.Base impl for
StringInputSpec.Encapsulates help metadata about a shell command.
Interface representing an alias in a command.
Default implementation of
CommandAlias.Interface defining contract to handle existing
CommandRegistrations.Default implementation of a
CommandCatalog.Interface to customize a
CommandCatalog.Interface containing information about current command execution.
Default implementation of a
CommandContext.Implementation of a
HandlerMethodArgumentResolver resolving
CommandContext.Interface to be implemented by objects that can resolve exceptions thrown
during command processing, in the typical case error response.
Interface to evaluate a result from a command with an arguments.
Default implementation of a
CommandExecution.Interface representing an exit code in a command.
Holder for handling some processing, typically with
CommandExceptionResolver.Indicates that a command exists but is currently not invokable.
A result to be handled by the
ResultHandler when no command could be mapped to user inputInterface representing an option in a command.
Default implementation of
CommandOption.Interface parsing arguments for a
CommandRegistration.Result of a parsing
CommandOption with an argument.Results of a
CommandParser.Default implementation of a
CommandParser.Default implementation of a
CommandParser.CommandParserResult.Default implementation of a
CommandParser.CommandParserResults.Interface defining a command registration endpoint.
Spec defining an alias.
Builder interface for
CommandRegistration.Interface used to supply instance of a
CommandRegistration.Builder.Spec defining an error handling.
Spec defining an exit code.
Spec defining help options.
Enumeration of option arity values.
Interface used to modify option long name.
Spec defining an option.
Encapsulates info for
CommandRegistration.TargetSpec.Spec defining a target.
Interface to resolve currently existing commands.
An extension of
ParsedLine that, being aware of the quoting and escaping rules
of the Parser that produced it, knows if and how a completion candidate
should be escaped/quoted.Represents the buffer context in which completion was triggered.
Represents a proposal for TAB completion, made not only of the text to append, but also metadata about the proposal.
Interface resolving completion proposals.
Contract for base component context having access to basic key/value pairs.
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.
Interface for a wizard builder.
Results from a flow run.
Component for a confirmation question.
Interface for string input spec builder.
Default impl for
BaseConfirmationInput.Default impl for
BaseMultiItemSelector.Default impl for
BasePathInput.A simple
ResultHandler that deals with Objects (hence comes as a last resort)
and prints the Object.toString() value of results to standard out.Default impl for
SelectItem.Default
ShellApplicationRunner which dispatches to the first ordered ShellRunner able to handle
the shell.Default implementation of a
ShellContext.Default impl for
BaseSingleItemSelector.Default impl for
BaseStringInput.Annotation for handling exceptions in specific command classes and/or its methods.
Defines exit code.
Interface to provide exception for an exit code.
Interface used with implementation of a boot's ExitCodeExceptionMapper
in a context of spring-shell spesific one.
This exception, when thrown and caught, will ask the shell to gracefully shutdown.
Shameful copy-paste of JLine's
DefaultParser which
creates CompletingParsedLine.Base class defining a settings for figures.
An
InputProvider that reads input from file-like sources.Base implementation suitable for use in most
environments.
Represents the input buffer to the shell.
To be implemented by components able to provide a "line" of user input, whether interactively or by batch.
Enumeration for modes shell is operating.
A
ShellRunner that bootstraps the shell in interactive mode.Strategy interface for registering commands.
Component able to pick multiple items.
Context
MultiItemSelector.Interface for multi input spec builder.
A
ShellRunner that executes commands without entering interactive shell mode.Support facilities for
CommandRegistration.OptionNameModifier providing common naming
types.Thrown when no ParameterResolver is found for a parameter during a resolve
operation.
Thrown when one or more parameters fail bean validation constraints.
Displays validation errors on the terminal.
Component for a simple path input.
Interface for path input spec builder.
Component resolving
Path based on base path and optional search term.Result from a path scanning.
Class defining configuration for path search.
Context for
PathSearch.Domain class for path view item.
Holder class keeping
Path and SearchMatchResult.Called at each REPL cycle to decide what the prompt should be.
Default implementation of a
CompletionResolver.Implementations know how to deal with results of method invocations, whether normal results or exceptions thrown.
Used for explicit configuration of
ResultHandlers.A service interface for result handling.
Enumeration of a modes instructing how
resultValue is handled.A
ShellRunner that looks for process arguments that start with @, which are then interpreted as
references to script files to run and exit.Interface defining a search match for
text agains pattern.Defines an interface for
SearchMatch.Interface to match given text with a pattern into a result.
Interface defining result used in
SearchMatch.Interface for selectitem contract in selectors.
Main class implementing a shell loop.
Marker interface for a main spring shell
ApplicationRunner.Interface defining a contract for a context which allows to loosely connect
different components together and keep things alive between commands.
Interface to provide shell spesific
ConversionService.Resolves method parameters by delegating to a list of registered
HandlerMethodArgumentResolvers.Interface for shell runners.
Component able to pick single item.
Context
SingleItemSelector.Interface for single item selector spec builder.
Component for a simple string input.
Interface for string input spec builder.
ST AttributeRenderer which knows to use format string to
render strings into jline StyleExpression based on theming
settings.Base class defining a settings for styles.
Template executor which knows to use styling.
Base class for ResultHandlers that rely on JLine's
Terminal.A ResultHandler that prints
TerminalSizeAware according to the Terminal size.Contract representing a theme with its name and settings.
Registry which stores
Theme's with its name.Service which helps to do various things with styles.
Base class defining a settings for themes.
A
ResultHandler that prints thrown exceptions messages in red.Interface providing a
Path to a location where
user level runtime configuration files are strored.Some text utilities.
A result for a successful resolve operation.