A B C D E F G H I J K L M N O P Q R S T U V W

A

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

AbstractArgumentMethodArgumentResolver - Class in org.springframework.shell.support

Abstract base class to resolve method arguments from a named value, e.g.

AbstractArgumentMethodArgumentResolver(ConversionService, ConfigurableBeanFactory) - Constructor for class org.springframework.shell.support.AbstractArgumentMethodArgumentResolver

Constructor with a ConversionService and a BeanFactory.

AbstractArgumentMethodArgumentResolver.NamedValueInfo - Class in org.springframework.shell.support

Represents a named value declaration.

AbstractCompletions - Class in org.springframework.shell.standard.completion

Base class for completion script commands providing functionality for resource handling and templating with antrl stringtemplate.

AbstractCompletions(ResourceLoader, CommandCatalog) - Constructor for class org.springframework.shell.standard.completion.AbstractCompletions

AbstractComponent<T extends ComponentContext<T>> - Class in org.springframework.shell.component.support

Base class for components.

AbstractComponent(Terminal) - Constructor for class org.springframework.shell.component.support.AbstractComponent

AbstractSelectorComponent<T,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>,I extends Nameable & Matchable & Enableable & Selectable & Itemable<T>> - Class in org.springframework.shell.component.support

Base component for selectors which provide selectable lists.

AbstractSelectorComponent(Terminal, String, List<I>, boolean, Comparator<I>) - Constructor for class org.springframework.shell.component.support.AbstractSelectorComponent

AbstractSelectorComponent.BaseSelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>> - Class in org.springframework.shell.component.support

Base implementation of a AbstractSelectorComponent.SelectorComponentContext.

AbstractSelectorComponent.ItemState<I extends Matchable> - Class in org.springframework.shell.component.support

Class keeping item state.

AbstractSelectorComponent.SelectorComponentContext<T,I extends Nameable & Matchable & Itemable<T>,C extends AbstractSelectorComponent.SelectorComponentContext<T,I,C>> - Interface in org.springframework.shell.component.support

Context interface on a selector component sharing content.

AbstractShellComponent - Class in org.springframework.shell.standard

Base class helping to build shell components.

AbstractShellComponent() - Constructor for class org.springframework.shell.standard.AbstractShellComponent

AbstractTextComponent<T,C extends AbstractTextComponent.TextComponentContext<T,C>> - Class in org.springframework.shell.component.support

Base class for components which work on a simple text input.

AbstractTextComponent(Terminal) - Constructor for class org.springframework.shell.component.support.AbstractTextComponent

AbstractTextComponent(Terminal, String) - Constructor for class org.springframework.shell.component.support.AbstractTextComponent

AbstractTextComponent(Terminal, String, Function<C, List<AttributedString>>) - Constructor for class org.springframework.shell.component.support.AbstractTextComponent

AbstractTextComponent.BaseTextComponentContext<T,C extends AbstractTextComponent.TextComponentContext<T,C>> - Class in org.springframework.shell.component.support

AbstractTextComponent.TextComponentContext<T,C extends AbstractTextComponent.TextComponentContext<T,C>> - Interface in org.springframework.shell.component.support

AbstractTextComponent.TextComponentContext.MessageLevel - Enum in org.springframework.shell.component.support

Message levels which can be used to alter how message is shown.

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.

addPostRunHandler(Consumer<T>) - Method in class org.springframework.shell.component.support.AbstractComponent

Adds a post-run handler.

addPreRunHandler(Consumer<T>) - Method in class org.springframework.shell.component.support.AbstractComponent

Adds a pre-run handler.

addResolver(HandlerMethodArgumentResolver) - Method in class org.springframework.shell.command.invocation.ShellMethodArgumentResolverComposite

Add the given HandlerMethodArgumentResolver.

addResolvers(HandlerMethodArgumentResolver...) - Method in class org.springframework.shell.command.invocation.ShellMethodArgumentResolverComposite

Add the given HandlerMethodArgumentResolvers.

addResolvers(List<? extends HandlerMethodArgumentResolver>) - Method in class org.springframework.shell.command.invocation.ShellMethodArgumentResolverComposite

Add the given HandlerMethodArgumentResolvers.

addResultHandler(ResultHandler<?>) - Method in class org.springframework.shell.result.GenericResultHandlerService

Add a plain result handler to this registry.

addResultHandler(Class<T>, ResultHandler<? super T>) - Method in class org.springframework.shell.result.GenericResultHandlerService

Add a plain result handler to this registry.

addResultHandler(GenericResultHandler) - Method in class org.springframework.shell.result.GenericResultHandlerService

Add a generic result handler this this registry.

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

afterPropertiesSet() - Method in class org.springframework.shell.standard.AbstractShellComponent

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 interface org.springframework.shell.command.CommandRegistration.AliasSpec

Return a builder for chaining.

and() - Method in class org.springframework.shell.command.CommandRegistration.DefaultAliasSpec

and() - Method in class org.springframework.shell.command.CommandRegistration.DefaultExitCodeSpec

and() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

and() - Method in class org.springframework.shell.command.CommandRegistration.DefaultTargetSpec

and() - Method in interface org.springframework.shell.command.CommandRegistration.ExitCodeSpec

Return a builder for chaining.

and() - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec

Return a builder for chaining.

and() - Method in interface org.springframework.shell.command.CommandRegistration.TargetSpec

Return a builder for chaining.

and() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

and() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

and() - Method in class org.springframework.shell.component.flow.BasePathInput

and() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

and() - Method in class org.springframework.shell.component.flow.BaseStringInput

and() - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec

Build and return parent builder.

and() - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec

Build and return parent builder.

and() - Method in interface org.springframework.shell.component.flow.PathInputSpec

Build and return parent builder.

and() - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec

Build and return parent builder.

and() - Method in interface org.springframework.shell.component.flow.StringInputSpec

Build and return parent builder.

and() - Method in class org.springframework.shell.table.TableBuilder.CellMatcherStub

apply(CompletionContext) - Method in class org.springframework.shell.completion.RegistrationOptionsCompletionResolver

ARGUMENT_PREFIX - Static variable in class org.springframework.shell.support.AbstractArgumentMethodArgumentResolver

ArgumentHeaderMethodArgumentResolver - Class in org.springframework.shell.command

Resolver for @Header arguments.

ArgumentHeaderMethodArgumentResolver(ConversionService, ConfigurableBeanFactory) - Constructor for class org.springframework.shell.command.ArgumentHeaderMethodArgumentResolver

arity(int, int) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

arity(CommandRegistration.OptionArity) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

arity(int, int) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec

Define an arity for an option.

arity(CommandRegistration.OptionArity) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec

Define an arity for an option.

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

assertTargetBean(Method, Object, Object[]) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

Assert that the target bean class is an instance of the class where the given method is declared.

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(Terminal) - Constructor for class org.springframework.shell.result.AttributedCharSequenceResultHandler

attributedCharSequenceResultHandler(Terminal) - 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.

availability(Supplier<Availability>) - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder

availability(Supplier<Availability>) - Method in interface org.springframework.shell.command.CommandRegistration.Builder

Define an Availability suppliear for a command.

available() - Static method in class org.springframework.shell.Availability

B

BaseBuilder() - Constructor for class org.springframework.shell.command.CommandRegistration.BaseBuilder

BaseComponentContext<C extends ComponentContext<C>> - Class in org.springframework.shell.component.context

Base implementation of a ComponentContext.

BaseComponentContext() - Constructor for class org.springframework.shell.component.context.BaseComponentContext

BaseConfirmationInput - Class in org.springframework.shell.component.flow

Base impl for ConfirmationInputSpec.

BaseConfirmationInput(ComponentFlow.BaseBuilder, String) - Constructor for class org.springframework.shell.component.flow.BaseConfirmationInput

BaseInput<T extends BaseInputSpec<T>> - Class in org.springframework.shell.component.flow

Base impl for specs.

BaseInputSpec<T extends BaseInputSpec<T>> - Interface in org.springframework.shell.component.flow

Base spec for other specs.

BaseMultiItemSelector - Class in org.springframework.shell.component.flow

Base impl for MultiItemSelectorSpec.

BaseMultiItemSelector(ComponentFlow.BaseBuilder, String) - Constructor for class org.springframework.shell.component.flow.BaseMultiItemSelector

BasePathInput - Class in org.springframework.shell.component.flow

Base impl for PathInputSpec.

BasePathInput(ComponentFlow.BaseBuilder, String) - Constructor for class org.springframework.shell.component.flow.BasePathInput

BaseSelectorComponentContext() - Constructor for class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext

BaseSingleItemSelector - Class in org.springframework.shell.component.flow

Base impl for SingleItemSelectorSpec.

BaseSingleItemSelector(ComponentFlow.BaseBuilder, String) - Constructor for class org.springframework.shell.component.flow.BaseSingleItemSelector

BaseStringInput - Class in org.springframework.shell.component.flow

Base impl for StringInputSpec.

BaseStringInput(ComponentFlow.BaseBuilder, String) - Constructor for class org.springframework.shell.component.flow.BaseStringInput

BaseTextComponentContext() - Constructor for class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext

bash() - Method in class org.springframework.shell.standard.commands.Completion

BashCompletions - Class in org.springframework.shell.standard.completion

Completion script generator for a bash.

BashCompletions(ResourceLoader, CommandCatalog) - Constructor for class org.springframework.shell.standard.completion.BashCompletions

BeanListTableModel<T> - Class in org.springframework.shell.table

A table model that is backed by a list of beans.

BeanListTableModel(Class<T>, Iterable<T>) - Constructor for class org.springframework.shell.table.BeanListTableModel

BeanListTableModel(Iterable<T>, String...) - Constructor for class org.springframework.shell.table.BeanListTableModel

BeanListTableModel(Iterable<T>, LinkedHashMap<String, Object>) - Constructor for class org.springframework.shell.table.BeanListTableModel

bindKeyMap(KeyMap<String>) - Method in class org.springframework.shell.component.support.AbstractComponent

Bind key map.

bindKeyMap(KeyMap<String>) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent

bindKeyMap(KeyMap<String>) - Method in class org.springframework.shell.component.support.AbstractTextComponent

BorderSpecification - Class in org.springframework.shell.table

This represents a directive to set some borders on cells of a table.

BorderStyle - Enum in org.springframework.shell.table

Provides support for different styles of borders, using simple or fancy ascii art.

BOTTOM - Static variable in class org.springframework.shell.table.BorderSpecification

build() - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder

build() - Method in interface org.springframework.shell.command.CommandRegistration.Builder

Builds a CommandRegistration.

build() - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder

build() - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder

Builds instance of input wizard.

build() - Method in class org.springframework.shell.table.TableBuilder

build() - Method in class org.springframework.shell.table.TableBuilder.CellMatcherStub

build() - Method in class org.springframework.shell.table.TableModelBuilder

builder() - Static method in interface org.springframework.shell.command.CommandRegistration

Gets a new instance of a CommandRegistration.Builder.

builder() - Static method in interface org.springframework.shell.component.flow.ComponentFlow

Gets a new instance of an input wizard builder.

builder() - Method in class org.springframework.shell.standard.completion.AbstractCompletions

C

canRun(ApplicationArguments) - Method in class org.springframework.shell.jline.InteractiveShellRunner

canRun(ApplicationArguments) - Method in class org.springframework.shell.jline.NonInteractiveShellRunner

canRun(ApplicationArguments) - Method in class org.springframework.shell.jline.ScriptShellRunner

canRun(ApplicationArguments) - Method in interface org.springframework.shell.ShellRunner

Checks if a particular shell runner can execute.

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 CellMatchers.

CellMatchers() - Constructor for class org.springframework.shell.table.CellMatchers

checkboxOff() - Method in class org.springframework.shell.style.FigureSettings

checkboxOn() - Method in class org.springframework.shell.style.FigureSettings

clear() - Method in class org.springframework.shell.command.invocation.ShellMethodArgumentResolverComposite

Clear the list of configured resolvers and the resolver cache.

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.Command - Interface in org.springframework.shell.standard.commands

Marker interface for beans providing clear functionality to the shell.

clone() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod.HandlerMethodParameter

clone() - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder

clone() - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder

Clones existing builder.

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(String...) - Method in interface org.springframework.shell.command.CommandRegistration.AliasSpec

Define commands for an alias.

command(String...) - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder

command(String...) - Method in interface org.springframework.shell.command.CommandRegistration.Builder

Define commands this registration uses.

command(String...) - Method in class org.springframework.shell.command.CommandRegistration.DefaultAliasSpec

Command.Help - Class in org.springframework.shell

Encapsulates help metadata about a shell command.

CommandAlias - Interface in org.springframework.shell.command

Interface representing an alias in a command.

CommandAlias.DefaultCommandAlias - Class in org.springframework.shell.command

Default implementation of CommandAlias.

CommandCatalog - Interface in org.springframework.shell.command

Interface defining contract to handle existing CommandRegistrations.

CommandCatalog.DefaultCommandCatalog - Class in org.springframework.shell.command

Default implementation of a CommandCatalog.

CommandCatalogCustomizer - Interface in org.springframework.shell.command

Interface to customize a CommandCatalog.

CommandContext - Interface in org.springframework.shell.command

Interface containing information about current command execution.

CommandContext.DefaultCommandContext - Class in org.springframework.shell.command

Default implementation of a CommandContext.

CommandContextMethodArgumentResolver - Class in org.springframework.shell.command

Implementation of a HandlerMethodArgumentResolver resolving CommandContext.

CommandContextMethodArgumentResolver() - Constructor for class org.springframework.shell.command.CommandContextMethodArgumentResolver

CommandExecution - Interface in org.springframework.shell.command

Interface to evaluate a result from a command with an arguments.

CommandExecution.CommandExecutionException - Exception in org.springframework.shell.command

CommandExecution.CommandExecutionHandlerMethodArgumentResolvers - Class in org.springframework.shell.command

CommandExecution.CommandParserExceptionsException - Exception in org.springframework.shell.command

CommandExecution.DefaultCommandExecution - Class in org.springframework.shell.command

Default implementation of a CommandExecution.

CommandExecution.ParamNameHandlerMethodArgumentResolver - Class in org.springframework.shell.command

CommandExecutionException(Throwable) - Constructor for exception org.springframework.shell.command.CommandExecution.CommandExecutionException

CommandExecutionHandlerMethodArgumentResolvers(List<? extends HandlerMethodArgumentResolver>) - Constructor for class org.springframework.shell.command.CommandExecution.CommandExecutionHandlerMethodArgumentResolvers

CommandExitCode - Interface in org.springframework.shell.command

Interface representing an exit code in a command.

CommandExitCode.DefaultCommandExitCode - Class in org.springframework.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

CommandOption - Interface in org.springframework.shell.command

Interface representing an option in a command.

commandOption(CommandOption) - Method in class org.springframework.shell.CompletionContext

Return a copy of this context with given command option.

CommandOption.DefaultCommandOption - Class in org.springframework.shell.command

Default implementation of CommandOption.

CommandParser - Interface in org.springframework.shell.command

Interface parsing arguments for a CommandRegistration.

CommandParser.CommandParserException - Exception in org.springframework.shell.command

CommandParser.CommandParserResult - Interface in org.springframework.shell.command

Result of a parsing CommandOption with an argument.

CommandParser.CommandParserResults - Interface in org.springframework.shell.command

Results of a CommandParser.

CommandParser.DefaultCommandParser - Class in org.springframework.shell.command

Default implementation of a CommandParser.

CommandParser.DefaultCommandParserResult - Class in org.springframework.shell.command

Default implementation of a CommandParser.CommandParserResult.

CommandParser.DefaultCommandParserResults - Class in org.springframework.shell.command

Default implementation of a CommandParser.CommandParserResults.

CommandParser.MissingOptionException - Exception in org.springframework.shell.command

CommandParser.NotEnoughArgumentsOptionException - Exception in org.springframework.shell.command

CommandParser.OptionException - Exception in org.springframework.shell.command

CommandParser.TooManyArgumentsOptionException - Exception in org.springframework.shell.command

CommandParser.UnrecognisedOptionException - Exception in org.springframework.shell.command

