All Classes and Interfaces
Class
Description
A cell sizing strategy that forces a fixed width, expressed in number of characters.
Abstract base class to resolve method arguments from a named value, e.g. message
headers or destination variables.
Represents a named value declaration.
Base implementation of a
Cell.Base class helping to build shell commands.
Base class for components.
Base implementation of a
Control.Base implementation of a
ListCell.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 implementation of a
TextCell.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.
A strategy interface for performing text alignment.
EventLoop.EventLoopProcessor converting incoming message into animation tick messages.AppView provides an opinionated terminal UI application view controlling main
viewing area, menubar, statusbar and modal window system.ViewEvent indicating direction for a next selection.Direction where next selection should go.
Annotation marking a method parameter as an argument to a
Command.Annotation marking a method parameter as a target for a collection of arguments to a
Command.A TableModel backed by a row-first array.
Takes data from underlying char array.
Auto-configuration imports for typical Shell tests.Annotation that can be applied to a test class to enable and configure
auto-configuration of shell client.
A SizeConstraints implementation that splits lines at space boundaries and returns an
extent with minimal and maximal width requirements.
Indicates whether or not a command is currently available.
Interface resolving
Availability.A
ReflectiveProcessor implementation that registers methods of a return type
Availability from a target which is a class.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
NumberInputSpec.Base impl for
PathInputSpec.Base impl for
SingleItemSelectorSpec.Base impl for
StringInputSpec.A table model that is backed by a list of beans.
This represents a directive to set some borders on cells of a table.
Provides support for different styles of borders, using simple or fancy ascii art.
BoxView is a View with an empty background and optional border and
title.ButtonView is a View with border and text acting as a button.Base interface for all cells.
This is used to specify where some components of a Table may be applied.
Contains factory methods for commonly used
CellMatchers.Provides an enum with names for the supported character sets.
Provides the (graphical) character sets.
ANSI console clear command.
Annotation marking a method to be a shell command.
Builder for creating command.
Record representing a runtime argument to a command.
Annotation marking a method having
Availability.Interface containing runtime information about the current command invocation.
Exception to report that a command in not well-defined.
Exception to signal that an error happened while executing a command.
Executes commands based on parsed input.
Factory bean to build instances of
Command.Indicates that a command exists but is currently not invokable.
Exception to signal that a command could be mapped to user input
Record representing the runtime information about an option of a command.
Interface parsing arguments for a
Command.Class representing a registry of
Commands.Interface to customize a
CommandRegistry.Utility class for command-related operations.
A
ValueProvider that can be used to auto-complete names of shell 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.
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.
Auto-configuration for ComponentFlow.Callback interface that can be used to customize a
ComponentFlow.Builder.Component for a confirmation question.
Interface for string input spec builder.
Input provider based on the JVM's system
Console.An adapter to adapt a
Consumer as a command.Base interface for all controls.
Current cursor shape as described by https://vt100.net/docs/vt510-rm/DECSCUSR.html.
A decorator Aligner that checks the Aligner invariants contract, useful for debugging.
A TextWrapper that delegates to another but makes sure that the contract is not
violated.
Default implementation of
CommandParser.Default impl for
BaseConfirmationInput.Default implementation of an
EventLoop.A very simple formatter that uses
Object.toString() and splits on newlines.Default impl for
BaseMultiItemSelector.Default impl for
BaseNumberInput.Default impl for
BasePathInput.Default implementation of a
Screen.Default impl for
SelectItem.Default impl for
BaseSingleItemSelector.Default impl for
BaseStringInput.A Text wrapper that wraps at "word" boundaries.
DialogView is a View with border, number of buttons and area for a
generic content.Record representing dimensions
width and height.Interface for an implementation which is able to return list of
AttributedString usually used together with Display.Enable support for
@Command annotated classes.ImportBeanDefinitionRegistrar for @EnableCommands.EventLoop is a central place where all eventing will be orchestrated for a
lifecycle of a component.Contract to process event loop messages, possibly translating an event into some
other type of event or events.
Type of an events handled by an
EventLoop.This exception, when thrown and caught, will ask the shell to gracefully shutdown.
Record representing the exit status of a command.
Interface to map exceptions to
ExitStatus.Shameful copy-paste of JLine's
DefaultParser which
creates CompletingParsedLine.Base class defining a settings for figures.
An
InputProvider that reads input from a file.A
ValueProvider that can populate names of local Files, either absolute
or relative to the current working directory.A Formatter is responsible for the initial rendering of a value to lines of text.
An adapter to adapt a
Function as a command.Denotes how a graphic set is designated.
GridView is a layout container with no initial views.A command to display help about all available commands.
A command that displays all previously run commands, optionally dumping to a file
readable by
Script.To be implemented by components able to provide a "line" of user input, whether
interactively or by batch.
InputView is used as a text input.Base class for interactive shell runners.
The main terminal emulator class.
Terminal that reflects obtained commands and text at
TerminalDisplay(handles
change of cursor position, screen size etc) and TerminalTextBuffer(stores
printed text)Shell implementation using JLine to capture input and trigger completions.
Interactive shell runner based on the JVM's system
Console.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
Handles Key events in a form of
KeyHandler.KeyHandlerArgs and returns
KeyHandler.KeyHandlerResult.Arguments for a
KeyHandler.Result from a
KeyHandler.A text alignment strategy that aligns text horizontally so that all instances of some
special character(s) line up perfectly in a column.
A SizeConstraints implementation that is tailored to rendering a series of
key = value pairs.
A TextWrapper implementation tailored for key-value rendering (working in concert with
KeyValueSizeConstraints, KeyValueHorizontalAligner), that tries its
best to vertically align some delimiter character (default '=').Holds styled characters lines
Extension of a
Cell to make it aware of an item style and selection state.ListView is a View showing items in a vertical list.Specifies how a item shows selection state.
ViewEvent indicating that selected item has been requested to open.ViewEvent indicating that selected item has changed.A formatter suited for key-value pairs, that renders each mapping on a new line.
MenuBarView shows items horizontally and is typically used
in layouts which builds complete terminal UI's.MenuBarView.MenuBarItem represents an item in a MenuBarView.MenuView.Menu represents an item in a MenuView being a specialisation of
MenuView.MenuItem indicating it having a sub-menu.MenuView.MenuItem represents an item in a MenuView.Specifies how a
MenuView.MenuItem shows selection state.ViewEvent indicating that selected item has been requested to open.ViewEvent indicating that selected item has changed.An adapter to adapt a method as a command.
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
Handles mouse events in a form of
MouseHandler.MouseHandlerArgs and returns
MouseHandler.MouseHandlerResult.Arguments for a
MouseHandler.Result from a
MouseHandler.Component able to pick multiple items.
Context
MultiItemSelector.Interface for multi input spec builder.
A
ShellRunner that executes commands without entering interactive shell mode.A sizing strategy that will impose the longest line width on cells.
Component for a number input.
Interface for number input spec builder.
Annotation marking a method parameter as an option to a
Command.Interface used to modify option long name.
Support facilities for
OptionNameModifier providing common naming types.Annotation marking a method parameter which completion proposals should be used.
Thrown when no ParameterResolver is found for a parameter during a resolve operation.
Thrown when one or more parameters fail bean validation constraints.
Record representing the result of parsing user input into commands.
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.Record representing position
x and y.ProgressView is used to show a progress indicator.Context for
ProgressView cell components.Encapsulates a current running state of a
ProgressView.ViewEvent indicating that proggress has been ended.Defines an item within a progress view.
ViewEvent indicating that proggress has been started.ViewEvent indicating that proggress state has been changed.ViewEventArgs for events using ProgressView.ProgressState.Called at each REPL cycle to decide what the prompt should be.
Record representing coordinates
x, y and its width and
height.Enumeration of a modes instructing how
resultValue is handled.Screen is representing a virtual area which is sitting between a user and lower
level jline terminal providing convenient methods working with visible content.Interface to write into a
Screen.Builder interface for a
Screen.Writer.A command that can read and execute other commands from a file.
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.
Entry point for assertion methods for shell components.
Interface to provide shell spesific
ConversionService.Shell spesific message builder.
Adds standard shell Headers.
Interface for shell runners.
Interface representing a shell screen.
Asserts for
ShellScreen.Annotation that can be used for a Shell test that focuses only on
Shell components.
Client for terminal session which can be used as a programmatic way to interact with a
shell application.
Builder interface for
ShellClient.TestContextBootstrapper for @ShellTest support.TypeExcludeFilter for @ShellTest.Interface sequencing various things into terminal aware text types.
An horizontal alignment strategy that allows alignment to the left, center or right.
Alignment strategy that allows simple vertical alignment to top, middle or bottom.
Component able to pick single item.
Context
SingleItemSelector.Interface for single item selector spec builder.
Strategy for computing the dimensions of a table cell.
Holds both a minimum and maximum width.
Spinner represents how user is notified that something is happening using a
traditional spinner concept.Base class defining a settings for spinners.
Creates supporting beans for running the Shell.
Configuration properties for Spring Shell.
Configuration properties for shell test.
A command to display the full stacktrace when an error occurs.
Sets up all required beans for supporting the standard Shell API.
Creates beans for standard commands.
Lightweight type-safe header accessor avoiding object creation just to access a header.
StatusBarView shows items horizontally and is typically used
in layouts which builds complete terminal UI's.ViewEvent indicating that selected item has been requested to open.StatusBarView.StatusItem represents an item in a StatusBarView.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.General interface that obtains styled range of characters at coordinates (x,
y) when the screen starts at startRow
Base class defining a settings for styles.
Interactive shell runner based on the JVM's system
Console.This is the central API for table rendering.
A builder class to incrementally configure a Table.
Abstracts away the contract a
Table will use to retrieve tabular data.Helper class to build a TableModel incrementally.
Utility class used to create and configure typical Tables.
Provides a tabulator that keeps track of the tab stops of a terminal.
Template executor which knows to use styling.
Executes terminal commands interpreted by
Emulator, receives
textCallback interface that can be used to customize a
Terminal via its
TerminalBuilder.Represents data communication interface for terminal.
Sends a response from the terminal emulator.
To be implemented by command result objects that can adapt to the terminal size when
they are being rendered.
Runs terminal emulator.
Buffer for storing styled text data.
TerminalUI is a main component orchestrating terminal, eventloop, key/mouse
events and view structure to work together.Builder that can be used to configure and create a
TerminalUI.Callback interface that can be used to customize a
TerminalUI.Extension of a
Cell to make it aware of an item style and selection state.A strategy for applying text wrapping/cropping given a cell width.
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.
Stores resolved values for
ThemeResolver.resolveValues(AttributedStyle).Base class defining a settings for themes.
Takes data from and sends it back to TTY input and output streams via
TtyConnectorInterface to tty.
Interface providing a
Path to a location where user level runtime configuration
files are strored.Some text utilities.
Beans implementing this interface are queried during TAB completion to gather possible
values of a parameter.
A result for a successful resolve operation.
Command to print the current version of Spring Shell.
Base interface for all views.
Commands which can be performed by the application or bound to keys in a
View.Handles view execution in a non-fullscreen setup.
Represent run state of an async run of a component.
Builder that can be used to configure and create a
ViewComponent.Executor for
ViewComponent.Base interface for view events.
Base interface for view event args.
Provides services for a
View like handling modals.WindowView is a View defining area within view itself.