Package org.springframework.shell

package org.springframework.shell

Contains core classes for Spring Shell, irrespective of the way commands are actually implemented.

Related Packages

Package	Description
org.springframework.shell.boot
org.springframework.shell.command
org.springframework.shell.completion
org.springframework.shell.component
org.springframework.shell.config
org.springframework.shell.context
org.springframework.shell.exit
org.springframework.shell.geom
org.springframework.shell.jline	Contains classes that leverage the JLine library to hook into the Spring Shell REPL.
org.springframework.shell.result	Contains strategies for dealing with results of commands.
org.springframework.shell.standard	Contains infrastructure for describing commands with the "new" preferred Spring Shell programming model.
org.springframework.shell.style
org.springframework.shell.support
org.springframework.shell.table	Allows the creation of tables that can be rendered using ASCII art.
org.springframework.shell.test

Class	Description
Availability	Indicates whether or not a command is currently available.
AvailabilityProvider	Interface resolving Availability.
AvailabilityReflectiveProcessor	A ReflectiveProcessor implementation that registers methods of a return type Availability from a target which is a class.
Command
Command.Help	Encapsulates help metadata about a shell command.
CommandNotCurrentlyAvailable	Indicates that a command exists but is currently not invokable.
CommandNotFound	A result to be handled by the ResultHandler when no command could be mapped to user input
CompletingParsedLine	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	Represents the buffer context in which completion was triggered.
CompletionProposal	Represents a proposal for TAB completion, made not only of the text to append, but also metadata about the proposal.
DefaultShellApplicationRunner	Default ShellApplicationRunner which dispatches to the first ordered ShellRunner able to handle the shell.
ExitRequest	This exception, when thrown and caught, will ask the shell to gracefully shutdown.
Input	Represents the input buffer to the shell.
InputProvider	To be implemented by components able to provide a "line" of user input, whether interactively or by batch.
JnaRuntimeHints
MethodTargetRegistrar	Strategy interface for registering commands.
ParameterResolverMissingException	Thrown when no ParameterResolver is found for a parameter during a resolve operation.
ParameterValidationException	Thrown when one or more parameters fail bean validation constraints.
ResultHandler<T>	Implementations know how to deal with results of method invocations, whether normal results or exceptions thrown.
ResultHandlerService	A service interface for result handling.
Shell	Main class implementing a shell loop.
ShellApplicationRunner	Marker interface for a main spring shell ApplicationRunner.
ShellRunner	Interface for shell runners.
TerminalSizeAware	To be implemented by command result objects that can adapt to the terminal size when they are being rendered.
Utils	Some text utilities.
ValueResult	A result for a successful resolve operation.
ValueResultAsserts	Assertions for ValueResult.