CommandParserException(String) - Constructor for exception org.springframework.shell.command.CommandParser.CommandParserException

CommandParserException(String, Throwable) - Constructor for exception org.springframework.shell.command.CommandParser.CommandParserException

CommandParserExceptionsException(String, List<CommandParser.CommandParserException>) - Constructor for exception org.springframework.shell.command.CommandExecution.CommandParserExceptionsException

CommandParserExceptionsExceptionResultHandler - Class in org.springframework.shell.result

Displays command parsing errors on the terminal.

CommandParserExceptionsExceptionResultHandler(Terminal) - Constructor for class org.springframework.shell.result.CommandParserExceptionsExceptionResultHandler

commandParserExceptionsExceptionResultHandler(Terminal) - Method in class org.springframework.shell.result.ResultHandlerConfig

CommandRegistration - Interface in org.springframework.shell.command

Interface defining a command registration endpoint.

commandRegistration(CommandRegistration) - Method in class org.springframework.shell.CompletionContext

Return a copy of this context with given command registration.

CommandRegistration.AliasSpec - Interface in org.springframework.shell.command

Spec defining an alias.

CommandRegistration.BaseBuilder - Class in org.springframework.shell.command

CommandRegistration.Builder - Interface in org.springframework.shell.command

Builder interface for CommandRegistration.

CommandRegistration.DefaultAliasSpec - Class in org.springframework.shell.command

CommandRegistration.DefaultBuilder - Class in org.springframework.shell.command

CommandRegistration.DefaultCommandRegistration - Class in org.springframework.shell.command

CommandRegistration.DefaultExitCodeSpec - Class in org.springframework.shell.command

CommandRegistration.DefaultOptionSpec - Class in org.springframework.shell.command

CommandRegistration.DefaultTargetSpec - Class in org.springframework.shell.command

CommandRegistration.ExitCodeSpec - Interface in org.springframework.shell.command

Spec defining an exit code.

CommandRegistration.OptionArity - Enum in org.springframework.shell.command

CommandRegistration.OptionSpec - Interface in org.springframework.shell.command

Spec defining an option.

CommandRegistration.TargetInfo - Interface in org.springframework.shell.command

Encapsulates info for CommandRegistration.TargetSpec.

CommandRegistration.TargetInfo.DefaultTargetInfo - Class in org.springframework.shell.command

CommandRegistration.TargetInfo.TargetType - Enum in org.springframework.shell.command

CommandRegistration.TargetSpec - Interface in org.springframework.shell.command

Spec defining a target.

CommandResolver - Interface in org.springframework.shell.command

Interface to resolve currently existing commands.

CommandValueProvider - Class in org.springframework.shell.standard

A ValueProvider that can be used to auto-complete names of shell commands.

CommandValueProvider(CommandCatalog) - Constructor for class org.springframework.shell.standard.CommandValueProvider

complete(boolean) - Method in class org.springframework.shell.CompletionProposal

complete() - Method in class org.springframework.shell.CompletionProposal

complete(CompletionContext) - Method in class org.springframework.shell.Shell

Gather completion proposals given some (incomplete) input the user has already typed in.

complete(CompletionContext) - Method in class org.springframework.shell.standard.CommandValueProvider

complete(CompletionContext) - Method in class org.springframework.shell.standard.EnumValueProvider

complete(CompletionContext) - Method in class org.springframework.shell.standard.FileValueProvider

complete(CompletionContext) - Method in interface org.springframework.shell.standard.ValueProvider

Complete completion proposals.

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.

completion(CompletionResolver) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

completion(CompletionResolver) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec

Define a completion function for an option.

Completion - Class in org.springframework.shell.standard.commands

Command to create a shell completion files, i.e.

Completion(String) - Constructor for class org.springframework.shell.standard.commands.Completion

Completion.Command - Interface in org.springframework.shell.standard.commands

Marker interface used in auto-config.

CompletionContext - Class in org.springframework.shell

Represents the buffer context in which completion was triggered.

CompletionContext(List<String>, int, int, CommandRegistration, CommandOption) - 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

CompletionResolver - Interface in org.springframework.shell.completion

Interface resolving completion proposals.

completionResolvers - Variable in class org.springframework.shell.Shell

ComponentContext<C extends ComponentContext<C>> - Interface in org.springframework.shell.component.context

Contract for base component context having access to basic key/value pairs.

ComponentFlow - Interface in org.springframework.shell.component.flow

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.

ComponentFlow.BaseBuilder - Class in org.springframework.shell.component.flow

ComponentFlow.Builder - Interface in org.springframework.shell.component.flow

Interface for a wizard builder.

ComponentFlow.ComponentFlowResult - Interface in org.springframework.shell.component.flow

Results from a flow run.

ComponentFlow.DefaultBuilder - Class in org.springframework.shell.component.flow

ComponentFlow.DefaultComponentFlow - Class in org.springframework.shell.component.flow

ComponentFlow.DefaultComponentFlowResult - Class in org.springframework.shell.component.flow

ComponentFlow.OrderedInputOperation - Class in org.springframework.shell.component.flow

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.

ConfirmationInput - Class in org.springframework.shell.component

Component for a confirmation question.

ConfirmationInput(Terminal) - Constructor for class org.springframework.shell.component.ConfirmationInput

ConfirmationInput(Terminal, String) - Constructor for class org.springframework.shell.component.ConfirmationInput

ConfirmationInput(Terminal, String, boolean) - Constructor for class org.springframework.shell.component.ConfirmationInput

ConfirmationInput(Terminal, String, boolean, Function<ConfirmationInput.ConfirmationInputContext, List<AttributedString>>) - Constructor for class org.springframework.shell.component.ConfirmationInput

ConfirmationInput.ConfirmationInputContext - Interface in org.springframework.shell.component

ConfirmationInputSpec - Interface in org.springframework.shell.component.flow

Interface for string input spec builder.

consumer(Consumer<CommandContext>) - Method in class org.springframework.shell.command.CommandRegistration.DefaultTargetSpec

consumer(Consumer<CommandContext>) - Method in interface org.springframework.shell.command.CommandRegistration.TargetSpec

Register a consumer target.

containsKey(Object) - Method in interface org.springframework.shell.component.context.ComponentContext

Check if a context contains a key.

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.

createNamedValueInfo(MethodParameter) - Method in class org.springframework.shell.command.ArgumentHeaderMethodArgumentResolver

createNamedValueInfo(MethodParameter) - Method in class org.springframework.shell.standard.ShellOptionMethodArgumentResolver

createNamedValueInfo(MethodParameter) - Method in class org.springframework.shell.support.AbstractArgumentMethodArgumentResolver

Create the AbstractArgumentMethodArgumentResolver.NamedValueInfo object for the given method parameter.

createWithResolvedBean() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

If the provided instance contains a bean name rather than an object instance, the bean name is resolved before a InvocableShellMethod is created and returned.

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

cursor() - Method in class org.springframework.shell.jline.ExtendedDefaultParser.ExtendedArgumentList

customize(CommandCatalog) - Method in interface org.springframework.shell.command.CommandCatalogCustomizer

Customize a command catalog.

D

DebugAligner - Class in org.springframework.shell.table

A decorator Aligner that checks the Aligner invariants contract, useful for debugging.

DebugAligner(Aligner) - Constructor for class org.springframework.shell.table.DebugAligner

DebugTextWrapper - Class in org.springframework.shell.table

A TextWrapper that delegates to another but makes sure that the contract is not violated.

DebugTextWrapper(TextWrapper) - Constructor for class org.springframework.shell.table.DebugTextWrapper

DEFAULT_ROW_CAPACITY - Static variable in class org.springframework.shell.table.TableModelBuilder

DefaultBuilder() - Constructor for class org.springframework.shell.command.CommandRegistration.DefaultBuilder

DefaultCommandAlias(String, String) - Constructor for class org.springframework.shell.command.CommandAlias.DefaultCommandAlias

DefaultCommandExecution(List<? extends HandlerMethodArgumentResolver>, Validator, Terminal, ConversionService) - Constructor for class org.springframework.shell.command.CommandExecution.DefaultCommandExecution

DefaultCommandOption(String[], Character[], String, ResolvableType, boolean, String, Integer, Integer, Integer, String, CompletionResolver) - Constructor for class org.springframework.shell.command.CommandOption.DefaultCommandOption

DefaultCommandRegistration(String[], InteractionMode, String, String, Supplier<Availability>, List<CommandRegistration.DefaultOptionSpec>, CommandRegistration.DefaultTargetSpec, List<CommandRegistration.DefaultAliasSpec>, CommandRegistration.DefaultExitCodeSpec) - Constructor for class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration

DefaultConfirmationInputSpec - Class in org.springframework.shell.component.flow

Default impl for BaseConfirmationInput.

DefaultConfirmationInputSpec(ComponentFlow.BaseBuilder, String) - Constructor for class org.springframework.shell.component.flow.DefaultConfirmationInputSpec

DefaultFormatter - Class in org.springframework.shell.table

A very simple formatter that uses Object.toString() and splits on newlines.

DefaultFormatter() - Constructor for class org.springframework.shell.table.DefaultFormatter

DefaultMultiInputSpec - Class in org.springframework.shell.component.flow

Default impl for BaseMultiItemSelector.

DefaultMultiInputSpec(ComponentFlow.BaseBuilder, String) - Constructor for class org.springframework.shell.component.flow.DefaultMultiInputSpec

DefaultPathInputSpec - Class in org.springframework.shell.component.flow

Default impl for BasePathInput.

DefaultPathInputSpec(ComponentFlow.BaseBuilder, String) - Constructor for class org.springframework.shell.component.flow.DefaultPathInputSpec

DefaultResultHandler - Class in org.springframework.shell.result

A simple ResultHandler that deals with Objects (hence comes as a last resort) and prints the Object.toString() value of results to standard out.

DefaultResultHandler(Terminal) - Constructor for class org.springframework.shell.result.DefaultResultHandler

defaultResultHandler(Terminal) - Method in class org.springframework.shell.result.ResultHandlerConfig

defaults() - Static method in class org.springframework.shell.style.FigureSettings

defaults() - Static method in class org.springframework.shell.style.StyleSettings

Creates an instance of a default settings.

defaults() - Static method in class org.springframework.shell.style.ThemeSettings

Gets a default theme settings.

defaultSelect(String) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

defaultSelect(String) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec

Automatically selects and exposes a given item.

DefaultSelectItem - Class in org.springframework.shell.component.flow

Default impl for SelectItem.

DefaultSelectItem(String, String, boolean, boolean) - Constructor for class org.springframework.shell.component.flow.DefaultSelectItem

DefaultShellApplicationRunner - Class in org.springframework.shell

Default ShellApplicationRunner which dispatches to the first ordered ShellRunner able to handle the shell.

DefaultShellApplicationRunner(List<ShellRunner>) - Constructor for class org.springframework.shell.DefaultShellApplicationRunner

DefaultShellContext - Class in org.springframework.shell.context

Default implementation of a ShellContext.

DefaultShellContext() - Constructor for class org.springframework.shell.context.DefaultShellContext

DefaultSingleInputSpec - Class in org.springframework.shell.component.flow

Default impl for BaseSingleItemSelector.

DefaultSingleInputSpec(ComponentFlow.BaseBuilder, String) - Constructor for class org.springframework.shell.component.flow.DefaultSingleInputSpec

DefaultStringInputSpec - Class in org.springframework.shell.component.flow

Default impl for BaseStringInput.

DefaultStringInputSpec(ComponentFlow.BaseBuilder, String) - Constructor for class org.springframework.shell.component.flow.DefaultStringInputSpec

DefaultTargetInfo(CommandRegistration.TargetInfo.TargetType, Object, Method, Function<CommandContext, ?>, Consumer<CommandContext>) - Constructor for class org.springframework.shell.command.CommandRegistration.TargetInfo.DefaultTargetInfo

defaultValidator() - Static method in class org.springframework.shell.Utils

Gets a default shared validator.

defaultValidatorFactory() - Static method in class org.springframework.shell.Utils

Gets a default shared validation factory.

defaultValue(String) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

defaultValue(String) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec

Define a defaultValue for an option.

defaultValue(Boolean) - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

defaultValue(String) - Method in class org.springframework.shell.component.flow.BasePathInput

defaultValue(String) - Method in class org.springframework.shell.component.flow.BaseStringInput

defaultValue(Boolean) - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec

Sets a default value.

defaultValue(String) - Method in interface org.springframework.shell.component.flow.PathInputSpec

Sets a default value.

defaultValue(String) - Method in interface org.springframework.shell.component.flow.StringInputSpec

Sets a default value.

DelimiterTextWrapper - Class in org.springframework.shell.table

A Text wrapper that wraps at "word" boundaries.

DelimiterTextWrapper() - Constructor for class org.springframework.shell.table.DelimiterTextWrapper

DelimiterTextWrapper(char) - Constructor for class org.springframework.shell.table.DelimiterTextWrapper

description(String) - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder

description(String) - Method in interface org.springframework.shell.command.CommandRegistration.Builder

Define a description text for a command.

description(String) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

description(String) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec

Define a description for an option.

description() - Method in class org.springframework.shell.CompletionProposal

description(String) - Method in class org.springframework.shell.CompletionProposal

DETAILS_COMMAND_NAME - Static variable in class org.springframework.shell.result.ThrowableResultHandler

The name of the command that may be used to print details about the last error.

displayText() - Method in class org.springframework.shell.CompletionProposal

displayText(String) - Method in class org.springframework.shell.CompletionProposal

doHandleResult(AttributedCharSequence) - Method in class org.springframework.shell.result.AttributedCharSequenceResultHandler

doHandleResult(CommandExecution.CommandParserExceptionsException) - Method in class org.springframework.shell.result.CommandParserExceptionsExceptionResultHandler

doHandleResult(Object) - Method in class org.springframework.shell.result.DefaultResultHandler

doHandleResult(ParameterValidationException) - Method in class org.springframework.shell.result.ParameterValidationExceptionResultHandler

doHandleResult(T) - Method in class org.springframework.shell.result.TerminalAwareResultHandler

doHandleResult(TerminalSizeAware) - Method in class org.springframework.shell.result.TerminalSizeAwareResultHandler

doHandleResult(Throwable) - Method in class org.springframework.shell.result.ThrowableResultHandler

doInvoke(Object...) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

Invoke the handler method with the given argument values.

dontQuote(boolean) - Method in class org.springframework.shell.CompletionProposal

dontQuote() - Method in class org.springframework.shell.CompletionProposal

downwardsArror() - Method in class org.springframework.shell.style.FigureSettings

drop(int) - Method in class org.springframework.shell.CompletionContext

Return a copy of this context, as if the first nbWords were not present

dump() - Static method in class org.springframework.shell.style.FigureSettings

dump() - Static method in class org.springframework.shell.style.StyleSettings

dump() - Static method in class org.springframework.shell.style.ThemeSettings

Gets a dump theme settings.

E

emit(CharSequence) - Method in interface org.springframework.shell.CompletingParsedLine

emit(CharSequence) - Method in class org.springframework.shell.jline.ExtendedDefaultParser.ExtendedArgumentList

empty() - Static method in interface org.springframework.shell.component.ConfirmationInput.ConfirmationInputContext

Gets an empty ConfirmationInput.ConfirmationInputContext.

empty() - Static method in interface org.springframework.shell.component.context.ComponentContext

Gets an empty context.

empty() - Static method in interface org.springframework.shell.component.MultiItemSelector.MultiItemSelectorContext

Creates an empty MultiItemSelector.MultiItemSelectorContext.

empty(Function<T, String>) - Static method in interface org.springframework.shell.component.MultiItemSelector.MultiItemSelectorContext

Creates an MultiItemSelector.MultiItemSelectorContext.

empty() - Static method in interface org.springframework.shell.component.PathInput.PathInputContext

Gets an empty PathInput.PathInputContext.

empty() - Static method in interface org.springframework.shell.component.SingleItemSelector.SingleItemSelectorContext

Creates an empty SingleItemSelector.SingleItemSelectorContext.

empty(Function<C, String>) - Static method in interface org.springframework.shell.component.SingleItemSelector.SingleItemSelectorContext

