Uses of Package
org.springframework.shell

Packages that use org.springframework.shell

Package	Description
org.springframework.shell	Contains core classes for Spring Shell, irrespective of the way commands are actually implemented.
org.springframework.shell.jcommander	Provides integration with JCommander.
org.springframework.shell.jline	Contains classes that leverage the JLine library to hook into the Spring Shell REPL.
org.springframework.shell.legacy	Provides integration with Spring Shell 1.
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.standard.commands	Contains default commands that ought to apply to each shell app.
org.springframework.shell.table	Allows the creation of tables that can be rendered using ASCII art.

Classes in org.springframework.shell used by org.springframework.shell

Class and Description
Availability Indicates whether or not a command is currently available.
Command
Command.Help Encapsulates help metadata about a shell command.
CommandRegistry Implementing this interface allows sub-systems (such as the help command) to discover available commands.
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.
ConfigurableCommandRegistry A CommandRegistry that supports registration of new commands.
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.
MethodTarget Represents a shell command behavior, i.e. code to be executed when a command is requested.
ParameterDescription Encapsulates information about a shell invokable method parameter, so that it can be documented.
ParameterResolver Implementations of this interface are responsible, once the command has been identified, of transforming the textual input to an actual parameter object.
ResultHandler Implementations know how to deal with results of method invocations, whether normal results or exceptions thrown.
Shell Main class implementing a shell loop.
ValueResult A ResolveResult for a successful ParameterResolver.resolve(org.springframework.core.MethodParameter, java.util.List<java.lang.String>) operation.

Classes in org.springframework.shell used by org.springframework.shell.jcommander

Class and Description
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.
ParameterDescription Encapsulates information about a shell invokable method parameter, so that it can be documented.
ParameterResolver Implementations of this interface are responsible, once the command has been identified, of transforming the textual input to an actual parameter object.
ValueResult A ResolveResult for a successful ParameterResolver.resolve(org.springframework.core.MethodParameter, java.util.List<java.lang.String>) operation.

Classes in org.springframework.shell used by org.springframework.shell.jline

Class and Description
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.
Shell Main class implementing a shell loop.

Classes in org.springframework.shell used by org.springframework.shell.legacy

Class and Description
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.
ConfigurableCommandRegistry A CommandRegistry that supports registration of new commands.
MethodTargetRegistrar Strategy interface for registering commands.
ParameterDescription Encapsulates information about a shell invokable method parameter, so that it can be documented.
ParameterResolver Implementations of this interface are responsible, once the command has been identified, of transforming the textual input to an actual parameter object.
ValueResult A ResolveResult for a successful ParameterResolver.resolve(org.springframework.core.MethodParameter, java.util.List<java.lang.String>) operation.

Classes in org.springframework.shell used by org.springframework.shell.result

Class and Description
ParameterValidationException Thrown when one or more parameters fail bean validation constraints.
ResultHandler Implementations know how to deal with results of method invocations, whether normal results or exceptions thrown.
TerminalSizeAware To be implemented by command result objects that can adapt to the terminal size when they are being rendered.

Classes in org.springframework.shell used by org.springframework.shell.standard

Class and Description
CommandRegistry Implementing this interface allows sub-systems (such as the help command) to discover available commands.
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.
ConfigurableCommandRegistry A CommandRegistry that supports registration of new commands.
MethodTargetRegistrar Strategy interface for registering commands.
ParameterDescription Encapsulates information about a shell invokable method parameter, so that it can be documented.
ParameterResolver Implementations of this interface are responsible, once the command has been identified, of transforming the textual input to an actual parameter object.
ValueResult A ResolveResult for a successful ParameterResolver.resolve(org.springframework.core.MethodParameter, java.util.List<java.lang.String>) operation.

Classes in org.springframework.shell used by org.springframework.shell.standard.commands

Class and Description
CommandRegistry Implementing this interface allows sub-systems (such as the help command) to discover available commands.
ParameterResolver Implementations of this interface are responsible, once the command has been identified, of transforming the textual input to an actual parameter object.
Shell Main class implementing a shell loop.

Classes in org.springframework.shell used by org.springframework.shell.table

Class and Description
TerminalSizeAware To be implemented by command result objects that can adapt to the terminal size when they are being rendered.