- AbsoluteWidthSizeConstraints - Class in org.springframework.shell.table
-
A cell sizing strategy that forces a fixed width, expressed in number of characters.
- AbsoluteWidthSizeConstraints(int) - Constructor for class org.springframework.shell.table.AbsoluteWidthSizeConstraints
-
- addAligner(Aligner) - Method in class org.springframework.shell.table.TableBuilder.CellMatcherStub
-
- addFormatter(Formatter) - Method in class org.springframework.shell.table.TableBuilder.CellMatcherStub
-
- addFullBorder(BorderStyle) - Method in class org.springframework.shell.table.TableBuilder
-
Set a border around each and every cell of the table.
- addHeaderAndVerticalsBorders(BorderStyle) - Method in class org.springframework.shell.table.TableBuilder
-
Set a border on the outline of the whole table, around the first row and draw vertical lines
around each column.
- addHeaderBorder(BorderStyle) - Method in class org.springframework.shell.table.TableBuilder
-
Set a border on the outline of the whole table, as well as around the first row.
- addInnerBorder(BorderStyle) - Method in class org.springframework.shell.table.TableBuilder
-
Set a border on the inner verticals and horizontals of the table, but not on the outline.
- addOutlineBorder(BorderStyle) - Method in class org.springframework.shell.table.TableBuilder
-
Set a border on the outline of the whole table.
- addRow() - Method in class org.springframework.shell.table.TableModelBuilder
-
- addSizer(SizeConstraints) - Method in class org.springframework.shell.table.TableBuilder.CellMatcherStub
-
- addValue(T) - Method in class org.springframework.shell.table.TableModelBuilder
-
- addWrapper(TextWrapper) - Method in class org.springframework.shell.table.TableBuilder.CellMatcherStub
-
- align(String[], int, int) - Method in interface org.springframework.shell.table.Aligner
-
Perform text alignment, returning a String array that MUST contain cellHeight
lines, each of which MUST be cellWidth
chars in length.
- align(String[], int, int) - Method in class org.springframework.shell.table.DebugAligner
-
- align(String[], int, int) - Method in class org.springframework.shell.table.KeyValueHorizontalAligner
-
- align(String[], int, int) - Method in enum org.springframework.shell.table.SimpleHorizontalAligner
-
- align(String[], int, int) - Method in enum org.springframework.shell.table.SimpleVerticalAligner
-
- Aligner - Interface in org.springframework.shell.table
-
A strategy interface for performing text alignment.
- and() - Method in class org.springframework.shell.table.TableBuilder.CellMatcherStub
-
- applicationContext - Variable in class org.springframework.shell.Shell
-
- ARITY_USE_HEURISTICS - Static variable in annotation type org.springframework.shell.standard.ShellOption
-
Marker value to indicate that heuristics should be used to derive arity.
- ArrayTableModel - Class in org.springframework.shell.table
-
A TableModel backed by a row-first array.
- ArrayTableModel(Object[][]) - Constructor for class org.springframework.shell.table.ArrayTableModel
-
- at(int, int) - Static method in class org.springframework.shell.table.CellMatchers
-
- AttributedCharSequenceResultHandler - Class in org.springframework.shell.result
-
A
ResultHandler
that knows how to render JLine's
AttributedCharSequence
.
- AttributedCharSequenceResultHandler() - Constructor for class org.springframework.shell.result.AttributedCharSequenceResultHandler
-
- attributedCharSequenceResultHandler() - Method in class org.springframework.shell.result.ResultHandlerConfig
-
- AutoSizeConstraints - Class in org.springframework.shell.table
-
A SizeConstraints implementation that splits lines at space boundaries
and returns an extent with minimal and maximal width requirements.
- AutoSizeConstraints() - Constructor for class org.springframework.shell.table.AutoSizeConstraints
-
- Availability - Class in org.springframework.shell
-
Indicates whether or not a command is currently available.
- available() - Static method in class org.springframework.shell.Availability
-
- category() - Method in class org.springframework.shell.CompletionProposal
-
- category(String) - Method in class org.springframework.shell.CompletionProposal
-
- CellMatcher - Interface in org.springframework.shell.table
-
This is used to specify where some components of a Table may be applied.
- CellMatchers - Class in org.springframework.shell.table
-
Contains factory methods for commonly used
CellMatcher
s.
- CellMatchers() - Constructor for class org.springframework.shell.table.CellMatchers
-
- Clear - Class in org.springframework.shell.standard.commands
-
ANSI console related commands.
- Clear() - Constructor for class org.springframework.shell.standard.commands.Clear
-
- clear() - Method in class org.springframework.shell.standard.commands.Clear
-
- clear() - Method in class org.springframework.shell.standard.commands.StandardCommandsAutoConfiguration
-
- Clear.Command - Interface in org.springframework.shell.standard.commands
-
Marker interface for beans providing clear functionality to the shell.
- close() - Method in class org.springframework.shell.jline.FileInputProvider
-
- column(int) - Static method in class org.springframework.shell.table.CellMatchers
-
- Command - Interface in org.springframework.shell
-
- Command.Help - Class in org.springframework.shell
-
Encapsulates help metadata about a shell command.
- CommandNotCurrentlyAvailable - Exception in org.springframework.shell
-
Indicates that a command exists but is currently not invokable.
- CommandNotCurrentlyAvailable(String, Availability) - Constructor for exception org.springframework.shell.CommandNotCurrentlyAvailable
-
- CommandNotFound - Exception in org.springframework.shell
-
A result to be handled by the
ResultHandler
when no command could be mapped to user input
- CommandNotFound(List<String>) - Constructor for exception org.springframework.shell.CommandNotFound
-
- CommandRegistry - Interface in org.springframework.shell
-
Implementing this interface allows sub-systems (such as the help command) to
discover available commands.
- CommandValueProvider - Class in org.springframework.shell.standard
-
A
ValueProvider
that can be used to auto-complete names of shell commands.
- CommandValueProvider(CommandRegistry) - Constructor for class org.springframework.shell.standard.CommandValueProvider
-
- commandValueProvider(CommandRegistry) - Method in class org.springframework.shell.standard.StandardAPIAutoConfiguration
-
- complete(MethodParameter, CompletionContext) - Method in class org.springframework.shell.jcommander.JCommanderParameterResolver
-
- complete(LineReader, ParsedLine, List<Candidate>) - Method in class org.springframework.shell.jline.JLineShellAutoConfiguration.CompleterAdapter
-
- complete(MethodParameter, CompletionContext) - Method in class org.springframework.shell.legacy.LegacyParameterResolver
-
- complete(MethodParameter, CompletionContext) - Method in interface org.springframework.shell.ParameterResolver
-
Invoked during TAB completion.
- complete(CompletionContext) - Method in class org.springframework.shell.Shell
-
Gather completion proposals given some (incomplete) input the user has already typed
in.
- complete(MethodParameter, CompletionContext, String[]) - Method in class org.springframework.shell.standard.CommandValueProvider
-
- complete(MethodParameter, CompletionContext, String[]) - Method in class org.springframework.shell.standard.EnumValueProvider
-
- complete(MethodParameter, CompletionContext, String[]) - Method in class org.springframework.shell.standard.FileValueProvider
-
- complete(MethodParameter, CompletionContext) - Method in class org.springframework.shell.standard.StandardParameterResolver
-
- complete(MethodParameter, CompletionContext, String[]) - Method in interface org.springframework.shell.standard.ValueProvider
-
- completer() - Method in class org.springframework.shell.jline.JLineShellAutoConfiguration
-
- CompleterAdapter() - Constructor for class org.springframework.shell.jline.JLineShellAutoConfiguration.CompleterAdapter
-
- CompletingParsedLine - Interface in org.springframework.shell
-
An extension of ParsedLine
that, being aware of the quoting and escaping rules
of the Parser
that produced it, knows if and how a completion candidate
should be escaped/quoted.
- CompletionContext - Class in org.springframework.shell
-
Represents the buffer context in which completion was triggered.
- CompletionContext(List<String>, int, int) - Constructor for class org.springframework.shell.CompletionContext
-
- CompletionProposal - Class in org.springframework.shell
-
Represents a proposal for TAB completion, made not only of the text to append, but also metadata about the proposal.
- CompletionProposal(String) - Constructor for class org.springframework.shell.CompletionProposal
-
- ConfigurableCommandRegistry - Class in org.springframework.shell
-
- ConfigurableCommandRegistry() - Constructor for class org.springframework.shell.ConfigurableCommandRegistry
-
- configureKeyValueRendering(TableBuilder, String) - Static method in class org.springframework.shell.table.Tables
-
Install all the necessary formatters, aligners, etc for key-value rendering of Maps.
- createMethodParameter(Parameter) - Static method in class org.springframework.shell.Utils
-
Convert from JDK
Parameter
to Spring
MethodParameter
.
- createMethodParameter(Executable, int) - Static method in class org.springframework.shell.Utils
-
Return a properly initialized MethodParameter for the given executable and index.
- createMethodParameters(Executable) - Static method in class org.springframework.shell.Utils
-
Return MethodParameters for each parameter of the given method/constructor.
- currentWord() - Method in class org.springframework.shell.CompletionContext
-
Return the whole word the cursor is in, or null
if the cursor is past the last word.
- currentWordUpToCursor() - Method in class org.springframework.shell.CompletionContext
-
- Script - Class in org.springframework.shell.standard.commands
-
A command that can read and execute other commands from a file.
- Script(Shell, Parser) - Constructor for class org.springframework.shell.standard.commands.Script
-
- script(File) - Method in class org.springframework.shell.standard.commands.Script
-
- script(Shell, Parser) - Method in class org.springframework.shell.standard.commands.StandardCommandsAutoConfiguration
-
- Script.Command - Interface in org.springframework.shell.standard.commands
-
Marker interface for beans providing script functionality to the shell.
- scriptApplicationRunner(Parser, ConfigurableEnvironment) - Method in class org.springframework.shell.jline.JLineShellAutoConfiguration
-
- ScriptShellApplicationRunner - Class in org.springframework.shell.jline
-
Spring Boot ApplicationRunner that looks for process arguments that start with
@, which are then interpreted as references to script files to run and exit.
- ScriptShellApplicationRunner(Parser, Shell, ConfigurableEnvironment) - Constructor for class org.springframework.shell.jline.ScriptShellApplicationRunner
-
- setApplicationContext(ApplicationContext) - Method in class org.springframework.shell.standard.StandardMethodTargetRegistrar
-
- setCommandRegistry(CommandRegistry) - Method in class org.springframework.shell.standard.commands.Help
-
- setParameterResolvers(List<ParameterResolver>) - Method in class org.springframework.shell.Shell
-
- setResultHandlers(Set<ResultHandler<?>>) - Method in class org.springframework.shell.result.TypeHierarchyResultHandler
-
- setShell(Shell) - Method in class org.springframework.shell.jline.JLineShellAutoConfiguration.CompleterAdapter
-
- setTerminal(Terminal) - Method in class org.springframework.shell.result.TerminalAwareResultHandler
-
- setValidatorFactory(ValidatorFactory) - Method in class org.springframework.shell.jcommander.JCommanderParameterResolver
-
- setValidatorFactory(ValidatorFactory) - Method in class org.springframework.shell.legacy.LegacyParameterResolver
-
- setValidatorFactory(ValidatorFactory) - Method in class org.springframework.shell.Shell
-
- setValidatorFactory(ValidatorFactory) - Method in class org.springframework.shell.standard.commands.Help
-
- setValidatorFactory(ValidatorFactory) - Method in class org.springframework.shell.standard.StandardParameterResolver
-
- setValueProviders(Collection<ValueProvider>) - Method in class org.springframework.shell.standard.StandardParameterResolver
-
- Shell - Class in org.springframework.shell
-
Main class implementing a shell loop.
- Shell(ResultHandler) - Constructor for class org.springframework.shell.Shell
-
- shell(ResultHandler) - Method in class org.springframework.shell.SpringShellAutoConfiguration
-
- ShellCommandGroup - Annotation Type in org.springframework.shell.standard
-
Used to indicate the default group of shell commands, either at the package or class level.
- ShellComponent - Annotation Type in org.springframework.shell.standard
-
Indicates that an annotated class may contain shell methods (themselves annotated with
ShellMethod
) that
is,
methods that may be invoked reflectively by the shell.
- shellConversionService(ApplicationContext) - Method in class org.springframework.shell.SpringShellAutoConfiguration
-
- ShellMethod - Annotation Type in org.springframework.shell.standard
-
Used to mark a method as invokable via Spring Shell.
- ShellMethodAvailability - Annotation Type in org.springframework.shell.standard
-
Used to customize the name of the method used to indicate availability of a command.
- ShellOption - Annotation Type in org.springframework.shell.standard
-
- ShellOption.NoValueProvider - Interface in org.springframework.shell.standard
-
- SimpleHorizontalAligner - Enum in org.springframework.shell.table
-
An horizontal alignment strategy that allows alignment to the left, center or right.
- SimpleVerticalAligner - Enum in org.springframework.shell.table
-
Alignment strategy that allows simple vertical alignment to top, middle or bottom.
- SizeConstraints - Interface in org.springframework.shell.table
-
Strategy for computing the dimensions of a table cell.
- SizeConstraints.Extent - Class in org.springframework.shell.table
-
Holds both a minimum and maximum width.
- SPRING_SHELL_INTERACTIVE - Static variable in class org.springframework.shell.jline.InteractiveShellApplicationRunner
-
- SPRING_SHELL_INTERACTIVE_ENABLED - Static variable in class org.springframework.shell.jline.InteractiveShellApplicationRunner
-
The name of the property that controls whether this runner effectively does something.
- SPRING_SHELL_SCRIPT - Static variable in class org.springframework.shell.jline.ScriptShellApplicationRunner
-
- SPRING_SHELL_SCRIPT_ENABLED - Static variable in class org.springframework.shell.jline.ScriptShellApplicationRunner
-
The name of the environment property that allows to disable the behavior of this
runner.
- SpringShellAutoConfiguration - Class in org.springframework.shell
-
Creates supporting beans for running the Shell
- SpringShellAutoConfiguration() - Constructor for class org.springframework.shell.SpringShellAutoConfiguration
-
- Stacktrace - Class in org.springframework.shell.standard.commands
-
A command to display the full stacktrace when an error occurs.
- Stacktrace() - Constructor for class org.springframework.shell.standard.commands.Stacktrace
-
- stacktrace() - Method in class org.springframework.shell.standard.commands.Stacktrace
-
- stacktrace() - Method in class org.springframework.shell.standard.commands.StandardCommandsAutoConfiguration
-
- Stacktrace.Command - Interface in org.springframework.shell.standard.commands
-
Marker interface for beans providing stacktrace functionality to the shell.
- StandardAPIAutoConfiguration - Class in org.springframework.shell.standard
-
Sets up all required beans for supporting the standard Shell API.
- StandardAPIAutoConfiguration() - Constructor for class org.springframework.shell.standard.StandardAPIAutoConfiguration
-
- StandardCommandsAutoConfiguration - Class in org.springframework.shell.standard.commands
-
Creates beans for standard commands.
- StandardCommandsAutoConfiguration() - Constructor for class org.springframework.shell.standard.commands.StandardCommandsAutoConfiguration
-
- StandardMethodTargetRegistrar - Class in org.springframework.shell.standard
-
- StandardMethodTargetRegistrar() - Constructor for class org.springframework.shell.standard.StandardMethodTargetRegistrar
-
- standardMethodTargetResolver() - Method in class org.springframework.shell.standard.StandardAPIAutoConfiguration
-
- standardParameterResolver(ConversionService) - Method in class org.springframework.shell.standard.StandardAPIAutoConfiguration
-
- StandardParameterResolver - Class in org.springframework.shell.standard
-
Default ParameterResolver implementation that supports the following features:
named parameters (recognized because they start with some
ShellMethod.prefix()
)
implicit named parameters (from the actual method parameter name)
positional parameters (in order, for all parameter values that were not resolved
via named parameters)
default values (for all remaining parameters)
- StandardParameterResolver(ConversionService) - Constructor for class org.springframework.shell.standard.StandardParameterResolver
-
- status() - Method in exception org.springframework.shell.ExitRequest
-
The exit code to be returned when the process exits.
- supports(MethodParameter) - Method in class org.springframework.shell.jcommander.JCommanderParameterResolver
-
- supports(MethodParameter) - Method in class org.springframework.shell.legacy.LegacyParameterResolver
-
- supports(MethodParameter) - Method in interface org.springframework.shell.ParameterResolver
-
Should return true if this resolver recognizes the given method parameter (e.g. it
has the correct annotation or the correct type).
- supports(MethodParameter, CompletionContext) - Method in class org.springframework.shell.standard.EnumValueProvider
-
- supports(MethodParameter, CompletionContext) - Method in class org.springframework.shell.standard.FileValueProvider
-
- supports(MethodParameter) - Method in class org.springframework.shell.standard.StandardParameterResolver
-
- supports(MethodParameter, CompletionContext) - Method in interface org.springframework.shell.standard.ValueProvider
-
- supports(MethodParameter, CompletionContext) - Method in class org.springframework.shell.standard.ValueProviderSupport
-