Creates a SingleItemSelector.SingleItemSelectorContext.

empty() - Static method in interface org.springframework.shell.component.StringInput.StringInputContext

Gets an empty StringInput.StringInputContext.

empty() - Static method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext

Creates an empty AbstractSelectorComponent.SelectorComponentContext.

EMPTY - Static variable in interface org.springframework.shell.Input

Enableable - Interface in org.springframework.shell.component.support

enabled() - Method in class org.springframework.shell.component.flow.DefaultSelectItem

enabled() - Method in interface org.springframework.shell.component.flow.SelectItem

Returns if item is enabled.

EnumValueProvider - Class in org.springframework.shell.standard

A ValueProvider that knows how to complete values for Enum typed parameters.

EnumValueProvider() - Constructor for class org.springframework.shell.standard.EnumValueProvider

equals(Object) - Method in class org.springframework.shell.Command.Help

equals(Object) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

error() - Method in class org.springframework.shell.style.FigureSettings

errors() - Method in interface org.springframework.shell.command.CommandParser.CommandParserResults

Gets parsing errors.

errors() - Method in class org.springframework.shell.command.CommandParser.DefaultCommandParserResults

evaluate(CommandRegistration, String[]) - Method in class org.springframework.shell.command.CommandExecution.DefaultCommandExecution

evaluate(CommandRegistration, String[]) - Method in interface org.springframework.shell.command.CommandExecution

Evaluate a command with a given arguments.

evaluate(Input) - Method in class org.springframework.shell.Shell

Evaluate a single "line" of input from the user by trying to map words to a command and arguments.

evaluateExpression(String) - Method in class org.springframework.shell.style.ThemeResolver

Evaluate expression.

ExitCodeMappings - Interface in org.springframework.shell.exit

Interface used with implementation of a boot's ExitCodeExceptionMapper in a context of spring-shell spesific one.

ExitRequest - Exception in org.springframework.shell

This exception, when thrown and caught, will ask the shell to gracefully shutdown.

ExitRequest() - Constructor for exception org.springframework.shell.ExitRequest

ExitRequest(int) - Constructor for exception org.springframework.shell.ExitRequest

ExtendedArgumentList(String, List<String>, int, int, int, String) - Constructor for class org.springframework.shell.jline.ExtendedDefaultParser.ExtendedArgumentList

ExtendedDefaultParser - Class in org.springframework.shell.jline

Shameful copy-paste of JLine's DefaultParser which creates CompletingParsedLine.

ExtendedDefaultParser() - Constructor for class org.springframework.shell.jline.ExtendedDefaultParser

ExtendedDefaultParser.ExtendedArgumentList - Class in org.springframework.shell.jline

The result of a delimited buffer.

Extent(int, int) - Constructor for class org.springframework.shell.table.SizeConstraints.Extent

F

figures() - Method in class org.springframework.shell.style.ThemeSettings

Gets a FigureSettings.

FigureSettings - Class in org.springframework.shell.style

Base class defining a settings for figures.

FigureSettings() - Constructor for class org.springframework.shell.style.FigureSettings

FileInputProvider - Class in org.springframework.shell.jline

An InputProvider that reads input from file-like sources.

FileInputProvider(Reader, Parser) - Constructor for class org.springframework.shell.jline.FileInputProvider

FileValueProvider - Class in org.springframework.shell.standard

A ValueProvider that can populate names of local Files, either absolute or relative to the current working directory.

FileValueProvider() - Constructor for class org.springframework.shell.standard.FileValueProvider

findProvidedArgument(MethodParameter, Object...) - Static method in class org.springframework.shell.command.invocation.InvocableShellMethod

format(Object) - Method in class org.springframework.shell.table.DefaultFormatter

format(Object) - Method in interface org.springframework.shell.table.Formatter

format(Object) - Method in class org.springframework.shell.table.MapFormatter

formatArgumentError(MethodParameter, String) - Static method in class org.springframework.shell.command.invocation.InvocableShellMethod

formatInvokeError(String, Object[]) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

Formatter - Interface in org.springframework.shell.table

A Formatter is responsible for the initial rendering of a value to lines of text.

fromRowColumn(int, int) - Method in class org.springframework.shell.table.TableBuilder.BorderStub

fromTopLeft() - Method in class org.springframework.shell.table.TableBuilder.BorderStub

FULL - Static variable in class org.springframework.shell.table.BorderSpecification

function(Function<CommandContext, ?>) - Method in class org.springframework.shell.command.CommandRegistration.DefaultTargetSpec

function(Function<CommandContext, ?>) - Method in interface org.springframework.shell.command.CommandRegistration.TargetSpec

Register a function target.

G

generate(String) - Method in class org.springframework.shell.standard.completion.BashCompletions

generateCommandModel() - Method in class org.springframework.shell.standard.completion.AbstractCompletions

Generates a model for a recursive command model starting from root level going down with all sub commands with options.

GenericResultHandler - Interface in org.springframework.shell.result

GenericResultHandlerService - Class in org.springframework.shell.result

Base implementation suitable for use in most environments.

GenericResultHandlerService() - Constructor for class org.springframework.shell.result.GenericResultHandlerService

get(Object) - Method in class org.springframework.shell.component.context.BaseComponentContext

get(Object, Class<T>) - Method in class org.springframework.shell.component.context.BaseComponentContext

get(Object) - Method in interface org.springframework.shell.component.context.ComponentContext

Gets a value from a context.

get(Object, Class<T>) - Method in interface org.springframework.shell.component.context.ComponentContext

Gets a value from a context with a given type to get cast to.

get(String) - Method in class org.springframework.shell.style.ThemeRegistry

Gets a theme from a registry.

getAliases() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration

getAliases() - Method in interface org.springframework.shell.command.CommandRegistration

Gets an aliases.

getApplicationContext() - Method in class org.springframework.shell.standard.AbstractShellComponent

getArityMax() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption

getArityMax() - Method in interface org.springframework.shell.command.CommandOption

Gets a maximum arity.

getArityMax() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

getArityMin() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption

getArityMin() - Method in interface org.springframework.shell.command.CommandOption

Gets a minimum arity.

getArityMin() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

getAvailability() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration

getAvailability() - Method in interface org.springframework.shell.command.CommandRegistration

Get Availability for a command

getAvailability() - Method in exception org.springframework.shell.CommandNotCurrentlyAvailable

getBean() - Method in class org.springframework.shell.command.CommandRegistration.TargetInfo.DefaultTargetInfo

getBean() - Method in interface org.springframework.shell.command.CommandRegistration.TargetInfo

Get the bean.

getBean() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

Return the bean for this handler method.

getBeanType() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

This method returns the type of the handler for this handler method.

getBridgedMethod() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

If the bean method is a bridge method, this method returns the bridged (user-defined) method.

getBuilder() - Method in class org.springframework.shell.component.flow.BaseInput

getColumnCount() - Method in class org.springframework.shell.table.ArrayTableModel

getColumnCount() - Method in class org.springframework.shell.table.BeanListTableModel

getColumnCount() - Method in class org.springframework.shell.table.TableModel

getCommand() - Method in class org.springframework.shell.command.CommandAlias.DefaultCommandAlias

getCommand() - Method in interface org.springframework.shell.command.CommandAlias

Gets a command an alias.

getCommand() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration

getCommand() - Method in interface org.springframework.shell.command.CommandRegistration

Gets a command for this registration.

getCommand() - Method in exception org.springframework.shell.CommandNotCurrentlyAvailable

getCommandCatalog() - Method in class org.springframework.shell.standard.AbstractShellComponent

getCommandOption() - Method in class org.springframework.shell.CompletionContext

getCommandRegistration() - Method in class org.springframework.shell.command.CommandContext.DefaultCommandContext

getCommandRegistration() - Method in interface org.springframework.shell.command.CommandContext

Gets a command registration.

getCommandRegistration() - Method in class org.springframework.shell.CompletionContext

getComparator() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

getComparator() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

getCompletion() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption

getCompletion() - Method in interface org.springframework.shell.command.CommandOption

Gets a completion function.

getCompletion() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

getCompletionResolver() - Method in class org.springframework.shell.standard.AbstractShellComponent

getConstraintViolations() - Method in exception org.springframework.shell.ParameterValidationException

getConsumer() - Method in class org.springframework.shell.command.CommandRegistration.TargetInfo.DefaultTargetInfo

getConsumer() - Method in interface org.springframework.shell.command.CommandRegistration.TargetInfo

Get the consumer

getContainingClass() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod.HandlerMethodParameter

getContext() - Method in interface org.springframework.shell.component.flow.ComponentFlow.ComponentFlowResult

Gets a context.

getContext() - Method in class org.springframework.shell.component.flow.ComponentFlow.DefaultComponentFlowResult

getCursorRow() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext

getCursorRow() - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext

Gets a cursor row.

getDefaultSelect() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

getDefaultValue() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption

getDefaultValue() - Method in interface org.springframework.shell.command.CommandOption

Gets a default value of an option.

getDefaultValue() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

getDefaultValue() - Method in interface org.springframework.shell.component.ConfirmationInput.ConfirmationInputContext

Gets a default value.

getDefaultValue() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

getDefaultValue() - Method in class org.springframework.shell.component.flow.BasePathInput

getDefaultValue() - Method in class org.springframework.shell.component.flow.BaseStringInput

getDefaultValue() - Method in interface org.springframework.shell.component.StringInput.StringInputContext

Gets a default value.

getDescription() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption

getDescription() - Method in interface org.springframework.shell.command.CommandOption

Gets a description of an option.

getDescription() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration

getDescription() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

getDescription() - Method in interface org.springframework.shell.command.CommandRegistration

Get description for a command.

getDescription() - Method in class org.springframework.shell.Command.Help

getEscapeChars() - Method in class org.springframework.shell.jline.ExtendedDefaultParser

getExitCode() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration

getExitCode() - Method in interface org.springframework.shell.command.CommandRegistration

Gets an exit code.

getFunction() - Method in class org.springframework.shell.command.CommandRegistration.TargetInfo.DefaultTargetInfo

getFunction() - Method in interface org.springframework.shell.command.CommandRegistration.TargetInfo

Get the function

getGroup() - Method in class org.springframework.shell.command.CommandAlias.DefaultCommandAlias

getGroup() - Method in interface org.springframework.shell.command.CommandAlias

Get group for an alias.

getGroup() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration

getGroup() - Method in interface org.springframework.shell.command.CommandRegistration

Get group for a command.

getGroup() - Method in class org.springframework.shell.Command.Help

getHandlerTypes() - Method in interface org.springframework.shell.result.GenericResultHandler

getId() - Method in class org.springframework.shell.component.flow.BaseInput

getId() - Method in class org.springframework.shell.component.flow.ComponentFlow.OrderedInputOperation

getIndex() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.ItemState

getInput() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext

getInput() - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext

Gets an input.

getInput() - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext

getInput() - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext

Gets an input.

getInteractionMode() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration

getInteractionMode() - Method in interface org.springframework.shell.command.CommandRegistration

Gets an InteractionMode.

getInteractionMode() - Method in class org.springframework.shell.context.DefaultShellContext

getInteractionMode() - Method in interface org.springframework.shell.context.ShellContext

Gets an interaction mode.

getItem() - Method in interface org.springframework.shell.component.support.Itemable

getItem() - Method in class org.springframework.shell.component.support.SelectorItem.SelectorItemWrapper

getItemMapper() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent

Gets an item mapper.

getItems() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext

getItems() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent

Gets items.

getItems() - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext

Gets an items.

getItemStates() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext

getItemStates() - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext

Gets an item states

getItemStateView() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext

getItemStateView() - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext

Gets an item state view.

getLabel() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption

getLabel() - Method in interface org.springframework.shell.command.CommandOption

Gets a label.

getLabel() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

getLastError() - Method in class org.springframework.shell.result.ThrowableResultHandler

Return the last error that was dealt with by this result handler.

getLongNames() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption

getLongNames() - Method in interface org.springframework.shell.command.CommandOption

Gets a long names of an option.

getLongNames() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

getMappingFunctions() - Method in class org.springframework.shell.command.CommandExitCode.DefaultCommandExitCode

getMappingFunctions() - Method in interface org.springframework.shell.command.CommandExitCode

Gets a function mappings from exceptions to exit codes.

getMaskCharacter() - Method in class org.springframework.shell.component.flow.BaseStringInput

getMaskCharacter() - Method in interface org.springframework.shell.component.StringInput.StringInputContext

Gets a mask character.

getMaskedInput() - Method in interface org.springframework.shell.component.StringInput.StringInputContext

Gets a masked input.

getMaskedResultValue() - Method in interface org.springframework.shell.component.StringInput.StringInputContext

Gets a masked result value.

getMaxItems() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

getMaxItems() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

getMessage() - Method in exception org.springframework.shell.CommandNotFound

getMessage() - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext

getMessage() - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext

Sets a message.

getMessageLevel() - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext

getMessageLevel() - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext

Gets a AbstractTextComponent.TextComponentContext.MessageLevel.

getMethod() - Method in class org.springframework.shell.command.CommandRegistration.TargetInfo.DefaultTargetInfo

getMethod() - Method in interface org.springframework.shell.command.CommandRegistration.TargetInfo

Get the bean method

getMethod() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

Return the method for this handler method.

getMethodAnnotation(Class<A>) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

Return a single annotation on the underlying method traversing its super methods if no annotation can be found on the given method itself.

getMethodAnnotation(Class<T>) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod.HandlerMethodParameter

getMethodArgumentValues(Message<?>, Object...) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

Get the method argument values for the current message, checking the provided argument values and falling back to the configured argument resolvers.

getMethodParameters() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

Return the method parameters for this handler method.

getModel() - Method in class org.springframework.shell.table.Table

getModel() - Method in class org.springframework.shell.table.TableBuilder

getName() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

getName() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

getName() - Method in class org.springframework.shell.component.flow.BasePathInput

getName() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

getName() - Method in class org.springframework.shell.component.flow.BaseStringInput

getName() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext

getName() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.ItemState

getName() - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext

Gets a name.

getName() - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext

getName() - Method in class org.springframework.shell.component.support.AbstractTextComponent

Gets a name.

getName() - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext

Gets a name.

getName() - Method in interface org.springframework.shell.component.support.Nameable

getName() - Method in class org.springframework.shell.component.support.SelectorItem.SelectorItemWrapper

getName() - Method in interface org.springframework.shell.style.Theme

Gets a theme name.

getNext() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

getNext() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

getNext() - Method in class org.springframework.shell.component.flow.BasePathInput

getNext() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

getNext() - Method in class org.springframework.shell.component.flow.BaseStringInput

getNext() - Method in class org.springframework.shell.component.flow.ComponentFlow.OrderedInputOperation

getOperation() - Method in class org.springframework.shell.component.flow.ComponentFlow.OrderedInputOperation

getOption() - Method in exception org.springframework.shell.command.CommandParser.MissingOptionException

getOption() - Method in exception org.springframework.shell.command.CommandParser.OptionException

getOption() - Method in exception org.springframework.shell.command.CommandParser.UnrecognisedOptionException

getOptions() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration

getOptions() - Method in interface org.springframework.shell.command.CommandRegistration

Gets an options.

getOptionValue(String) - Method in class org.springframework.shell.command.CommandContext.DefaultCommandContext

getOptionValue(String) - Method in interface org.springframework.shell.command.CommandContext

Gets an mapped option value.

getOrder() - Method in class org.springframework.shell.component.flow.BaseInput

getOrder() - Method in class org.springframework.shell.component.flow.ComponentFlow.OrderedInputOperation

getParserExceptions() - Method in exception org.springframework.shell.command.CommandExecution.CommandParserExceptionsException

getParserResults() - Method in class org.springframework.shell.command.CommandContext.DefaultCommandContext

getParserResults() - Method in interface org.springframework.shell.command.CommandContext

Gets a command option parser results.

getPosition() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption

getPosition() - Method in interface org.springframework.shell.command.CommandOption

Gets a positional value.

getPosition() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

getPosition() - Method in class org.springframework.shell.CompletionContext

getPostHandlers() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

getPostHandlers() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

getPostHandlers() - Method in class org.springframework.shell.component.flow.BasePathInput

getPostHandlers() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

getPostHandlers() - Method in class org.springframework.shell.component.flow.BaseStringInput

getPreHandlers() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

getPreHandlers() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

getPreHandlers() - Method in class org.springframework.shell.component.flow.BasePathInput

getPreHandlers() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

getPreHandlers() - Method in class org.springframework.shell.component.flow.BaseStringInput

getPrompt() - Method in interface org.springframework.shell.jline.PromptProvider

getQuoteChars() - Method in class org.springframework.shell.jline.ExtendedDefaultParser

getRawArgs() - Method in class org.springframework.shell.command.CommandContext.DefaultCommandContext

getRawArgs() - Method in interface org.springframework.shell.command.CommandContext

Gets a raw args passed into a currently executing command.

getReason() - Method in class org.springframework.shell.Availability

getRegistrations() - Method in class org.springframework.shell.command.CommandCatalog.DefaultCommandCatalog

getRegistrations() - Method in interface org.springframework.shell.command.CommandCatalog

Gets all CommandRegistrations mapped with their names.

getRenderer() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

getRenderer() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

getRenderer() - Method in class org.springframework.shell.component.flow.BasePathInput

getRenderer() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

getRenderer() - Method in class org.springframework.shell.component.flow.BaseStringInput

getResolvedFromHandlerMethod() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

Return the HandlerMethod from which this HandlerMethod instance was resolved via InvocableShellMethod.createWithResolvedBean().

getResolvers() - Method in class org.springframework.shell.command.CommandExecution.CommandExecutionHandlerMethodArgumentResolvers

getResolvers() - Method in class org.springframework.shell.command.invocation.ShellMethodArgumentResolverComposite

Return a read-only list with the contained resolvers, or an empty list.

getResourceLoader() - Method in class org.springframework.shell.standard.AbstractShellComponent

getResultItem() - Method in interface org.springframework.shell.component.SingleItemSelector.SingleItemSelectorContext

Gets a result item.

getResultItems() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext

getResultItems() - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext

Gets a result items.

getResultMode() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

getResultMode() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

getResultMode() - Method in class org.springframework.shell.component.flow.BasePathInput

getResultMode() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

getResultMode() - Method in class org.springframework.shell.component.flow.BaseStringInput

getResultType() - Method in exception org.springframework.shell.result.ResultHandlerNotFoundException

Return the source type that was requested to convert from.

getResultValue() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

getResultValue() - Method in class org.springframework.shell.component.flow.BasePathInput

getResultValue() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

getResultValue() - Method in class org.springframework.shell.component.flow.BaseStringInput

getResultValue() - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext

getResultValue() - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext

Sets a result value.

getResultValues() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

getReturnType() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

Return the HandlerMethod return type.

getReturnValueType(Object) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

Return the actual return value type.

getRowCount() - Method in class org.springframework.shell.table.ArrayTableModel

getRowCount() - Method in class org.springframework.shell.table.BeanListTableModel

getRowCount() - Method in class org.springframework.shell.table.TableModel

getSelectItems() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

getSelectItems() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

getSettings() - Method in interface org.springframework.shell.style.Theme

Gets a theme settings.

getShell() - Method in class org.springframework.shell.standard.AbstractShellComponent

getShortLogMessage() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

Return a short representation of this handler method for log message purposes.

getShortNames() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption

getShortNames() - Method in interface org.springframework.shell.command.CommandOption

Gets a short names of an option.

getShortNames() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

getTarget() - Method in class org.springframework.shell.command.CommandRegistration.DefaultCommandRegistration

getTarget() - Method in interface org.springframework.shell.command.CommandRegistration

Gets target info.

getTargetType() - Method in class org.springframework.shell.command.CommandRegistration.TargetInfo.DefaultTargetInfo

getTargetType() - Method in interface org.springframework.shell.command.CommandRegistration.TargetInfo

Get target type

getTemplateExecutor() - Method in class org.springframework.shell.component.support.AbstractComponent

Gets a template executor.

getTemplateExecutor() - Method in class org.springframework.shell.standard.AbstractShellComponent

getTemplateLocation() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

getTemplateLocation() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

getTemplateLocation() - Method in class org.springframework.shell.component.flow.BasePathInput

getTemplateLocation() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

getTemplateLocation() - Method in class org.springframework.shell.component.flow.BaseStringInput

getTerminal() - Method in class org.springframework.shell.command.CommandContext.DefaultCommandContext

getTerminal() - Method in interface org.springframework.shell.command.CommandContext

Gets a terminal.

getTerminal() - Method in class org.springframework.shell.component.support.AbstractComponent

Gets a Terminal.

getTerminal() - Method in class org.springframework.shell.standard.AbstractShellComponent

getThemeResolver() - Method in class org.springframework.shell.standard.AbstractShellComponent

getThis() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

getThis() - Method in interface org.springframework.shell.component.flow.BaseInputSpec

Usual this trick to get typed child.

getThis() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

getThis() - Method in class org.springframework.shell.component.flow.BasePathInput

getThis() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

getThis() - Method in class org.springframework.shell.component.flow.BaseStringInput

getThisContext(ComponentContext<?>) - Method in class org.springframework.shell.component.ConfirmationInput

getThisContext(ComponentContext<?>) - Method in class org.springframework.shell.component.MultiItemSelector

getThisContext(ComponentContext<?>) - Method in class org.springframework.shell.component.PathInput

getThisContext(ComponentContext<?>) - Method in class org.springframework.shell.component.SingleItemSelector

getThisContext(ComponentContext<?>) - Method in class org.springframework.shell.component.StringInput

getThisContext(ComponentContext<?>) - Method in class org.springframework.shell.component.support.AbstractComponent

Gets a real component context using common this trick.

getType() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption

getType() - Method in interface org.springframework.shell.command.CommandOption

Gets a ResolvableType of an option.

getType() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

getValue() - Method in interface org.springframework.shell.component.SingleItemSelector.SingleItemSelectorContext

Gets a value.

getValue(int, int) - Method in class org.springframework.shell.table.ArrayTableModel

getValue(int, int) - Method in class org.springframework.shell.table.BeanListTableModel

getValue(int, int) - Method in class org.springframework.shell.table.TableModel

getValues() - Method in interface org.springframework.shell.component.MultiItemSelector.MultiItemSelectorContext

Gets a values.

getWordIndex() - Method in class org.springframework.shell.CompletionContext

getWords() - Method in exception org.springframework.shell.CommandNotFound

Gets a words in this exception.

getWords() - Method in class org.springframework.shell.CompletionContext

group(String) - Method in interface org.springframework.shell.command.CommandRegistration.AliasSpec

Define group for an alias.

group(String) - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder

group(String) - Method in interface org.springframework.shell.command.CommandRegistration.Builder

Define a group for a command.

group(String) - Method in class org.springframework.shell.command.CommandRegistration.DefaultAliasSpec

H

handle(Object, TypeDescriptor) - Method in interface org.springframework.shell.result.GenericResultHandler

handle(Object) - Method in class org.springframework.shell.result.GenericResultHandlerService

handle(Object, TypeDescriptor) - Method in class org.springframework.shell.result.GenericResultHandlerService

handle(Object) - Method in interface org.springframework.shell.ResultHandlerService

Handle result.

handle(Object, TypeDescriptor) - Method in interface org.springframework.shell.ResultHandlerService

Handle result to the specified TypeDescriptor.

handleMissingValue(List<String>, MethodParameter, Message<?>) - Method in class org.springframework.shell.command.ArgumentHeaderMethodArgumentResolver

handleMissingValue(List<String>, MethodParameter, Message<?>) - Method in class org.springframework.shell.standard.ShellOptionMethodArgumentResolver

handleMissingValue(List<String>, MethodParameter, Message<?>) - Method in class org.springframework.shell.support.AbstractArgumentMethodArgumentResolver

Invoked when a value is required, but AbstractArgumentMethodArgumentResolver.resolveArgumentInternal(org.springframework.core.MethodParameter, org.springframework.messaging.Message<?>, java.util.List<java.lang.String>) returned null and there is no default value.

handleResolvedValue(Object, List<String>, MethodParameter, Message<?>) - Method in class org.springframework.shell.support.AbstractArgumentMethodArgumentResolver

Invoked after a value is resolved.

handleResult(T) - Method in class org.springframework.shell.result.TerminalAwareResultHandler

handleResult(T) - Method in interface org.springframework.shell.ResultHandler

Deal with some method execution result, whether it was the normal return value, or some kind of Throwable.

HandlerMethodParameter(int) - Constructor for class org.springframework.shell.command.invocation.InvocableShellMethod.HandlerMethodParameter

HandlerMethodParameter(InvocableShellMethod.HandlerMethodParameter) - Constructor for class org.springframework.shell.command.invocation.InvocableShellMethod.HandlerMethodParameter

hashCode() - Method in class org.springframework.shell.Command.Help

hashCode() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

hasMappedOption(String) - Method in class org.springframework.shell.command.CommandContext.DefaultCommandContext

hasMappedOption(String) - Method in interface org.springframework.shell.command.CommandContext

Gets if option has been mapped.

hasMaskCharacter() - Method in interface org.springframework.shell.component.StringInput.StringInputContext

Returns flag if there is a mask character defined.

hasMethodAnnotation(Class<T>) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod.HandlerMethodParameter

hasMethodAnnotation(Class<A>) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

Return whether the parameter is declared with the given annotation type.

hasTty() - Method in class org.springframework.shell.component.support.AbstractComponent

Checks if this component has an existing tty.

HEADER_COMMAND_CONTEXT - Static variable in class org.springframework.shell.command.CommandContextMethodArgumentResolver

Help(String) - Constructor for class org.springframework.shell.Command.Help

Help(String, String) - Constructor for class org.springframework.shell.Command.Help

Help - Class in org.springframework.shell.standard.commands

A command to display help about all available commands.

Help(TemplateExecutor) - Constructor for class org.springframework.shell.standard.commands.Help

help(String[]) - Method in class org.springframework.shell.standard.commands.Help

Help.Command - Interface in org.springframework.shell.standard.commands

Marker interface for beans providing help functionality to the shell.

highlight() - Method in class org.springframework.shell.style.StyleSettings

History - Class in org.springframework.shell.standard.commands

A command that displays all previously run commands, optionally dumping to a file readable by Script.

History(History) - Constructor for class org.springframework.shell.standard.commands.History

history(File) - Method in class org.springframework.shell.standard.commands.History

History.Command - Interface in org.springframework.shell.standard.commands

Marker interface for beans providing history functionality to the shell.

horizontalGlyph() - Method in enum org.springframework.shell.table.BorderStyle

I

info() - Method in class org.springframework.shell.style.FigureSettings

INHERIT_AND_INFER - Static variable in annotation type org.springframework.shell.standard.ShellCommandGroup

The default value for the group label, which when set on a class, will mean to look at the package level on a package, to go back at the class level and infer a name from the class name.

INHERITED - Static variable in annotation type org.springframework.shell.standard.ShellMethod

The default value for ShellMethod.group(), meaning that the group will be inherited from the explicit value set on the containing element (class then package) or ultimately inferred.

INNER - Static variable in class org.springframework.shell.table.BorderSpecification

INNER_HORIZONTAL - Static variable in class org.springframework.shell.table.BorderSpecification

INNER_VERTICAL - Static variable in class org.springframework.shell.table.BorderSpecification

Input - Interface in org.springframework.shell

Represents the input buffer to the shell.

InputProvider - Interface in org.springframework.shell

To be implemented by components able to provide a "line" of user input, whether interactively or by batch.

interactionMode(InteractionMode) - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder

interactionMode(InteractionMode) - Method in interface org.springframework.shell.command.CommandRegistration.Builder

Define InteractionMode for a command.

InteractionMode - Enum in org.springframework.shell.context

Enumeration for modes shell is operating.

InteractiveShellRunner - Class in org.springframework.shell.jline

A ShellRunner that bootstraps the shell in interactive mode.

InteractiveShellRunner(LineReader, PromptProvider, Shell, ShellContext) - Constructor for class org.springframework.shell.jline.InteractiveShellRunner

InteractiveShellRunner.JLineInputProvider - Class in org.springframework.shell.jline

intersection(char, char, char, char) - Static method in enum org.springframework.shell.table.BorderStyle

InvocableShellMethod - Class in org.springframework.shell.command.invocation

Encapsulates information about a handler method consisting of a method and a bean.

InvocableShellMethod(Object, Method) - Constructor for class org.springframework.shell.command.invocation.InvocableShellMethod

Create an instance from a bean instance and a method.

InvocableShellMethod(Object, String, Class<?>...) - Constructor for class org.springframework.shell.command.invocation.InvocableShellMethod

Create an instance from a bean instance, method name, and parameter types.

InvocableShellMethod(String, BeanFactory, Method) - Constructor for class org.springframework.shell.command.invocation.InvocableShellMethod

Create an instance from a bean name, a method, and a BeanFactory.

InvocableShellMethod(InvocableShellMethod) - Constructor for class org.springframework.shell.command.invocation.InvocableShellMethod

Copy constructor for use in subclasses.

InvocableShellMethod.HandlerMethodParameter - Class in org.springframework.shell.command.invocation

A MethodParameter with HandlerMethod-specific behavior.

invoke(Message<?>, Object...) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

Invoke the method after resolving its argument values in the context of the given message.

isAvailable() - Method in class org.springframework.shell.Availability

isDelimiter(CharSequence, int) - Method in class org.springframework.shell.jline.ExtendedDefaultParser

Returns true if the specified character is a whitespace parameter.

isDelimiterChar(CharSequence, int) - Method in class org.springframework.shell.jline.ExtendedDefaultParser

Returns true if the character at the specified position if a delimiter.

isEnabled() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.ItemState

isEnabled() - Method in interface org.springframework.shell.component.support.Enableable

isEnabled() - Method in class org.springframework.shell.component.support.SelectorItem.SelectorItemWrapper

isEofOnEscapedNewLine() - Method in class org.springframework.shell.jline.ExtendedDefaultParser

isEofOnUnclosedQuote() - Method in class org.springframework.shell.jline.ExtendedDefaultParser

isEscapeChar(CharSequence, int) - Method in class org.springframework.shell.jline.ExtendedDefaultParser

Check if this character is a valid escape char (i.e.

isEscaped(CharSequence, int) - Method in class org.springframework.shell.jline.ExtendedDefaultParser

Check if a character is escaped (i.e.

isQuoteChar(CharSequence, int) - Method in class org.springframework.shell.jline.ExtendedDefaultParser

isQuoted(CharSequence, int) - Method in class org.springframework.shell.jline.ExtendedDefaultParser

isRequired() - Method in class org.springframework.shell.command.CommandOption.DefaultCommandOption

isRequired() - Method in interface org.springframework.shell.command.CommandOption

Gets a flag if option is required.

isRequired() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

isResult() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext

isResult() - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext

Return if there is a result.

isSelected() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.ItemState

isSelected() - Method in interface org.springframework.shell.component.support.Selectable

isSelected() - Method in class org.springframework.shell.component.support.SelectorItem.SelectorItemWrapper

isStoreResult() - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

isStoreResult() - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

isStoreResult() - Method in class org.springframework.shell.component.flow.BasePathInput

isStoreResult() - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

isStoreResult() - Method in class org.springframework.shell.component.flow.BaseStringInput

isVoid() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

Return true if the method return type is void, false otherwise.

item() - Method in class org.springframework.shell.component.flow.DefaultSelectItem

item() - Method in interface org.springframework.shell.component.flow.SelectItem

Gets an item

Itemable<T> - Interface in org.springframework.shell.component.support

itemDisabled() - Method in class org.springframework.shell.style.StyleSettings

itemEnabled() - Method in class org.springframework.shell.style.StyleSettings

itemSelected() - Method in class org.springframework.shell.style.StyleSettings

itemSelector() - Method in class org.springframework.shell.style.StyleSettings

itemUnselected() - Method in class org.springframework.shell.style.StyleSettings

J

JLineInputProvider(LineReader, PromptProvider) - Constructor for class org.springframework.shell.jline.InteractiveShellRunner.JLineInputProvider

K

KeyValueHorizontalAligner - Class in org.springframework.shell.table

A text alignment strategy that aligns text horizontally so that all instances of some special character(s) line up perfectly in a column.

KeyValueHorizontalAligner(String) - Constructor for class org.springframework.shell.table.KeyValueHorizontalAligner

KeyValueSizeConstraints - Class in org.springframework.shell.table

A SizeConstraints implementation that is tailored to rendering a series of key = value pairs.

KeyValueSizeConstraints(String) - Constructor for class org.springframework.shell.table.KeyValueSizeConstraints

KeyValueTextWrapper - Class in org.springframework.shell.table

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 '=').

KeyValueTextWrapper() - Constructor for class org.springframework.shell.table.KeyValueTextWrapper

KeyValueTextWrapper(String) - Constructor for class org.springframework.shell.table.KeyValueTextWrapper

L

label(String) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

label(String) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec

Define a label for an option.

LEFT - Static variable in class org.springframework.shell.table.BorderSpecification

leftPointingQuotation() - Method in class org.springframework.shell.style.FigureSettings

leftwardsArrow() - Method in class org.springframework.shell.style.FigureSettings

line() - Method in class org.springframework.shell.jline.ExtendedDefaultParser.ExtendedArgumentList

listKey() - Method in class org.springframework.shell.style.StyleSettings

listLevelError() - Method in class org.springframework.shell.style.StyleSettings

listLevelInfo() - Method in class org.springframework.shell.style.StyleSettings

listLevelWarn() - Method in class org.springframework.shell.style.StyleSettings

listValue() - Method in class org.springframework.shell.style.StyleSettings

log - Static variable in class org.springframework.shell.command.invocation.InvocableShellMethod

Public for wrapping with fallback logger.

longNames(String...) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

longNames(String...) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec

Define long option names.

loop(ComponentContext<?>) - Method in class org.springframework.shell.component.support.AbstractComponent

Enter into read loop.

M

map(Class<? extends Throwable>, int) - Method in class org.springframework.shell.command.CommandRegistration.DefaultExitCodeSpec

map(Function<Throwable, Integer>) - Method in class org.springframework.shell.command.CommandRegistration.DefaultExitCodeSpec

map(Class<? extends Throwable>, int) - Method in interface org.springframework.shell.command.CommandRegistration.ExitCodeSpec

Define mapping from exception to code.

map(Function<Throwable, Integer>) - Method in interface org.springframework.shell.command.CommandRegistration.ExitCodeSpec

MapFormatter - Class in org.springframework.shell.table

A formatter suited for key-value pairs, that renders each mapping on a new line.

MapFormatter(String) - Constructor for class org.springframework.shell.table.MapFormatter

maskCharacter(Character) - Method in class org.springframework.shell.component.flow.BaseStringInput

maskCharacter(Character) - Method in interface org.springframework.shell.component.flow.StringInputSpec

Sets a mask character.

Matchable - Interface in org.springframework.shell.component.support

matches(String) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.ItemState

matches(String) - Method in interface org.springframework.shell.component.support.Matchable

matches(String) - Method in class org.springframework.shell.component.support.SelectorItem.SelectorItemWrapper

matches(TypeDescriptor) - Method in interface org.springframework.shell.result.GenericResultHandler

matches(int, int, TableModel) - Method in interface org.springframework.shell.table.CellMatcher

max(int) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

max(int) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

max(int) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec

Sets a maximum number of items in a selector list;

max(int) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec

Sets a maximum number of items in a selector list;

max - Variable in class org.springframework.shell.table.SizeConstraints.Extent

method(Object, Method) - Method in class org.springframework.shell.command.CommandRegistration.DefaultTargetSpec

method(Object, String, Class<?>...) - Method in class org.springframework.shell.command.CommandRegistration.DefaultTargetSpec

method(Object, String, Class<?>...) - Method in interface org.springframework.shell.command.CommandRegistration.TargetSpec

Register a method target.

method(Object, Method) - Method in interface org.springframework.shell.command.CommandRegistration.TargetSpec

Register a method target.

methodParameter() - Method in class org.springframework.shell.ValueResult

The MethodParameter that was the target of the resolve operation.

MethodTargetRegistrar - Interface in org.springframework.shell

Strategy interface for registering commands.

min - Variable in class org.springframework.shell.table.SizeConstraints.Extent

MissingOptionException(String, CommandOption) - Constructor for exception org.springframework.shell.command.CommandParser.MissingOptionException

MultiItemSelector<T,I extends Nameable & Matchable & Enableable & Selectable & Itemable<T>> - Class in org.springframework.shell.component

Component able to pick multiple items.

MultiItemSelector(Terminal, List<I>, String, Comparator<I>) - Constructor for class org.springframework.shell.component.MultiItemSelector

MultiItemSelector.MultiItemSelectorContext<T,I extends Nameable & Matchable & Itemable<T>> - Interface in org.springframework.shell.component

Context MultiItemSelector.

MultiItemSelectorSpec - Interface in org.springframework.shell.component.flow

Interface for multi input spec builder.

N

name(String) - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

name(String) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

name(String) - Method in class org.springframework.shell.component.flow.BasePathInput

name(String) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

name(String) - Method in class org.springframework.shell.component.flow.BaseStringInput

name(String) - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec

Sets a name.

name() - Method in class org.springframework.shell.component.flow.DefaultSelectItem

name(String) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec

Sets a name.

name(String) - Method in interface org.springframework.shell.component.flow.PathInputSpec

Sets a name.

name() - Method in interface org.springframework.shell.component.flow.SelectItem

Gets a name.

name(String) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec

Sets a name.

name(String) - Method in interface org.springframework.shell.component.flow.StringInputSpec

Sets a name.

name - Variable in class org.springframework.shell.component.support.AbstractSelectorComponent

Nameable - Interface in org.springframework.shell.component.support

NamedValueInfo(List<String>, boolean, String) - Constructor for class org.springframework.shell.support.AbstractArgumentMethodArgumentResolver.NamedValueInfo

next(Function<ConfirmationInput.ConfirmationInputContext, String>) - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

next(Function<MultiItemSelector.MultiItemSelectorContext<String, SelectorItem<String>>, String>) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

next(Function<PathInput.PathInputContext, String>) - Method in class org.springframework.shell.component.flow.BasePathInput

next(Function<SingleItemSelector.SingleItemSelectorContext<String, SelectorItem<String>>, String>) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

next(Function<StringInput.StringInputContext, String>) - Method in class org.springframework.shell.component.flow.BaseStringInput

next(Function<ConfirmationInput.ConfirmationInputContext, String>) - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec

Define a function which may return id of a next component to go.

next(Function<MultiItemSelector.MultiItemSelectorContext<String, SelectorItem<String>>, String>) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec

Define a function which may return id of a next component to go.

next(Function<PathInput.PathInputContext, String>) - Method in interface org.springframework.shell.component.flow.PathInputSpec

Define a function which may return id of a next component to go.

next(Function<SingleItemSelector.SingleItemSelectorContext<String, SelectorItem<String>>, String>) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec

Define a function which may return id of a next component to go.

next(Function<StringInput.StringInputContext, String>) - Method in interface org.springframework.shell.component.flow.StringInputSpec

Define a function which may return id of a next component to go.

NO_INPUT - Static variable in class org.springframework.shell.Shell

Marker object returned to signify that there was no input to turn into a command execution.

NONE - Static variable in annotation type org.springframework.shell.standard.ShellOption

Used to indicate that there is no default value (i.e. parameter is mandatory).

NONE - Static variable in class org.springframework.shell.table.BorderSpecification

NONE - Static variable in enum org.springframework.shell.table.BorderStyle

NonInteractiveShellRunner - Class in org.springframework.shell.jline

A ShellRunner that executes commands without entering interactive shell mode.

NonInteractiveShellRunner(Shell, ShellContext) - Constructor for class org.springframework.shell.jline.NonInteractiveShellRunner

NotEnoughArgumentsOptionException(String, CommandOption) - Constructor for exception org.springframework.shell.command.CommandParser.NotEnoughArgumentsOptionException

NoWrapSizeConstraints - Class in org.springframework.shell.table

A sizing strategy that will impose the longest line width on cells.

NoWrapSizeConstraints() - Constructor for class org.springframework.shell.table.NoWrapSizeConstraints

NULL - Static variable in annotation type org.springframework.shell.standard.ShellOption

Used to indicate that the default value is the value null, which is different from the fact that there is no default value.

O

of(String, String) - Static method in interface org.springframework.shell.command.CommandAlias

Gets an instance of a default CommandAlias.

of() - Static method in interface org.springframework.shell.command.CommandCatalog

Gets an instance of a default CommandCatalog.

of(Collection<CommandResolver>, ShellContext) - Static method in interface org.springframework.shell.command.CommandCatalog

Gets an instance of a default CommandCatalog.

of(String[], CommandParser.CommandParserResults, Terminal, CommandRegistration) - Static method in interface org.springframework.shell.command.CommandContext

Gets an instance of a default CommandContext.

of(String, List<CommandParser.CommandParserException>) - Static method in exception org.springframework.shell.command.CommandExecution.CommandParserExceptionsException

of(List<? extends HandlerMethodArgumentResolver>) - Static method in interface org.springframework.shell.command.CommandExecution

Gets an instance of a default CommandExecution.

of(List<? extends HandlerMethodArgumentResolver>, Validator, Terminal, ConversionService) - Static method in interface org.springframework.shell.command.CommandExecution

Gets an instance of a default CommandExecution.

of() - Static method in interface org.springframework.shell.command.CommandExitCode

Gets an instance of a default CommandExitCode.

of(List<Function<Throwable, Integer>>) - Static method in interface org.springframework.shell.command.CommandExitCode

Gets an instance of a default CommandExitCode.

of(String[], Character[], String) - Static method in interface org.springframework.shell.command.CommandOption

Gets an instance of a default CommandOption.

of(String[], Character[], String, ResolvableType) - Static method in interface org.springframework.shell.command.CommandOption

Gets an instance of a default CommandOption.

of(String[], Character[], String, ResolvableType, boolean, String, Integer, Integer, Integer, String, CompletionResolver) - Static method in interface org.springframework.shell.command.CommandOption

Gets an instance of a default CommandOption.

of(String) - Static method in exception org.springframework.shell.command.CommandParser.CommandParserException

of(CommandOption, Object) - Static method in interface org.springframework.shell.command.CommandParser.CommandParserResult

Gets an instance of a default CommandParser.CommandParserResult.

of(List<CommandParser.CommandParserResult>, List<String>, List<CommandParser.CommandParserException>) - Static method in interface org.springframework.shell.command.CommandParser.CommandParserResults

Gets an instance of a default CommandParser.CommandParserResults.

of(String, CommandOption) - Static method in exception org.springframework.shell.command.CommandParser.MissingOptionException

of() - Static method in interface org.springframework.shell.command.CommandParser

Gets an instance of a default command parser.

of(ConversionService) - Static method in interface org.springframework.shell.command.CommandParser

Gets an instance of a default command parser.

of(String, String) - Static method in exception org.springframework.shell.command.CommandParser.UnrecognisedOptionException

of(Object, Method) - Static method in interface org.springframework.shell.command.CommandRegistration.TargetInfo

of(Function<CommandContext, ?>) - Static method in interface org.springframework.shell.command.CommandRegistration.TargetInfo

of(Consumer<CommandContext>) - Static method in interface org.springframework.shell.command.CommandRegistration.TargetInfo

of(Boolean) - Static method in interface org.springframework.shell.component.ConfirmationInput.ConfirmationInputContext

Gets an ConfirmationInput.ConfirmationInputContext.

of(String, String) - Static method in interface org.springframework.shell.component.flow.SelectItem

of(String, String, boolean, boolean) - Static method in interface org.springframework.shell.component.flow.SelectItem

of(String, Character) - Static method in interface org.springframework.shell.component.StringInput.StringInputContext

Gets an StringInput.StringInputContext.

of(String, T) - Static method in interface org.springframework.shell.component.support.SelectorItem

of(String, T, boolean, boolean) - Static method in interface org.springframework.shell.component.support.SelectorItem

of(String, ThemeSettings) - Static method in interface org.springframework.shell.style.Theme

Create a Theme.

ofType(Class<?>) - Static method in class org.springframework.shell.table.CellMatchers

on(CellMatcher) - Method in class org.springframework.shell.table.TableBuilder.CellMatcherStub

on(CellMatcher) - Method in class org.springframework.shell.table.TableBuilder

OPERATION_BACKSPACE - Static variable in class org.springframework.shell.component.support.AbstractComponent

OPERATION_CHAR - Static variable in class org.springframework.shell.component.support.AbstractComponent

OPERATION_DOWN - Static variable in class org.springframework.shell.component.support.AbstractComponent

OPERATION_EXIT - Static variable in class org.springframework.shell.component.support.AbstractComponent

OPERATION_SELECT - Static variable in class org.springframework.shell.component.support.AbstractComponent

OPERATION_UP - Static variable in class org.springframework.shell.component.support.AbstractComponent

option() - Method in interface org.springframework.shell.command.CommandParser.CommandParserResult

Gets the CommandOption.

option() - Method in class org.springframework.shell.command.CommandParser.DefaultCommandParserResult

OptionException(String, CommandOption) - Constructor for exception org.springframework.shell.command.CommandParser.OptionException

order(int) - Method in class org.springframework.shell.component.flow.BaseInput

order(int) - Method in interface org.springframework.shell.component.flow.BaseInputSpec

Sets order of this component.

OrderedInputOperation() - Constructor for class org.springframework.shell.component.flow.ComponentFlow.OrderedInputOperation

org.springframework.shell - package org.springframework.shell

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

org.springframework.shell.command - package org.springframework.shell.command

org.springframework.shell.command.invocation - package org.springframework.shell.command.invocation

org.springframework.shell.completion - package org.springframework.shell.completion

org.springframework.shell.component - package org.springframework.shell.component

org.springframework.shell.component.context - package org.springframework.shell.component.context

org.springframework.shell.component.flow - package org.springframework.shell.component.flow

org.springframework.shell.component.support - package org.springframework.shell.component.support

org.springframework.shell.config - package org.springframework.shell.config

org.springframework.shell.context - package org.springframework.shell.context

org.springframework.shell.exit - package org.springframework.shell.exit

org.springframework.shell.jline - package org.springframework.shell.jline

Contains classes that leverage the JLine library to hook into the Spring Shell REPL.

org.springframework.shell.result - package org.springframework.shell.result

Contains strategies for dealing with results of commands.

org.springframework.shell.standard - package org.springframework.shell.standard

Contains infrastructure for describing commands with the "new" preferred Spring Shell programming model.

org.springframework.shell.standard.commands - package org.springframework.shell.standard.commands

Contains default commands that ought to apply to each shell app.

org.springframework.shell.standard.completion - package org.springframework.shell.standard.completion

org.springframework.shell.style - package org.springframework.shell.style

org.springframework.shell.support - package org.springframework.shell.support

org.springframework.shell.table - package org.springframework.shell.table

Allows the creation of tables that can be rendered using ASCII art.

OUTLINE - Static variable in class org.springframework.shell.table.BorderSpecification

P

paintBorder(BorderStyle, int) - Method in class org.springframework.shell.table.TableBuilder

ParameterResolverMissingException - Exception in org.springframework.shell

Thrown when no ParameterResolver is found for a parameter during a resolve operation.

ParameterResolverMissingException(MethodParameter) - Constructor for exception org.springframework.shell.ParameterResolverMissingException

ParameterValidationException - Exception in org.springframework.shell

Thrown when one or more parameters fail bean validation constraints.

ParameterValidationException(Set<ConstraintViolation<Object>>) - Constructor for exception org.springframework.shell.ParameterValidationException

ParameterValidationExceptionResultHandler - Class in org.springframework.shell.result

Displays validation errors on the terminal.

ParameterValidationExceptionResultHandler(Terminal) - Constructor for class org.springframework.shell.result.ParameterValidationExceptionResultHandler

parameterValidationExceptionResultHandler(Terminal) - Method in class org.springframework.shell.result.ResultHandlerConfig

parse(List<CommandOption>, String[]) - Method in class org.springframework.shell.command.CommandParser.DefaultCommandParser

parse(List<CommandOption>, String[]) - Method in interface org.springframework.shell.command.CommandParser

Parse options with a given arguments.

parse(String, int, Parser.ParseContext) - Method in class org.springframework.shell.jline.ExtendedDefaultParser

PathInput - Class in org.springframework.shell.component

Component for a simple path input.

PathInput(Terminal) - Constructor for class org.springframework.shell.component.PathInput

PathInput(Terminal, String) - Constructor for class org.springframework.shell.component.PathInput

PathInput(Terminal, String, Function<PathInput.PathInputContext, List<AttributedString>>) - Constructor for class org.springframework.shell.component.PathInput

PathInput.PathInputContext - Interface in org.springframework.shell.component

PathInputSpec - Interface in org.springframework.shell.component.flow

Interface for path input spec builder.

position(Integer) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

position(Integer) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec

Define an optional hint for possible positional mapping.

positional() - Method in interface org.springframework.shell.command.CommandParser.CommandParserResults

Gets the unmapped positional arguments.

positional() - Method in class org.springframework.shell.command.CommandParser.DefaultCommandParserResults

postHandler(Consumer<ConfirmationInput.ConfirmationInputContext>) - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

postHandler(Consumer<MultiItemSelector.MultiItemSelectorContext<String, SelectorItem<String>>>) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

postHandler(Consumer<PathInput.PathInputContext>) - Method in class org.springframework.shell.component.flow.BasePathInput

postHandler(Consumer<SingleItemSelector.SingleItemSelectorContext<String, SelectorItem<String>>>) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

postHandler(Consumer<StringInput.StringInputContext>) - Method in class org.springframework.shell.component.flow.BaseStringInput

postHandler(Consumer<ConfirmationInput.ConfirmationInputContext>) - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec

Adds a post-run context handler.

postHandler(Consumer<MultiItemSelector.MultiItemSelectorContext<String, SelectorItem<String>>>) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec

Adds a post-run context handler.

postHandler(Consumer<PathInput.PathInputContext>) - Method in interface org.springframework.shell.component.flow.PathInputSpec

Adds a post-run context handler.

postHandler(Consumer<SingleItemSelector.SingleItemSelectorContext<String, SelectorItem<String>>>) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec

Adds a post-run context handler.

postHandler(Consumer<StringInput.StringInputContext>) - Method in interface org.springframework.shell.component.flow.StringInputSpec

Adds a post-run context handler.

PRECEDENCE - Static variable in class org.springframework.shell.DefaultShellApplicationRunner

The precedence at which this runner is executed with respect to other ApplicationRunner beans

PRECEDENCE - Static variable in class org.springframework.shell.jline.InteractiveShellRunner

The precedence at which this runner is ordered by the DefaultApplicationRunner - which also controls the order it is consulted on the ability to handle the current shell.

PRECEDENCE - Static variable in class org.springframework.shell.jline.NonInteractiveShellRunner

The precedence at which this runner is ordered by the DefaultApplicationRunner - which also controls the order it is consulted on the ability to handle the current shell.

PRECEDENCE - Static variable in class org.springframework.shell.jline.ScriptShellRunner

The precedence at which this runner is ordered by the DefaultApplicationRunner - which also controls the order it is consulted on the ability to handle the current shell.

preHandler(Consumer<ConfirmationInput.ConfirmationInputContext>) - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

preHandler(Consumer<MultiItemSelector.MultiItemSelectorContext<String, SelectorItem<String>>>) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

preHandler(Consumer<PathInput.PathInputContext>) - Method in class org.springframework.shell.component.flow.BasePathInput

preHandler(Consumer<SingleItemSelector.SingleItemSelectorContext<String, SelectorItem<String>>>) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

preHandler(Consumer<StringInput.StringInputContext>) - Method in class org.springframework.shell.component.flow.BaseStringInput

preHandler(Consumer<ConfirmationInput.ConfirmationInputContext>) - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec

Adds a pre-run context handler.

preHandler(Consumer<MultiItemSelector.MultiItemSelectorContext<String, SelectorItem<String>>>) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec

Adds a pre-run context handler.

preHandler(Consumer<PathInput.PathInputContext>) - Method in interface org.springframework.shell.component.flow.PathInputSpec

Adds a pre-run context handler.

preHandler(Consumer<SingleItemSelector.SingleItemSelectorContext<String, SelectorItem<String>>>) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec

Adds a pre-run context handler.

preHandler(Consumer<StringInput.StringInputContext>) - Method in interface org.springframework.shell.component.flow.StringInputSpec

Adds a pre-run context handler.

PromptProvider - Interface in org.springframework.shell.jline

Called at each REPL cycle to decide what the prompt should be.

provide() - Method in interface org.springframework.shell.config.UserConfigPathProvider

Provides a path to a user config location.

put(Object, Object) - Method in class org.springframework.shell.component.context.BaseComponentContext

put(Object, Object) - Method in interface org.springframework.shell.component.context.ComponentContext

Put an entry into a context.

Q

questionMark() - Method in class org.springframework.shell.style.FigureSettings

Quit - Class in org.springframework.shell.standard.commands

A command that terminates the running shell.

Quit() - Constructor for class org.springframework.shell.standard.commands.Quit

quit() - Method in class org.springframework.shell.standard.commands.Quit

Quit.Command - Interface in org.springframework.shell.standard.commands

Marker interface for beans providing quit functionality to the shell.

R

rawText() - Method in interface org.springframework.shell.Input

Return the input as entered by the user.

read(BindingReader, KeyMap<String>, ConfirmationInput.ConfirmationInputContext) - Method in class org.springframework.shell.component.ConfirmationInput

read(BindingReader, KeyMap<String>, PathInput.PathInputContext) - Method in class org.springframework.shell.component.PathInput

read(BindingReader, KeyMap<String>, StringInput.StringInputContext) - Method in class org.springframework.shell.component.StringInput

read(BindingReader, KeyMap<String>, T) - Method in class org.springframework.shell.component.support.AbstractComponent

Read input.

read(BindingReader, KeyMap<String>, C) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent

readInput() - Method in interface org.springframework.shell.InputProvider

Return text entered by user to invoke commands.

readInput() - Method in class org.springframework.shell.jline.FileInputProvider

readInput() - Method in class org.springframework.shell.jline.InteractiveShellRunner.JLineInputProvider

register(CommandRegistration...) - Method in class org.springframework.shell.command.CommandCatalog.DefaultCommandCatalog

register(CommandRegistration...) - Method in interface org.springframework.shell.command.CommandCatalog

Register a CommandRegistration.

register(CommandCatalog) - Method in interface org.springframework.shell.MethodTargetRegistrar

Register mappings from <command keyword(s)> to actual behavior.

register(CommandCatalog) - Method in class org.springframework.shell.standard.StandardMethodTargetRegistrar

register(Theme) - Method in class org.springframework.shell.style.ThemeRegistry

Register a theme.

RegistrationOptionsCompletionResolver - Class in org.springframework.shell.completion

Default implementation of a CompletionResolver.

RegistrationOptionsCompletionResolver() - Constructor for class org.springframework.shell.completion.RegistrationOptionsCompletionResolver

render(T) - Method in class org.springframework.shell.component.support.AbstractComponent

Render to be shows content of a display with set display renderer using a given context.

render(String, Map<String, Object>) - Method in class org.springframework.shell.style.TemplateExecutor

Render template with a given attributes.

render(int) - Method in class org.springframework.shell.table.Table

render(int) - Method in interface org.springframework.shell.TerminalSizeAware

renderer(Function<ConfirmationInput.ConfirmationInputContext, List<AttributedString>>) - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

renderer(Function<MultiItemSelector.MultiItemSelectorContext<String, SelectorItem<String>>, List<AttributedString>>) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

renderer(Function<PathInput.PathInputContext, List<AttributedString>>) - Method in class org.springframework.shell.component.flow.BasePathInput

renderer(Function<SingleItemSelector.SingleItemSelectorContext<String, SelectorItem<String>>, List<AttributedString>>) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

renderer(Function<StringInput.StringInputContext, List<AttributedString>>) - Method in class org.springframework.shell.component.flow.BaseStringInput

renderer(Function<ConfirmationInput.ConfirmationInputContext, List<AttributedString>>) - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec

Sets a renderer function.

renderer(Function<MultiItemSelector.MultiItemSelectorContext<String, SelectorItem<String>>, List<AttributedString>>) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec

Sets a renderer function.

renderer(Function<PathInput.PathInputContext, List<AttributedString>>) - Method in interface org.springframework.shell.component.flow.PathInputSpec

Sets a renderer function.

renderer(Function<SingleItemSelector.SingleItemSelectorContext<String, SelectorItem<String>>, List<AttributedString>>) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec

Sets a renderer function.

renderer(Function<StringInput.StringInputContext, List<AttributedString>>) - Method in interface org.springframework.shell.component.flow.StringInputSpec

Sets a renderer function.

renderGroup(String, Map<String, Object>) - Method in class org.springframework.shell.style.TemplateExecutor

Render template group with a given attributes expecting to find instance named main.

renderTemplateResource(Map<String, Object>) - Method in class org.springframework.shell.component.support.AbstractComponent

Render a given template with attributes.

required(boolean) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

required() - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

required(boolean) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec

Define if option is required.

required() - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec

Define option to be required.

reset() - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder

reset() - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder

Resets existing builder.

reset(List<Function<Throwable, Integer>>) - Method in interface org.springframework.shell.exit.ExitCodeMappings

Reset mappings into a given functions.

resolve() - Method in interface org.springframework.shell.command.CommandResolver

Resolve command registrations.

resolveArgument(MethodParameter, Message<?>) - Method in class org.springframework.shell.command.CommandContextMethodArgumentResolver

resolveArgument(MethodParameter, Message<?>) - Method in class org.springframework.shell.command.CommandExecution.ParamNameHandlerMethodArgumentResolver

resolveArgument(MethodParameter, Message<?>) - Method in class org.springframework.shell.command.invocation.ShellMethodArgumentResolverComposite

Iterate over registered HandlerMethodArgumentResolvers and invoke the one that supports it.

resolveArgument(MethodParameter, Message<?>) - Method in class org.springframework.shell.support.AbstractArgumentMethodArgumentResolver

resolveArgumentInternal(MethodParameter, Message<?>, List<String>) - Method in class org.springframework.shell.command.ArgumentHeaderMethodArgumentResolver

resolveArgumentInternal(MethodParameter, Message<?>, List<String>) - Method in class org.springframework.shell.standard.ShellOptionMethodArgumentResolver

resolveArgumentInternal(MethodParameter, Message<?>, List<String>) - Method in class org.springframework.shell.support.AbstractArgumentMethodArgumentResolver

Resolves the given parameter type and value name into an argument value.

resolvedValue() - Method in class org.springframework.shell.ValueResult

Represents the resolved value for the MethodParameter associated with this result.

resolveFigureTag(String) - Method in class org.springframework.shell.style.ThemeResolver

Resolve figure from a tag with activated theme.

resolvePath(String) - Method in class org.springframework.shell.component.PathInput

Resolves a Path from a given raw path.

resolveStyle(String) - Method in class org.springframework.shell.style.ThemeResolver

Resolve AttributedStyle from a spec.

resolveStyleTag(String) - Method in class org.springframework.shell.style.ThemeResolver

Resolve style from a tag with activated theme.

resolveTag(String) - Method in class org.springframework.shell.style.FigureSettings

resolveTag(String) - Method in class org.springframework.shell.style.StyleSettings

Resolve a theme setting from a given tag.

resourceLoader(ResourceLoader) - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder

resourceLoader(ResourceLoader) - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder

Sets a ResourceLoader.

ResultHandler<T> - Interface in org.springframework.shell

Implementations know how to deal with results of method invocations, whether normal results or exceptions thrown.

ResultHandlerConfig - Class in org.springframework.shell.result

Used for explicit configuration of ResultHandlers.

ResultHandlerConfig() - Constructor for class org.springframework.shell.result.ResultHandlerConfig

ResultHandlerNotFoundException - Exception in org.springframework.shell.result

ResultHandlerNotFoundException(TypeDescriptor) - Constructor for exception org.springframework.shell.result.ResultHandlerNotFoundException

Create a new handling executor not found exception.

ResultHandlerService - Interface in org.springframework.shell

A service interface for result handling.

ResultHandlingException - Exception in org.springframework.shell.result

ResultHandlingException(String) - Constructor for exception org.springframework.shell.result.ResultHandlingException

Construct a new result handling exception.

ResultHandlingException(String, Throwable) - Constructor for exception org.springframework.shell.result.ResultHandlingException

Construct a new result handling exception.

resultMode(ResultMode) - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

resultMode(ResultMode) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

resultMode(ResultMode) - Method in class org.springframework.shell.component.flow.BasePathInput

resultMode(ResultMode) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

resultMode(ResultMode) - Method in class org.springframework.shell.component.flow.BaseStringInput

resultMode(ResultMode) - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec

Sets a result mode.

resultMode(ResultMode) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec

Sets a result mode.

resultMode(ResultMode) - Method in interface org.springframework.shell.component.flow.PathInputSpec

Sets a result mode.

ResultMode - Enum in org.springframework.shell.component.flow

Enumeration of a modes instructing how resultValue is handled.

resultMode(ResultMode) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec

Sets a result mode.

resultMode(ResultMode) - Method in interface org.springframework.shell.component.flow.StringInputSpec

Sets a result mode.

results() - Method in interface org.springframework.shell.command.CommandParser.CommandParserResults

Gets the results.

results() - Method in class org.springframework.shell.command.CommandParser.DefaultCommandParserResults

resultValue(Boolean) - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

resultValue(String) - Method in class org.springframework.shell.component.flow.BasePathInput

resultValue(String) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

resultValue(String) - Method in class org.springframework.shell.component.flow.BaseStringInput

resultValue(Boolean) - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec

Sets a result value.

resultValue(String) - Method in interface org.springframework.shell.component.flow.PathInputSpec

Sets a result value.

resultValue(String) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec

Sets a result value.

resultValue(String) - Method in interface org.springframework.shell.component.flow.StringInputSpec

Sets a result value.

resultValues(List<String>) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

resultValues(List<String>) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec

Sets a result values.

RIGHT - Static variable in class org.springframework.shell.table.BorderSpecification

rightPointingQuotation() - Method in class org.springframework.shell.style.FigureSettings

righwardsArror() - Method in class org.springframework.shell.style.FigureSettings

row(int) - Static method in class org.springframework.shell.table.CellMatchers

run() - Method in class org.springframework.shell.component.flow.ComponentFlow.DefaultComponentFlow

run() - Method in interface org.springframework.shell.component.flow.ComponentFlow

Run a wizard and returns a result from it.

run(ComponentContext<?>) - Method in class org.springframework.shell.component.support.AbstractComponent

Runs a component logic with a given context and returns updated context.

run(ApplicationArguments) - Method in class org.springframework.shell.DefaultShellApplicationRunner

run(ApplicationArguments) - Method in class org.springframework.shell.jline.InteractiveShellRunner

run(ApplicationArguments) - Method in class org.springframework.shell.jline.NonInteractiveShellRunner

run(ApplicationArguments) - Method in class org.springframework.shell.jline.ScriptShellRunner

run(InputProvider) - Method in class org.springframework.shell.Shell

The main program loop: acquire input, try to match it to a command and evaluate.

run(ApplicationArguments) - Method in interface org.springframework.shell.ShellRunner

Execute application.

runInternal(MultiItemSelector.MultiItemSelectorContext<T, I>) - Method in class org.springframework.shell.component.MultiItemSelector

runInternal(SingleItemSelector.SingleItemSelectorContext<T, I>) - Method in class org.springframework.shell.component.SingleItemSelector

runInternal(T) - Method in class org.springframework.shell.component.support.AbstractComponent

Run internal logic called from public run method.

runInternal(C) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent

runInternal(C) - Method in class org.springframework.shell.component.support.AbstractTextComponent

runPostRunHandlers(T) - Method in class org.springframework.shell.component.support.AbstractComponent

Run post-run handlers

runPreRunHandlers(T) - Method in class org.springframework.shell.component.support.AbstractComponent

Run pre-run handlers

S

sanitizeInput(List<String>) - Static method in class org.springframework.shell.Utils

Sanitize the buffer input given the customizations applied to the JLine parser (e.g. support for line continuations, etc.)

Script - Class in org.springframework.shell.standard.commands

A command that can read and execute other commands from a file.

Script(Parser) - Constructor for class org.springframework.shell.standard.commands.Script

script(File) - Method in class org.springframework.shell.standard.commands.Script

Script.Command - Interface in org.springframework.shell.standard.commands

Marker interface for beans providing script functionality to the shell.

ScriptShellRunner - Class in org.springframework.shell.jline

A ShellRunner that looks for process arguments that start with @, which are then interpreted as references to script files to run and exit.

ScriptShellRunner(Parser, Shell) - Constructor for class org.springframework.shell.jline.ScriptShellRunner

Selectable - Interface in org.springframework.shell.component.support

selected() - Method in class org.springframework.shell.component.flow.DefaultSelectItem

selected() - Method in interface org.springframework.shell.component.flow.SelectItem

Return if the item is selected.

selectItem(String, String) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

SelectItem - Interface in org.springframework.shell.component.flow

Interface for selectitem contract in selectors.

selectItem(String, String) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec

Adds a select item.

selectItems(List<SelectItem>) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

selectItems(Map<String, String>) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

selectItems(List<SelectItem>) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec

Adds a list of select items.

selectItems(Map<String, String>) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec

Adds a map of select items.

SelectorItem<T> - Interface in org.springframework.shell.component.support

SelectorItem.SelectorItemWrapper<T> - Class in org.springframework.shell.component.support

SelectorItemWrapper(String, T) - Constructor for class org.springframework.shell.component.support.SelectorItem.SelectorItemWrapper

SelectorItemWrapper(String, T, boolean, boolean) - Constructor for class org.springframework.shell.component.support.SelectorItem.SelectorItemWrapper

setApplicationContext(ApplicationContext) - Method in class org.springframework.shell.standard.AbstractShellComponent

setApplicationContext(ApplicationContext) - Method in class org.springframework.shell.standard.StandardMethodTargetRegistrar

setArgumentResolvers(CommandExecution.CommandExecutionHandlerMethodArgumentResolvers) - Method in class org.springframework.shell.Shell

setBuildProperties(BuildProperties) - Method in class org.springframework.shell.standard.commands.Version

setCommandsFromInputArgs(Function<ApplicationArguments, List<String>>) - Method in class org.springframework.shell.jline.NonInteractiveShellRunner

Sets the function that creates the command() to run from the input application arguments.

setCommandsTemplate(String) - Method in class org.springframework.shell.standard.commands.Help

Sets a location for a template rendering commands help.

setCommandTemplate(String) - Method in class org.springframework.shell.standard.commands.Help

Sets a location for a template rendering command help.

setCompletionResolvers(List<CompletionResolver>) - Method in class org.springframework.shell.Shell

setConversionService(ConversionService) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

Sets a conversion service

setConversionService(ConversionService) - Method in class org.springframework.shell.Shell

setCursorRow(Integer) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext

setCursorRow(Integer) - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext

Sets a cursor row.

setDefaultExpose(I) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent

Sets default expose item when component start.

setDefaultValue(Boolean) - Method in interface org.springframework.shell.component.ConfirmationInput.ConfirmationInputContext

Sets a default value.

setDefaultValue(String) - Method in interface org.springframework.shell.component.StringInput.StringInputContext

Sets a default value.

setEofOnEscapedNewLine(boolean) - Method in class org.springframework.shell.jline.ExtendedDefaultParser

setEofOnUnclosedQuote(boolean) - Method in class org.springframework.shell.jline.ExtendedDefaultParser

setEscapeChars(char[]) - Method in class org.springframework.shell.jline.ExtendedDefaultParser

setGitProperties(GitProperties) - Method in class org.springframework.shell.standard.commands.Version

setInput(String) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext

setInput(String) - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext

Sets an input.

setInput(String) - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext

setInput(String) - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext

Sets an input.

setInteractionMode(InteractionMode) - Method in class org.springframework.shell.context.DefaultShellContext

setInteractionMode(InteractionMode) - Method in interface org.springframework.shell.context.ShellContext

Sets an interaction mode.

setItemMapper(Function<T, String>) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent

Sets an item mapper.

setItems(List<I>) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext

setItems(List<I>) - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext

Sets an items.

setItemStates(List<AbstractSelectorComponent.ItemState<I>>) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext

setItemStates(List<AbstractSelectorComponent.ItemState<I>>) - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext

Sets an item states.

setItemStateView(List<AbstractSelectorComponent.ItemState<I>>) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext

setItemStateView(List<AbstractSelectorComponent.ItemState<I>>) - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext

Sets an item state view

setLineParser(Parser) - Method in class org.springframework.shell.jline.NonInteractiveShellRunner

Sets the line parser used to parse commands.

setMaskCharacter(Character) - Method in class org.springframework.shell.component.StringInput

Sets a mask character for input and result value.

setMaskCharacter(Character) - Method in interface org.springframework.shell.component.StringInput.StringInputContext

Sets a mask character.

setMaxItems(int) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent

Set max items to show.

setMessage(String) - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext

setMessage(String, AbstractTextComponent.TextComponentContext.MessageLevel) - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext

setMessage(String) - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext

Sets a message.

setMessage(String, AbstractTextComponent.TextComponentContext.MessageLevel) - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext

Sets a message with level.

setMessageLevel(AbstractTextComponent.TextComponentContext.MessageLevel) - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext

setMessageLevel(AbstractTextComponent.TextComponentContext.MessageLevel) - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext

Sets a AbstractTextComponent.TextComponentContext.MessageLevel.

setMessageMethodArgumentResolvers(ShellMethodArgumentResolverComposite) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

Set HandlerMethodArgumentResolvers to use to use for resolving method argument values.

setName(String) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext

setName(String) - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext

Sets a name

setName(String) - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext

setName(String) - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext

Sets a name.

setOrder(int) - Method in class org.springframework.shell.component.flow.BaseInput

setParameterNameDiscoverer(ParameterNameDiscoverer) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

Set the ParameterNameDiscoverer for resolving parameter names when needed (e.g.

setPathProvider(Function<String, Path>) - Method in class org.springframework.shell.component.PathInput

Sets a path provider.

setPrintResults(boolean) - Method in class org.springframework.shell.component.support.AbstractComponent

Sets if results should be printed into a console, Defaults to true.

setQuoteChars(char[]) - Method in class org.springframework.shell.jline.ExtendedDefaultParser

setRenderer(Function<T, List<AttributedString>>) - Method in class org.springframework.shell.component.support.AbstractComponent

Sets a display renderer.

setResourceLoader(ResourceLoader) - Method in class org.springframework.shell.component.support.AbstractComponent

setResourceLoader(ResourceLoader) - Method in class org.springframework.shell.standard.AbstractShellComponent

setResourceLoader(ResourceLoader) - Method in class org.springframework.shell.standard.commands.Completion

setResultItems(List<I>) - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext

setResultItems(List<I>) - Method in interface org.springframework.shell.component.support.AbstractSelectorComponent.SelectorComponentContext

Sets a result items.

setResultValue(T) - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext

setResultValue(T) - Method in interface org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext

Sets a result value.

setShowBuildArtifact(boolean) - Method in class org.springframework.shell.standard.commands.Version

setShowBuildGroup(boolean) - Method in class org.springframework.shell.standard.commands.Version

setShowBuildName(boolean) - Method in class org.springframework.shell.standard.commands.Version

setShowBuildTime(boolean) - Method in class org.springframework.shell.standard.commands.Version

setShowBuildVersion(boolean) - Method in class org.springframework.shell.standard.commands.Version

setShowGitBranch(boolean) - Method in class org.springframework.shell.standard.commands.Version

setShowGitCommitId(boolean) - Method in class org.springframework.shell.standard.commands.Version

setShowGitCommitTime(boolean) - Method in class org.springframework.shell.standard.commands.Version

setShowGitShortCommitId(boolean) - Method in class org.springframework.shell.standard.commands.Version

setShowGroups(boolean) - Method in class org.springframework.shell.standard.commands.Help

Sets if groups should be shown in a listing, defaults to true.

setTemplate(String) - Method in class org.springframework.shell.standard.commands.Version

setTemplateExecutor(TemplateExecutor) - Method in class org.springframework.shell.component.support.AbstractComponent

Sets a template executor.

setTemplateLocation(String) - Method in class org.springframework.shell.component.support.AbstractComponent

Sets a template location.

setValidator(Validator) - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

setValidatorFactory(ValidatorFactory) - Method in class org.springframework.shell.Shell

Shell - Class in org.springframework.shell

Main class implementing a shell loop.

Shell(ResultHandlerService, CommandCatalog, Terminal, ShellContext, ExitCodeMappings) - Constructor for class org.springframework.shell.Shell

ShellApplicationRunner - Interface in org.springframework.shell

Marker interface for a main spring shell ApplicationRunner.

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.

ShellContext - Interface in org.springframework.shell.context

Interface defining a contract for a context which allows to loosely connect different components together and keep things alive between commands.

ShellConversionServiceSupplier - Interface in org.springframework.shell.config

Interface to provide shell spesific ConversionService.

ShellMethod - Annotation Type in org.springframework.shell.standard

Used to mark a method as invokable via Spring Shell.

ShellMethodArgumentResolverComposite - Class in org.springframework.shell.command.invocation

Resolves method parameters by delegating to a list of registered HandlerMethodArgumentResolvers.

ShellMethodArgumentResolverComposite() - Constructor for class org.springframework.shell.command.invocation.ShellMethodArgumentResolverComposite

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

Used to customize handling of a ShellMethod parameter.

ShellOption.NoValueProvider - Interface in org.springframework.shell.standard

ShellOptionMethodArgumentResolver - Class in org.springframework.shell.standard

Resolver for @ShellOption arguments.

ShellOptionMethodArgumentResolver(ConversionService, ConfigurableBeanFactory) - Constructor for class org.springframework.shell.standard.ShellOptionMethodArgumentResolver

ShellRunner - Interface in org.springframework.shell

Interface for shell runners.

shortNames(Character...) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

shortNames(Character...) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec

Define short option names.

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.

SingleItemSelector<T,I extends Nameable & Matchable & Enableable & Selectable & Itemable<T>> - Class in org.springframework.shell.component

Component able to pick single item.

SingleItemSelector(Terminal, List<I>, String, Comparator<I>) - Constructor for class org.springframework.shell.component.SingleItemSelector

SingleItemSelector.SingleItemSelectorContext<T,I extends Nameable & Matchable & Itemable<T>> - Interface in org.springframework.shell.component

Context SingleItemSelector.

SingleItemSelectorSpec - Interface in org.springframework.shell.component.flow

Interface for single item selector spec builder.

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.

sort(Comparator<SelectorItem<String>>) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

sort(Comparator<SelectorItem<String>>) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

sort(Comparator<SelectorItem<String>>) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec

Sets a Comparator for sorting items.

sort(Comparator<SelectorItem<String>>) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec

Sets a Comparator for sorting items.

split(T[], Predicate<T>) - Static method in class org.springframework.shell.Utils

Split array into list of lists by predicate

Stacktrace - Class in org.springframework.shell.standard.commands

A command to display the full stacktrace when an error occurs.

Stacktrace(ObjectProvider<ThrowableResultHandler>) - Constructor for class org.springframework.shell.standard.commands.Stacktrace

stacktrace() - Method in class org.springframework.shell.standard.commands.Stacktrace

Stacktrace.Command - Interface in org.springframework.shell.standard.commands

Marker interface for beans providing stacktrace functionality to the shell.

StandardMethodTargetRegistrar - Class in org.springframework.shell.standard

The standard implementation of MethodTargetRegistrar for new shell applications, resolves methods annotated with ShellMethod on ShellComponent beans.

StandardMethodTargetRegistrar() - Constructor for class org.springframework.shell.standard.StandardMethodTargetRegistrar

status() - Method in exception org.springframework.shell.ExitRequest

The exit code to be returned when the process exits.

storeResult(boolean) - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

storeResult(boolean) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

storeResult(boolean) - Method in class org.springframework.shell.component.flow.BasePathInput

storeResult(boolean) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

storeResult(boolean) - Method in class org.springframework.shell.component.flow.BaseStringInput

storeResult(boolean) - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec

Automatically stores result from a ConfirmationInput.ConfirmationInputContext into ComponentContext with key given to builder.

storeResult(boolean) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec

Automatically stores result from a MultiItemSelector.MultiItemSelectorContext into ComponentContext with key given to builder.

storeResult(boolean) - Method in interface org.springframework.shell.component.flow.PathInputSpec

Automatically stores result from a StringInput.StringInputContext into ComponentContext with key given to builder.

storeResult(boolean) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec

Automatically stores result from a SingleItemSelector.SingleItemSelectorContext into ComponentContext with key given to builder.

storeResult(boolean) - Method in interface org.springframework.shell.component.flow.StringInputSpec

Automatically stores result from a StringInput.StringInputContext into ComponentContext with key given to builder.

stream() - Method in class org.springframework.shell.component.context.BaseComponentContext

stream() - Method in interface org.springframework.shell.component.context.ComponentContext

Stream key/value pairs from this ComponentContext

StringInput - Class in org.springframework.shell.component

Component for a simple string input.

StringInput(Terminal) - Constructor for class org.springframework.shell.component.StringInput

StringInput(Terminal, String, String) - Constructor for class org.springframework.shell.component.StringInput

StringInput(Terminal, String, String, Function<StringInput.StringInputContext, List<AttributedString>>) - Constructor for class org.springframework.shell.component.StringInput

StringInput.StringInputContext - Interface in org.springframework.shell.component

StringInputSpec - Interface in org.springframework.shell.component.flow

Interface for string input spec builder.

StringToStyleExpressionRenderer - Class in org.springframework.shell.style

ST AttributeRenderer which knows to use format string to render strings into jline StyleExpression based on theming settings.

StringToStyleExpressionRenderer(ThemeResolver) - Constructor for class org.springframework.shell.style.StringToStyleExpressionRenderer

styles() - Method in class org.springframework.shell.style.ThemeSettings

Gets a StyleSettings.

StyleSettings - Class in org.springframework.shell.style

Base class defining a settings for styles.

StyleSettings() - Constructor for class org.springframework.shell.style.StyleSettings

supportsParameter(MethodParameter) - Method in class org.springframework.shell.command.ArgumentHeaderMethodArgumentResolver

supportsParameter(MethodParameter) - Method in class org.springframework.shell.command.CommandContextMethodArgumentResolver

supportsParameter(MethodParameter) - Method in class org.springframework.shell.command.CommandExecution.ParamNameHandlerMethodArgumentResolver

supportsParameter(MethodParameter) - Method in class org.springframework.shell.command.invocation.ShellMethodArgumentResolverComposite

Whether the given method parameter is supported by any registered HandlerMethodArgumentResolver.

supportsParameter(MethodParameter) - Method in class org.springframework.shell.standard.ShellOptionMethodArgumentResolver

T

table() - Static method in class org.springframework.shell.table.CellMatchers

Table - Class in org.springframework.shell.table

This is the central API for table rendering.

TableBuilder - Class in org.springframework.shell.table

A builder class to incrementally configure a Table.

TableBuilder(TableModel) - Constructor for class org.springframework.shell.table.TableBuilder

Construct a table with the given model.

TableBuilder.BorderStub - Class in org.springframework.shell.table

TableBuilder.BorderStub.TopLeft - Class in org.springframework.shell.table

TableBuilder.CellMatcherStub - Class in org.springframework.shell.table

TableModel - Class in org.springframework.shell.table

Abstracts away the contract a Table will use to retrieve tabular data.

TableModel() - Constructor for class org.springframework.shell.table.TableModel

TableModelBuilder<T> - Class in org.springframework.shell.table

Helper class to build a TableModel incrementally.

TableModelBuilder() - Constructor for class org.springframework.shell.table.TableModelBuilder

Tables - Class in org.springframework.shell.table

Utility class used to create and configure typical Tables.

Tables() - Constructor for class org.springframework.shell.table.Tables

TAG_CHECKBOX_OFF - Static variable in class org.springframework.shell.style.FigureSettings

Figure used as a checkbox for off position.

TAG_CHECKBOX_ON - Static variable in class org.springframework.shell.style.FigureSettings

Figure used as a checkbox for on position.

TAG_DOWNWARDS_ARROR - Static variable in class org.springframework.shell.style.FigureSettings

Figure for down arrow.

TAG_ERROR - Static variable in class org.springframework.shell.style.FigureSettings

Figure indicating something about on a level of error.

TAG_HIGHLIGHT - Static variable in class org.springframework.shell.style.StyleSettings

Styling for something which is highlighted.

TAG_INFO - Static variable in class org.springframework.shell.style.FigureSettings

Figure indicating something about on a level of info.

TAG_ITEM_DISABLED - Static variable in class org.springframework.shell.style.StyleSettings

Styling for something i.e.

TAG_ITEM_ENABLED - Static variable in class org.springframework.shell.style.StyleSettings

Styling for something i.e.

TAG_ITEM_SELECTED - Static variable in class org.springframework.shell.style.StyleSettings

Styling for something i.e.

TAG_ITEM_SELECTOR - Static variable in class org.springframework.shell.style.StyleSettings

Styling for selector i.e.

TAG_ITEM_UNSELECTED - Static variable in class org.springframework.shell.style.StyleSettings

Styling for something i.e.

TAG_LEFT_POINTING_QUOTATION - Static variable in class org.springframework.shell.style.FigureSettings

Figure used as indicator pointing left.

TAG_LEFTWARDS_ARROR - Static variable in class org.springframework.shell.style.FigureSettings

Figure for left arrow.

TAG_LEVEL_ERROR - Static variable in class org.springframework.shell.style.StyleSettings

Styling for some arbitrary content indicating ERROR level.

TAG_LEVEL_INFO - Static variable in class org.springframework.shell.style.StyleSettings

Styling for some arbitrary content indicating INFO level.

TAG_LEVEL_WARN - Static variable in class org.springframework.shell.style.StyleSettings

Styling for some arbitrary content indicating WARN level.

TAG_LIST_KEY - Static variable in class org.springframework.shell.style.StyleSettings

Styling for keys or names in a lists: : list value1 : list value2

TAG_LIST_VALUE - Static variable in class org.springframework.shell.style.StyleSettings

Styling for keys or names in a lists: list key1 : list key2 :

TAG_QUESTION_MARK - Static variable in class org.springframework.shell.style.FigureSettings

Figure meant for question.

TAG_RIGHT_POINTING_QUOTATION - Static variable in class org.springframework.shell.style.FigureSettings

Figure used as indicator pointing left.

TAG_RIGHTWARDS_ARROR - Static variable in class org.springframework.shell.style.FigureSettings

Figure for right arrow.

TAG_TICK - Static variable in class org.springframework.shell.style.FigureSettings

Figure meant to be used as ok like a checkmark.

TAG_TITLE - Static variable in class org.springframework.shell.style.StyleSettings

Represents some arbitrary title.

TAG_UPWARDS_ARROR - Static variable in class org.springframework.shell.style.FigureSettings

Figure for up arrow.

TAG_VALUE - Static variable in class org.springframework.shell.style.StyleSettings

Represents some arbitrary value.

TAG_WARNING - Static variable in class org.springframework.shell.style.FigureSettings

Figure indicating something about on a level of warning.

tags() - Static method in class org.springframework.shell.style.FigureSettings

tags() - Static method in class org.springframework.shell.style.StyleSettings

Gets all tags.

template(String) - Method in class org.springframework.shell.component.flow.BaseConfirmationInput

template(String) - Method in class org.springframework.shell.component.flow.BaseMultiItemSelector

template(String) - Method in class org.springframework.shell.component.flow.BasePathInput

template(String) - Method in class org.springframework.shell.component.flow.BaseSingleItemSelector

template(String) - Method in class org.springframework.shell.component.flow.BaseStringInput

template(String) - Method in interface org.springframework.shell.component.flow.ConfirmationInputSpec

Sets a default renderer template location.

template(String) - Method in interface org.springframework.shell.component.flow.MultiItemSelectorSpec

Sets a default renderer template location.

template(String) - Method in interface org.springframework.shell.component.flow.PathInputSpec

Sets a default renderer template location.

template(String) - Method in interface org.springframework.shell.component.flow.SingleItemSelectorSpec

Sets a default renderer template location.

template(String) - Method in interface org.springframework.shell.component.flow.StringInputSpec

Sets a default renderer template location.

templateExecutor(TemplateExecutor) - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder

templateExecutor(TemplateExecutor) - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder

Sets a TemplateExecutor.

TemplateExecutor - Class in org.springframework.shell.style

Template executor which knows to use styling.

TemplateExecutor(ThemeResolver) - Constructor for class org.springframework.shell.style.TemplateExecutor

terminal(Terminal) - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder

terminal(Terminal) - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder

Sets a Terminal.

terminal - Variable in class org.springframework.shell.result.TerminalAwareResultHandler

TerminalAwareResultHandler<T> - Class in org.springframework.shell.result

Base class for ResultHandlers that rely on JLine's Terminal.

TerminalAwareResultHandler(Terminal) - Constructor for class org.springframework.shell.result.TerminalAwareResultHandler

TerminalSizeAware - Interface in org.springframework.shell

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

terminalSizeAwareResultHandler(Terminal) - Method in class org.springframework.shell.result.ResultHandlerConfig

TerminalSizeAwareResultHandler - Class in org.springframework.shell.result

A ResultHandler that prints TerminalSizeAware according to the Terminal size.

TerminalSizeAwareResultHandler(Terminal) - Constructor for class org.springframework.shell.result.TerminalSizeAwareResultHandler

TextWrapper - Interface in org.springframework.shell.table

A strategy for applying text wrapping/cropping given a cell width.

Theme - Interface in org.springframework.shell.style

Contract representing a theme with its name and settings.

ThemeActive - Interface in org.springframework.shell.style

ThemeRegistry - Class in org.springframework.shell.style

Registry which stores Theme's with its name.

ThemeRegistry() - Constructor for class org.springframework.shell.style.ThemeRegistry

ThemeResolver - Class in org.springframework.shell.style

Service which helps to do various things with styles.

ThemeResolver(ThemeRegistry, String) - Constructor for class org.springframework.shell.style.ThemeResolver

ThemeSettings - Class in org.springframework.shell.style

Base class defining a settings for themes.

ThemeSettings() - Constructor for class org.springframework.shell.style.ThemeSettings

Creates theme settings with dump styles and figures.

ThemeSettings(StyleSettings, FigureSettings) - Constructor for class org.springframework.shell.style.ThemeSettings

Creates theme settings with styles and figures.

throwableResultHandler(Terminal, CommandCatalog, ShellContext, ObjectProvider<InteractiveShellRunner>) - Method in class org.springframework.shell.result.ResultHandlerConfig

ThrowableResultHandler - Class in org.springframework.shell.result

A ResultHandler that prints thrown exceptions messages in red.

ThrowableResultHandler(Terminal, CommandCatalog, ShellContext, ObjectProvider<InteractiveShellRunner>) - Constructor for class org.springframework.shell.result.ThrowableResultHandler

tick() - Method in class org.springframework.shell.style.FigureSettings

title() - Method in class org.springframework.shell.style.StyleSettings

toBottomRight() - Method in class org.springframework.shell.table.TableBuilder.BorderStub.TopLeft

TooManyArgumentsOptionException(String, CommandOption) - Constructor for exception org.springframework.shell.command.CommandParser.TooManyArgumentsOptionException

TOP - Static variable in class org.springframework.shell.table.BorderSpecification

toRowColumn(int, int) - Method in class org.springframework.shell.table.TableBuilder.BorderStub.TopLeft

toString() - Method in class org.springframework.shell.command.invocation.InvocableShellMethod

toString() - Method in class org.springframework.shell.CompletionProposal

toString() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext

toString(String, String, Locale) - Method in class org.springframework.shell.style.StringToStyleExpressionRenderer

toString() - Method in class org.springframework.shell.table.BorderSpecification

toTemplateModel() - Method in class org.springframework.shell.component.context.BaseComponentContext

toTemplateModel() - Method in interface org.springframework.shell.component.context.ComponentContext

Gets context values as a map.

toTemplateModel() - Method in class org.springframework.shell.component.support.AbstractSelectorComponent.BaseSelectorComponentContext

toTemplateModel() - Method in class org.springframework.shell.component.support.AbstractTextComponent.BaseTextComponentContext

transpose() - Method in class org.springframework.shell.table.TableModel

type(Type) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

type(ResolvableType) - Method in class org.springframework.shell.command.CommandRegistration.DefaultOptionSpec

type(Type) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec

Define a type for an option.

type(ResolvableType) - Method in interface org.springframework.shell.command.CommandRegistration.OptionSpec

Define a ResolvableType for an option.

U

unavailable(String) - Static method in class org.springframework.shell.Availability

unCamelify(CharSequence) - Static method in class org.springframework.shell.Utils

Turn CamelCaseText into gnu-style-lowercase.

UnrecognisedOptionException(String, String) - Constructor for exception org.springframework.shell.command.CommandParser.UnrecognisedOptionException

unregister(CommandRegistration...) - Method in class org.springframework.shell.command.CommandCatalog.DefaultCommandCatalog

unregister(String...) - Method in class org.springframework.shell.command.CommandCatalog.DefaultCommandCatalog

unregister(CommandRegistration...) - Method in interface org.springframework.shell.command.CommandCatalog

Unregister a CommandRegistration.

unregister(String...) - Method in interface org.springframework.shell.command.CommandCatalog

Unregister a CommandRegistration by its command name.

UNRESOLVED - Static variable in class org.springframework.shell.Shell

Marker object to distinguish unresolved arguments from null, which is a valid value.

upToCursor() - Method in class org.springframework.shell.CompletionContext

upwardsArrow() - Method in class org.springframework.shell.style.FigureSettings

UserConfigPathProvider - Interface in org.springframework.shell.config

Interface providing a Path to a location where user level runtime configuration files are strored.

Utils - Class in org.springframework.shell

Some text utilities.

Utils() - Constructor for class org.springframework.shell.Utils

V

value() - Method in interface org.springframework.shell.command.CommandParser.CommandParserResult

Gets the value.

value() - Method in class org.springframework.shell.command.CommandParser.DefaultCommandParserResult

value() - Method in class org.springframework.shell.CompletionProposal

value(String) - Method in class org.springframework.shell.CompletionProposal

value() - Method in class org.springframework.shell.style.StyleSettings

valueOf(String) - Static method in enum org.springframework.shell.command.CommandRegistration.OptionArity

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.springframework.shell.command.CommandRegistration.TargetInfo.TargetType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.springframework.shell.component.flow.ResultMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext.MessageLevel

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.springframework.shell.context.InteractionMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.springframework.shell.table.BorderStyle

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.springframework.shell.table.SimpleHorizontalAligner

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.springframework.shell.table.SimpleVerticalAligner

Returns the enum constant of this type with the specified name.

ValueProvider - Interface in org.springframework.shell.standard

Beans implementing this interface are queried during TAB completion to gather possible values of a parameter.

ValueResult - Class in org.springframework.shell

A result for a successful resolve operation.

ValueResult(MethodParameter, Object) - Constructor for class org.springframework.shell.ValueResult

ValueResult(MethodParameter, Object, BitSet, BitSet) - Constructor for class org.springframework.shell.ValueResult

values() - Static method in enum org.springframework.shell.command.CommandRegistration.OptionArity

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.springframework.shell.command.CommandRegistration.TargetInfo.TargetType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.springframework.shell.component.flow.ResultMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.springframework.shell.component.support.AbstractTextComponent.TextComponentContext.MessageLevel

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.springframework.shell.context.InteractionMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.springframework.shell.table.BorderStyle

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.springframework.shell.table.SimpleHorizontalAligner

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.springframework.shell.table.SimpleVerticalAligner

Returns an array containing the constants of this enum type, in the order they are declared.

Version - Class in org.springframework.shell.standard.commands

Command to list version and other build related infos.

Version(TemplateExecutor) - Constructor for class org.springframework.shell.standard.commands.Version

version() - Method in class org.springframework.shell.standard.commands.Version

Version.Command - Interface in org.springframework.shell.standard.commands

Marker interface used in auto-config.

verticalGlyph() - Method in enum org.springframework.shell.table.BorderStyle

W

warning() - Method in class org.springframework.shell.style.FigureSettings

width(String[], int, int) - Method in class org.springframework.shell.table.AbsoluteWidthSizeConstraints

width(String[], int, int) - Method in class org.springframework.shell.table.AutoSizeConstraints

width(String[], int, int) - Method in class org.springframework.shell.table.KeyValueSizeConstraints

width(String[], int, int) - Method in class org.springframework.shell.table.NoWrapSizeConstraints

width(String[], int, int) - Method in interface org.springframework.shell.table.SizeConstraints

withAlias() - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder

withAlias() - Method in interface org.springframework.shell.command.CommandRegistration.Builder

Define an alias what this command should execute

withConfirmationInput(String) - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder

withConfirmationInput(String) - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder

Gets a builder for confirmation input.

withExitCode() - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder

withExitCode() - Method in interface org.springframework.shell.command.CommandRegistration.Builder

Define an exit code what this command should execute

withMultiItemSelector(String) - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder

withMultiItemSelector(String) - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder

Gets a builder for multi item selector.

withOption() - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder

withOption() - Method in interface org.springframework.shell.command.CommandRegistration.Builder

Define an option what this command should user for.

withPathInput(String) - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder

withPathInput(String) - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder

Gets a builder for path input.

withSingleItemSelector(String) - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder

withSingleItemSelector(String) - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder

Gets a builder for single item selector.

withStringInput(String) - Method in class org.springframework.shell.component.flow.ComponentFlow.BaseBuilder

withStringInput(String) - Method in interface org.springframework.shell.component.flow.ComponentFlow.Builder

Gets a builder for string input.

withTarget() - Method in class org.springframework.shell.command.CommandRegistration.BaseBuilder

withTarget() - Method in interface org.springframework.shell.command.CommandRegistration.Builder

Define a target what this command should execute

word() - Method in class org.springframework.shell.jline.ExtendedDefaultParser.ExtendedArgumentList

wordCursor() - Method in class org.springframework.shell.jline.ExtendedDefaultParser.ExtendedArgumentList

wordIndex() - Method in class org.springframework.shell.jline.ExtendedDefaultParser.ExtendedArgumentList

words() - Method in interface org.springframework.shell.Input

Return the input as a list of parsed "words", having split the raw input according to parsing rules (for example, handling quoted portions of the readInput as a single "word")

words() - Method in class org.springframework.shell.jline.ExtendedDefaultParser.ExtendedArgumentList

wordsUsed() - Method in class org.springframework.shell.ValueResult

Represents the full set of words used to resolve the MethodParameter.

wordsUsed(List<String>) - Method in class org.springframework.shell.ValueResult

wordsUsedForValue() - Method in class org.springframework.shell.ValueResult

Represents the full set of words used to resolve the value of this MethodParameter.

wordsUsedForValue(List<String>) - Method in class org.springframework.shell.ValueResult

wrap(String[], int) - Method in class org.springframework.shell.table.DebugTextWrapper

wrap(String[], int) - Method in class org.springframework.shell.table.DelimiterTextWrapper

wrap(String[], int) - Method in class org.springframework.shell.table.KeyValueTextWrapper

wrap(String[], int) - Method in interface org.springframework.shell.table.TextWrapper

A B C D E F G H I J K L M N O P Q R S T U V W