Index (Spring Shell 1.2.0.RELEASE API)

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
AbstractShell - Class in org.springframework.shell.core: Provides a base Shell implementation.
AbstractShell() - Constructor for class org.springframework.shell.core.AbstractShell
AbstractShellStatusPublisher - Class in org.springframework.shell.event: Provides a convenience superclass for those shells wishing to publish status messages.
AbstractShellStatusPublisher() - Constructor for class org.springframework.shell.event.AbstractShellStatusPublisher
add(Class<?>) - Method in interface org.springframework.shell.converters.StaticFieldConverter
add(Class<?>) - Method in class org.springframework.shell.converters.StaticFieldConverterImpl
add(CommandMarker) - Method in class org.springframework.shell.core.SimpleParser
add(Converter<?>) - Method in class org.springframework.shell.core.SimpleParser
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.
addHeader(Integer, TableHeader) - Method in class org.springframework.shell.support.table.Table: Deprecated.
addHeaderAndVerticalsBorders(BorderStyle) - Method in class org.springframework.shell.table.TableBuilder: Set a border on the outline of the whole table, around the first row and draw vertical lines around each column.
addHeaderBorder(BorderStyle) - Method in class org.springframework.shell.table.TableBuilder: Set a border on the outline of the whole table, as well as around the first row.
addInnerBorder(BorderStyle) - Method in class org.springframework.shell.table.TableBuilder: Set a border on the inner verticals and horizontals of the table, but not on the outline.
addOutlineBorder(BorderStyle) - Method in class org.springframework.shell.table.TableBuilder: Set a border on the outline of the whole table.
addRow(String...) - Method in class org.springframework.shell.support.table.Table: Deprecated.
addRow() - Method in class org.springframework.shell.table.TableModelBuilder
addShellStatusListener(ShellStatusListener) - Method in class org.springframework.shell.event.AbstractShellStatusPublisher
addShellStatusListener(ShellStatusListener) - Method in interface org.springframework.shell.event.ShellStatusProvider: Registers a new status listener.
addSizer(SizeConstraints) - Method in class org.springframework.shell.table.TableBuilder.CellMatcherStub
addValue(Integer, String) - Method in class org.springframework.shell.support.table.TableRow: Deprecated.

Add a value to the to the specified column within this row.
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.core.JLineShellComponent
afterReturningInvocation(ParseResult, Object) - Method in interface org.springframework.shell.core.ExecutionProcessor: Method called after successfully invoking the target command (described by ParseResult).
afterThrowingInvocation(ParseResult, Throwable) - Method in interface org.springframework.shell.core.ExecutionProcessor: Method called after invoking the target command (described by ParseResult) had thrown an exception .
align(String[], int, int) - Method in interface org.springframework.shell.table.Aligner: Perform text alignment, returning a String array that MUST contain cellHeight lines, each of which MUST be cellWidth chars in length.
align(String[], int, int) - Method in class org.springframework.shell.table.DebugAligner
align(String[], int, int) - Method in class org.springframework.shell.table.KeyValueHorizontalAligner
align(String[], int, int) - Method in enum org.springframework.shell.table.SimpleHorizontalAligner
align(String[], int, int) - Method in enum org.springframework.shell.table.SimpleVerticalAligner
Aligner - Interface in org.springframework.shell.table: A strategy interface for performing text alignment.
and() - Method in class org.springframework.shell.table.TableBuilder.CellMatcherStub
AnsiEscapeCode - Enum in org.springframework.shell.support.util: ANSI escape codes supported by JLine
ArrayConverter - Class in org.springframework.shell.converters: A converter that knows how to use other converters to create arrays of supported types.
ArrayConverter() - Constructor for class org.springframework.shell.converters.ArrayConverter
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
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
AvailableCommandsConverter - Class in org.springframework.shell.converters: Available commands converter.
AvailableCommandsConverter() - Constructor for class org.springframework.shell.converters.AvailableCommandsConverter

B

backOneDirectory(String) - Static method in class org.springframework.shell.support.util.FileUtils: Returns the given file system path minus its last element
BannerProvider - Interface in org.springframework.shell.plugin: Banner provider.
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
beforeInvocation(ParseResult) - Method in interface org.springframework.shell.core.ExecutionProcessor: Method called before invoking the target command (described by ParseResult).
BigDecimalConverter - Class in org.springframework.shell.converters: Converter for BigDecimal.
BigDecimalConverter() - Constructor for class org.springframework.shell.converters.BigDecimalConverter
BigIntegerConverter - Class in org.springframework.shell.converters: Converter for BigInteger.
BigIntegerConverter() - Constructor for class org.springframework.shell.converters.BigIntegerConverter
blockCommentBegin() - Method in class org.springframework.shell.core.AbstractShell
blockCommentFinish() - Method in class org.springframework.shell.core.AbstractShell
BooleanConverter - Class in org.springframework.shell.converters: Converter for Boolean.
BooleanConverter() - Constructor for class org.springframework.shell.converters.BooleanConverter
Bootstrap - Class in org.springframework.shell: Loads a Shell using Spring IoC container.
Bootstrap() - Constructor for class org.springframework.shell.Bootstrap
Bootstrap(String[]) - Constructor for class org.springframework.shell.Bootstrap
Bootstrap(String[], String[]) - Constructor for class org.springframework.shell.Bootstrap
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.table.TableBuilder
build() - Method in class org.springframework.shell.table.TableBuilder.CellMatcherStub
build() - Method in class org.springframework.shell.table.TableModelBuilder

C

calculateColumnWidths() - Method in class org.springframework.shell.support.table.Table: Deprecated.
cancelRedrawProhibition() - Static method in class org.springframework.shell.core.JLineLogHandler
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
CharacterConverter - Class in org.springframework.shell.converters: Converter for Character.
CharacterConverter() - Constructor for class org.springframework.shell.converters.CharacterConverter
clear() - Method in class org.springframework.shell.commands.ConsoleCommands
CliAvailabilityIndicator - Annotation Type in org.springframework.shell.core.annotation: Annotates a method that can indicate whether a particular command is presently available or not.
CliCommand - Annotation Type in org.springframework.shell.core.annotation: Annotates a method that provides a command to the shell.
CliOption - Annotation Type in org.springframework.shell.core.annotation: Annotates the arguments of a command methods, allowing it to declare the argument value as mandatory or optional with a default value.
close() - Method in class org.springframework.shell.core.JLineLogHandler
close() - Method in class org.springframework.shell.support.logging.DeferredLogHandler
close() - Method in class org.springframework.shell.support.logging.LoggingOutputStream
closeQuietly(Closeable...) - Static method in class org.springframework.shell.support.util.IOUtils: Quietly closes each of the given Closeables, i.e. eats any IOExceptions arising.
closeQuietly(ZipFile...) - Static method in class org.springframework.shell.support.util.IOUtils: Quietly closes each of the given ZipFiles, i.e. eats any IOExceptions arising.
closeShell() - Method in class org.springframework.shell.core.JLineShell: Should be called by a subclass before deactivating the shell.
column(int) - Static method in class org.springframework.shell.table.CellMatchers: Return a matcher that applies to every cell of some column of the table.
COLUMN_1 - Static variable in class org.springframework.shell.support.table.TableRenderer: Deprecated.
COLUMN_2 - Static variable in class org.springframework.shell.support.table.TableRenderer: Deprecated.
COLUMN_3 - Static variable in class org.springframework.shell.support.table.TableRenderer: Deprecated.
COLUMN_4 - Static variable in class org.springframework.shell.support.table.TableRenderer: Deprecated.
COLUMN_5 - Static variable in class org.springframework.shell.support.table.TableRenderer: Deprecated.
COLUMN_6 - Static variable in class org.springframework.shell.support.table.TableRenderer: Deprecated.
command(String) - Method in class org.springframework.shell.commands.OsCommands
CommandLine - Class in org.springframework.shell: Encapsulates the list of argument passed to the shell.
CommandLine(String[], int, String[]) - Constructor for class org.springframework.shell.CommandLine: Construct a new CommandLine
CommandLine(String[], int, String[], boolean) - Constructor for class org.springframework.shell.CommandLine: Construct a new CommandLine
CommandMarker - Interface in org.springframework.shell.core: Marker interface indicating a provider of one or more shell commands.
commandNotFound(Logger, String) - Method in class org.springframework.shell.core.SimpleParser
CommandResult - Class in org.springframework.shell.core
CommandResult(boolean) - Constructor for class org.springframework.shell.core.CommandResult
CommandResult(boolean, Object, Throwable) - Constructor for class org.springframework.shell.core.CommandResult
compare(E, E) - Method in class org.springframework.shell.support.util.NaturalOrderComparator
complete(String, int, List<String>) - Method in interface org.springframework.shell.core.Parser: Populates a list of completion candidates.
complete(String, int, List) - Method in class org.springframework.shell.core.ParserCompleter
complete(String, int, List<String>) - Method in class org.springframework.shell.core.SimpleParser
completeAdvanced(String, int, List<Completion>) - Method in interface org.springframework.shell.core.Parser: Populates a list of completion candidates.
completeAdvanced(String, int, List<Completion>) - Method in class org.springframework.shell.core.SimpleParser
Completion - Class in org.springframework.shell.core
Completion(String) - Constructor for class org.springframework.shell.core.Completion: Constructor
Completion(String, String, String, int) - Constructor for class org.springframework.shell.core.Completion: Constructor
completionKeys - Static variable in class org.springframework.shell.core.AbstractShell
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.
ConsoleCommands - Class in org.springframework.shell.commands: Commands related to the manipulation of the jline console.
ConsoleCommands() - Constructor for class org.springframework.shell.commands.ConsoleCommands
Converter<T> - Interface in org.springframework.shell.core: Converts between Strings (as displayed by and entered via the shell) and Java objects
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.ArrayConverter
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.AvailableCommandsConverter
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.BigDecimalConverter
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.BigIntegerConverter
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.BooleanConverter
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.CharacterConverter
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.DateConverter
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.DoubleConverter
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.EnumConverter
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.FileConverter
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.FloatConverter
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.IntegerConverter
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.LocaleConverter
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.LongConverter
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.ShortConverter
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.StaticFieldConverterImpl
convertFromText(String, Class<?>, String) - Method in class org.springframework.shell.converters.StringConverter
convertFromText(String, Class<?>, String) - Method in interface org.springframework.shell.core.Converter: Converts from the given String value to type T
copyRecursively(File, File, boolean) - Static method in class org.springframework.shell.support.util.FileUtils: Copies the specified source directory to the destination.
createAndRegisterBeanDefinition(GenericApplicationContext, Class<?>) - Method in class org.springframework.shell.Bootstrap
createAndRegisterBeanDefinition(GenericApplicationContext, Class<?>, String) - Method in class org.springframework.shell.Bootstrap
createAnsiWindowsReader() - Method in class org.springframework.shell.core.JLineShell
createConsoleReader() - Method in class org.springframework.shell.core.JLineShell: Creates new jline ConsoleReader.
CURRENT_DIRECTORY - Static variable in class org.springframework.shell.support.util.FileUtils: The relative file path to the current directory.
customizePlugin() - Method in class org.springframework.shell.core.JLineShellComponent

D

date() - Method in class org.springframework.shell.commands.DateCommands
DateCommands - Class in org.springframework.shell.commands: Commands related to the dates
DateCommands() - Constructor for class org.springframework.shell.commands.DateCommands
DateConverter - Class in org.springframework.shell.converters: Converter for Date.
DateConverter() - Constructor for class org.springframework.shell.converters.DateConverter
DateConverter(DateFormat) - Constructor for class org.springframework.shell.converters.DateConverter
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
decorate(String, AnsiEscapeCode...) - Static method in enum org.springframework.shell.support.util.AnsiEscapeCode: Decorates the given text with the given escape codes (turning them off afterwards)
DEFAULT_HISTORY_SIZE - Static variable in class org.springframework.shell.SimpleShellCommandLineOptions
DEFAULT_ROW_CAPACITY - Static variable in class org.springframework.shell.table.TableModelBuilder
DefaultBannerProvider - Class in org.springframework.shell.plugin.support: Default Banner provider.
DefaultBannerProvider() - Constructor for class org.springframework.shell.plugin.support.DefaultBannerProvider
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
DefaultHistoryFileNameProvider - Class in org.springframework.shell.plugin.support: Default history file provider.
DefaultHistoryFileNameProvider() - Constructor for class org.springframework.shell.plugin.support.DefaultHistoryFileNameProvider
DefaultPromptProvider - Class in org.springframework.shell.plugin.support: Default prompt provider.
DefaultPromptProvider() - Constructor for class org.springframework.shell.plugin.support.DefaultPromptProvider
DeferredLogHandler - Class in org.springframework.shell.support.logging: Defers the publication of JDK LogRecord instances until a target Handler is registered.
DeferredLogHandler(Handler, Level) - Constructor for class org.springframework.shell.support.logging.DeferredLogHandler: Creates an instance that will publish all recorded LogRecord instances to the specified fallback Handler if an event of the specified Level is received.
deleteRecursively(File) - Static method in class org.springframework.shell.support.util.FileUtils: Deletes the specified File.
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
denotesAbsolutePath(String) - Static method in class org.springframework.shell.support.util.FileUtils: Checks if the provided fileName denotes an absolute path on the file system.
displayFile(String, Class<?>, boolean) - Static method in class org.springframework.shell.support.logging.MessageDisplayUtils: Displays the requested file via the LOGGER API.
displayFile(String, Class<?>) - Static method in class org.springframework.shell.support.logging.MessageDisplayUtils: Same as MessageDisplayUtils.displayFile(String, Class, boolean) except it passes false as the final argument.
DoubleConverter - Class in org.springframework.shell.converters: Converter for Double.
DoubleConverter() - Constructor for class org.springframework.shell.converters.DoubleConverter

E

ensureTrailingSeparator(String) - Static method in class org.springframework.shell.support.util.FileUtils: Ensures that the given path has exactly one trailing File.separator
EnumConverter - Class in org.springframework.shell.converters: Converter for Enum.
EnumConverter() - Constructor for class org.springframework.shell.converters.EnumConverter
equals(Object) - Method in class org.springframework.shell.core.Completion
equals(Object) - Method in class org.springframework.shell.core.MethodTarget
equals(Object) - Method in class org.springframework.shell.event.ParseResult
equals(Object) - Method in class org.springframework.shell.event.ShellStatus
equals(Object) - Method in class org.springframework.shell.support.table.Table: Deprecated.
equals(Object) - Method in class org.springframework.shell.support.table.TableHeader: Deprecated.
equals(Object) - Method in class org.springframework.shell.support.table.TableRow: Deprecated.
escape(String) - Method in class org.springframework.shell.core.Tokenizer: Apply delimiter escaping to the given string, using the actual delimiter that was used for the last value.
exceptionLogger - Variable in class org.springframework.shell.core.AbstractShell
ExceptionUtils - Class in org.springframework.shell.support.util: Methods for working with exceptions.
ExceptionUtils() - Constructor for class org.springframework.shell.support.util.ExceptionUtils
execute(ParseResult) - Method in interface org.springframework.shell.core.ExecutionStrategy: Executes the method indicated by the ParseResult.
execute(ParseResult) - Method in class org.springframework.shell.core.SimpleExecutionStrategy
executeCommand(String) - Method in interface org.springframework.shell.commands.OsOperations: Attempts the execution of a commands and delegates the output to the standard logger.
executeCommand(String) - Method in class org.springframework.shell.commands.OsOperationsImpl
executeCommand(String) - Method in class org.springframework.shell.core.AbstractShell
executeCommand(String) - Method in interface org.springframework.shell.core.Shell: Runs the specified command.
executeScriptLine(String) - Method in class org.springframework.shell.core.AbstractShell: Execute the single line from a script.
ExecutionProcessor - Interface in org.springframework.shell.core: Extension interface allowing command provider to be called in a generic fashion just before, and right after, executing a command.
ExecutionStrategy - Interface in org.springframework.shell.core: Strategy interface to permit the controlled execution of methods.
ExitCommands - Class in org.springframework.shell.commands: Commands related to exiting the shell
ExitCommands() - Constructor for class org.springframework.shell.commands.ExitCommands
exitShellRequest - Variable in class org.springframework.shell.core.AbstractShell
ExitShellRequest - Class in org.springframework.shell.core: An immutable representation of a request to exit the shell.
extractRootCause(Throwable) - Static method in class org.springframework.shell.support.util.ExceptionUtils: Obtains the root cause of an exception, if available.

F

FATAL_EXIT - Static variable in class org.springframework.shell.core.ExitShellRequest
FileConverter - Class in org.springframework.shell.converters: Converter for File.
FileConverter() - Constructor for class org.springframework.shell.converters.FileConverter
FileUtils - Class in org.springframework.shell.support.util: Utilities for handling File instances.
findResources(String) - Method in class org.springframework.shell.commands.ScriptCommands
flash(Level, String, String) - Method in class org.springframework.shell.core.AbstractShell: Simple implementation of AbstractShell.flash(Level, String, String) that simply displays the message via the logger.
flash(Level, String, String) - Method in class org.springframework.shell.core.JLineShell
flash(Level, String, String) - Method in interface org.springframework.shell.core.Shell: Displays a progress notification to the user.
FloatConverter - Class in org.springframework.shell.converters: Converter for Float.
FloatConverter() - Constructor for class org.springframework.shell.converters.FloatConverter
flush() - Method in class org.springframework.shell.core.JLineLogHandler
flush() - Method in class org.springframework.shell.support.logging.DeferredLogHandler
flush() - Method in class org.springframework.shell.support.logging.LoggingOutputStream
flushAllHandlers(Logger) - Static method in class org.springframework.shell.support.logging.HandlerUtils: Forces all Handler instances registered in the presented Logger to be flushed.
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
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

G

generatePromptUpdate(String) - Method in class org.springframework.shell.core.JLineShell: Retrieves the latest prompt and if the latest prompt is different than the existing prompt, the shellPrompt is updated.
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.ArrayConverter
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.AvailableCommandsConverter
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.BigDecimalConverter
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.BigIntegerConverter
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.BooleanConverter
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.CharacterConverter
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.DateConverter
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.DoubleConverter
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.EnumConverter
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.FileConverter
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.FloatConverter
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.IntegerConverter
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.LocaleConverter
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.LongConverter
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.ShortConverter
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.StaticFieldConverterImpl
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in class org.springframework.shell.converters.StringConverter
getAllPossibleValues(List<Completion>, Class<?>, String, String, MethodTarget) - Method in interface org.springframework.shell.core.Converter: Populates the given list with the possible completions
getApplicationContext() - Method in class org.springframework.shell.Bootstrap
getArgs() - Method in class org.springframework.shell.CommandLine: Return the command line arguments
getArguments() - Method in class org.springframework.shell.event.ParseResult
getBanner() - Method in interface org.springframework.shell.plugin.BannerProvider: Returns the banner.
getBanner() - Method in class org.springframework.shell.plugin.support.DefaultBannerProvider
getBuffer() - Method in exception org.springframework.shell.core.TokenizingException
getCanonicalPath(File) - Static method in class org.springframework.shell.support.util.FileUtils: Returns the canonical path of the given File.
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: Return the number of columns that can be queried.
getCommandMarkers() - Method in class org.springframework.shell.core.SimpleParser
getConverters() - Method in class org.springframework.shell.core.SimpleParser
getDisableInternalCommands() - Method in class org.springframework.shell.CommandLine
getEveryCommand() - Method in class org.springframework.shell.core.SimpleParser
getException() - Method in class org.springframework.shell.core.CommandResult
getExecutionStrategy() - Method in class org.springframework.shell.core.AbstractShell
getExecutionStrategy() - Method in class org.springframework.shell.core.JLineShellComponent
getExitCode() - Method in class org.springframework.shell.core.ExitShellRequest
getExitShellRequest() - Method in class org.springframework.shell.core.AbstractShell
getExitShellRequest() - Method in interface org.springframework.shell.core.Shell
getFile(Class<?>, String) - Static method in class org.springframework.shell.support.util.FileUtils: Loads the given file from the classpath.
getFileSeparatorAsRegex() - Static method in class org.springframework.shell.support.util.FileUtils: Returns the platform-specific file separator as a regular expression.
getFirstDirectory(String) - Static method in class org.springframework.shell.support.util.FileUtils: Returns the part of the given path that represents a directory, in other words the given path if it's already a directory, or the parent directory if it's a file.
getFormattedValue() - Method in class org.springframework.shell.core.Completion
getHeaderBorder(Map<Integer, TableHeader>) - Static method in class org.springframework.shell.support.table.TableRenderer: Deprecated.

Renders the Table header border, based on the map of provided headers.
getHeaders() - Method in class org.springframework.shell.support.table.Table: Deprecated.
getHeading() - Method in class org.springframework.shell.core.Completion
getHighestPriorityProvider(ApplicationContext, Class<T>) - Static method in class org.springframework.shell.plugin.PluginUtils: Returns the highest priority PluginProvider of specified type defined in given application context.
getHistoryFileName() - Method in class org.springframework.shell.core.JLineShell: get history file name from provider.
getHistoryFileName() - Method in class org.springframework.shell.core.JLineShellComponent: get history file name from provider.
getHistoryFileName() - Method in interface org.springframework.shell.plugin.HistoryFileNameProvider: get history file name
getHistoryFileName() - Method in class org.springframework.shell.plugin.support.DefaultHistoryFileNameProvider
getHistorySize() - Method in class org.springframework.shell.CommandLine
getHistorySize() - Method in class org.springframework.shell.core.JLineShell
getHome() - Method in class org.springframework.shell.core.AbstractShell: Obtains the home directory for the current shell instance.
getHome() - Method in interface org.springframework.shell.core.Shell: Returns the home directory of the current running shell instance
getHomeAsString() - Method in class org.springframework.shell.core.AbstractShell
getHomeAsString() - Method in class org.springframework.shell.core.JLineShell: Obtains the "roo.home" from the system property, falling back to the current working directory if missing.
getInputStream(Class<?>, String) - Static method in class org.springframework.shell.support.util.FileUtils: Loads the given file from the classpath.
getInstance() - Method in class org.springframework.shell.event.ParseResult
getJLineShellComponent() - Method in class org.springframework.shell.Bootstrap
getKey() - Method in class org.springframework.shell.core.MethodTarget
getLastValueDelimiter() - Method in class org.springframework.shell.core.Tokenizer: Return the delimiter (space or quotes) that was (or is being) used for the last value.
getLastValueStartOffset() - Method in class org.springframework.shell.core.Tokenizer: Return the offset at which the last value seen started (NOT including any delimiter).
getLogger(Class<?>) - Static method in class org.springframework.shell.support.logging.HandlerUtils: Obtains a Logger that guarantees to set the Level to Level.FINE if it is part of org.springframework.roo.
getMaxWidth() - Method in class org.springframework.shell.support.table.TableHeader: Deprecated.
getMessage() - Method in class org.springframework.shell.event.ShellStatus
getMethod() - Method in class org.springframework.shell.core.MethodTarget
getMethod() - Method in class org.springframework.shell.event.ParseResult
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.support.table.TableHeader: Deprecated.
getOffendingOffset() - Method in exception org.springframework.shell.core.TokenizingException
getOrder() - Method in class org.springframework.shell.core.Completion
getParser() - Method in class org.springframework.shell.core.AbstractShell
getParser() - Method in class org.springframework.shell.core.JLineShellComponent
getParseResult() - Method in class org.springframework.shell.event.ShellStatus
getPath(Class<?>, String) - Static method in class org.springframework.shell.support.util.FileUtils: Determines the path to the requested file, relative to the given class.
getPhase() - Method in class org.springframework.shell.core.JLineShellComponent
getProductName() - Method in class org.springframework.shell.core.JLineShell: get product name
getProductName() - Method in class org.springframework.shell.core.JLineShellComponent
getPrompt() - Method in interface org.springframework.shell.plugin.PromptProvider: Returns the prompt text.
getPrompt() - Method in class org.springframework.shell.plugin.support.DefaultPromptProvider
getPromptText() - Method in class org.springframework.shell.core.JLineShell: get prompt text from provider.
getPromptText() - Method in class org.springframework.shell.core.JLineShellComponent: get prompt text from provider.
getProviderName() - Method in interface org.springframework.shell.plugin.NamedProvider: Return the name of the provider.
getProviderName() - Method in class org.springframework.shell.plugin.support.DefaultBannerProvider
getProviderName() - Method in class org.springframework.shell.plugin.support.DefaultHistoryFileNameProvider
getProviderName() - Method in class org.springframework.shell.plugin.support.DefaultPromptProvider
getReason() - Method in exception org.springframework.shell.core.TokenizingException
getRemainingBuffer() - Method in class org.springframework.shell.core.MethodTarget
getResult() - Method in class org.springframework.shell.core.CommandResult
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: Return the number of rows that can be queried.
getRows() - Method in class org.springframework.shell.support.table.Table: Deprecated.
getShellCommandsToExecute() - Method in class org.springframework.shell.CommandLine
getShellPrompt() - Method in class org.springframework.shell.core.AbstractShell
getShellPrompt() - Method in interface org.springframework.shell.core.ShellPromptAccessor
getShellStatus() - Method in class org.springframework.shell.event.AbstractShellStatusPublisher
getShellStatus() - Method in interface org.springframework.shell.event.ShellStatusProvider: Returns the current shell status.
getSimpleParser() - Method in class org.springframework.shell.core.JLineShellComponent
getSourceClassName() - Method in class org.springframework.shell.support.logging.LoggingOutputStream
getStartupNotifications() - Method in class org.springframework.shell.core.JLineShell
getStartupNotifications() - Method in class org.springframework.shell.core.JLineShellComponent
getStatus() - Method in class org.springframework.shell.event.ShellStatus
getSystemDependentPath(String...) - Static method in class org.springframework.shell.support.util.FileUtils: Returns an operating-system-dependent path consisting of the given elements, separated by File.separator.
getSystemDependentPath(Collection<String>) - Static method in class org.springframework.shell.support.util.FileUtils: Returns an operating-system-dependent path consisting of the given elements, separated by File.separator.
getTarget() - Method in class org.springframework.shell.core.MethodTarget
getTargetHandler() - Method in class org.springframework.shell.support.logging.DeferredLogHandler
getTokens() - Method in class org.springframework.shell.core.Tokenizer
getValue() - Method in class org.springframework.shell.core.Completion
getValue(Integer) - Method in class org.springframework.shell.support.table.TableRow: Deprecated.

Return a value from this row.
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: Return the data value to be displayed at a given row and column, which may be null.
getVersion() - Method in class org.springframework.shell.core.JLineShell: get version information
getVersion() - Method in class org.springframework.shell.core.JLineShellComponent
getVersion() - Method in interface org.springframework.shell.plugin.BannerProvider: Returns the associated version.
getVersion() - Method in class org.springframework.shell.plugin.support.DefaultBannerProvider
getWelcomeMessage() - Method in class org.springframework.shell.core.JLineShellComponent: get the welcome message at start.
getWelcomeMessage() - Method in interface org.springframework.shell.plugin.BannerProvider: Returns the welcome message.
getWelcomeMessage() - Method in class org.springframework.shell.plugin.support.DefaultBannerProvider
getWidth() - Method in class org.springframework.shell.support.table.TableHeader: Deprecated.
getWorkingDirectory() - Method in class org.springframework.shell.converters.FileConverter
getWorkingDirectory() - Method in class org.springframework.shell.converters.SimpleFileConverter

H

handleExecutionResult(Object) - Method in class org.springframework.shell.core.AbstractShell: Handles the result of execution of a command.
HandlerUtils - Class in org.springframework.shell.support.logging: Utility methods for dealing with Handler objects.
HandlerUtils() - Constructor for class org.springframework.shell.support.logging.HandlerUtils
hashCode() - Method in class org.springframework.shell.core.Completion
hashCode() - Method in class org.springframework.shell.core.MethodTarget
hashCode() - Method in class org.springframework.shell.event.ParseResult
hashCode() - Method in class org.springframework.shell.event.ShellStatus
hashCode() - Method in class org.springframework.shell.support.table.Table: Deprecated.
hashCode() - Method in class org.springframework.shell.support.table.TableHeader: Deprecated.
hashCode() - Method in class org.springframework.shell.support.table.TableRow: Deprecated.
HelpCommands - Class in org.springframework.shell.commands: Provides a listing of commands known to the shell.
HelpCommands() - Constructor for class org.springframework.shell.commands.HelpCommands
HistoryFileNameProvider - Interface in org.springframework.shell.plugin: History file name provider.
HORIZONTAL_LINE - Static variable in class org.springframework.shell.support.table.TableRenderer: Deprecated.
horizontalGlyph() - Method in enum org.springframework.shell.table.BorderStyle

I

IdeTerminal - Class in org.springframework.shell.core: Terminal used for debugging inside an IDE.
IdeTerminal() - Constructor for class org.springframework.shell.core.IdeTerminal
inBlockComment - Variable in class org.springframework.shell.core.AbstractShell
inlineComment() - Method in class org.springframework.shell.commands.InlineCommentCommands
InlineCommentCommands - Class in org.springframework.shell.commands: Commands relating to inline comments
InlineCommentCommands() - Constructor for class org.springframework.shell.commands.InlineCommentCommands
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
IntegerConverter - Class in org.springframework.shell.converters: Converter for Integer.
IntegerConverter() - Constructor for class org.springframework.shell.converters.IntegerConverter
intersection(char, char, char, char) - Static method in enum org.springframework.shell.table.BorderStyle
IOUtils - Class in org.springframework.shell.support.util: Static helper methods relating to I/O.
isANSISupported() - Method in class org.springframework.shell.core.IdeTerminal
isAutoStartup() - Method in class org.springframework.shell.core.JLineShellComponent
isDevelopmentMode() - Method in class org.springframework.shell.core.JLineShell
isDevelopmentMode() - Method in interface org.springframework.shell.core.Shell
isEmpty(String) - Static method in class org.springframework.shell.support.util.StringUtils: Checks if a String is empty ("") or null.
isReadyForCommands() - Method in interface org.springframework.shell.core.ExecutionStrategy: Indicates commands are able to be presented.
isReadyForCommands() - Method in class org.springframework.shell.core.SimpleExecutionStrategy
isRunning() - Method in class org.springframework.shell.core.JLineShellComponent
isSpace(char) - Static method in class org.springframework.shell.support.util.NaturalOrderComparator: Indicates whether the given character is whitespace
isSuccess() - Method in class org.springframework.shell.core.CommandResult
isSuppressDuplicateMessages() - Static method in class org.springframework.shell.core.JLineLogHandler
isWindows() - Static method in class org.springframework.shell.support.util.OsUtils

J

JLineLogHandler - Class in org.springframework.shell.core: JDK logging Handler that emits log messages to a JLine ConsoleReader.
JLineLogHandler(ConsoleReader, ShellPromptAccessor) - Constructor for class org.springframework.shell.core.JLineLogHandler
JLineShell - Class in org.springframework.shell.core: Uses the feature-rich JLine library to provide an interactive shell.
JLineShell() - Constructor for class org.springframework.shell.core.JLineShell
JLineShellComponent - Class in org.springframework.shell.core: Launcher for JLineShell.
JLineShellComponent() - Constructor for class org.springframework.shell.core.JLineShellComponent
JVM_TERMINATED_EXIT - Static variable in class org.springframework.shell.core.ExitShellRequest

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

lastValueIsComplete() - Method in class org.springframework.shell.core.Tokenizer: Return true if we know for sure that the last value has been typed in full.
LEFT - Static variable in class org.springframework.shell.table.BorderSpecification
LINE_SEPARATOR - Static variable in class org.springframework.shell.support.util.OsUtils
LocaleConverter - Class in org.springframework.shell.converters: Converter for Locale.
LocaleConverter() - Constructor for class org.springframework.shell.converters.LocaleConverter
logCommandIfRequired(String, boolean) - Method in class org.springframework.shell.core.AbstractShell: Allows a subclass to log the execution of a well-formed command.
logCommandToOutput(String) - Method in class org.springframework.shell.core.AbstractShell: Allows a subclass to actually write the resulting logged command to some form of output.
logCommandToOutput(String) - Method in class org.springframework.shell.core.JLineShell
logger - Variable in class org.springframework.shell.commands.ScriptCommands
logger - Variable in class org.springframework.shell.core.AbstractShell
LOGGER - Static variable in class org.springframework.shell.support.logging.LoggingOutputStream
LoggingOutputStream - Class in org.springframework.shell.support.logging: Wraps an OutputStream and automatically passes each line to the Logger when OutputStream.flush() or OutputStream.close() is called.
LoggingOutputStream(Level) - Constructor for class org.springframework.shell.support.logging.LoggingOutputStream: Constructor
LongConverter - Class in org.springframework.shell.converters: Converter for Long.
LongConverter() - Constructor for class org.springframework.shell.converters.LongConverter

M

main(String[]) - Static method in class org.springframework.shell.Bootstrap
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
matches(int, int, TableModel) - Method in interface org.springframework.shell.table.CellMatcher: Return whether a given cell of the table should match.
matchesAntPath(String, String) - Static method in class org.springframework.shell.support.util.FileUtils: Indicates whether the given canonical path matches the given Ant-style pattern
MathUtils - Class in org.springframework.shell.support.util: A class which contains a number of number manipulation operations
MathUtils() - Constructor for class org.springframework.shell.support.util.MathUtils
max - Variable in class org.springframework.shell.table.SizeConstraints.Extent
MessageDisplayUtils - Class in org.springframework.shell.support.logging: Retrieves text files from the classloader and displays them on-screen.
MessageDisplayUtils() - Constructor for class org.springframework.shell.support.logging.MessageDisplayUtils
MethodTarget - Class in org.springframework.shell.core: A method that can be executed via a shell command.
MethodTarget(Method, Object) - Constructor for class org.springframework.shell.core.MethodTarget: Constructor for a null remainingBuffer and key
MethodTarget(Method, Object, String, String) - Constructor for class org.springframework.shell.core.MethodTarget: Constructor that allows all fields to be set
min - Variable in class org.springframework.shell.table.SizeConstraints.Extent

N

NamedProvider - Interface in org.springframework.shell.plugin: Returns the name of the provider.
NaturalOrderComparator<E> - Class in org.springframework.shell.support.util: NaturalOrderComparator.java -- Perform natural order comparisons of strings in Java.
NaturalOrderComparator() - Constructor for class org.springframework.shell.support.util.NaturalOrderComparator
newRow() - Method in class org.springframework.shell.support.table.Table: Deprecated.

Add a new empty row to the table.
NONE - Static variable in class org.springframework.shell.table.BorderSpecification
NONE - Static variable in enum org.springframework.shell.table.BorderStyle
NORMAL_EXIT - Static variable in class org.springframework.shell.core.ExitShellRequest
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

O

obtainHelp(String) - Method in class org.springframework.shell.commands.HelpCommands
obtainHelp(String) - Method in class org.springframework.shell.core.SimpleParser
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
onShellStatusChange(ShellStatus, ShellStatus) - Method in interface org.springframework.shell.event.ShellStatusListener: Invoked by the shell to report a new status.
openingQuotesHaveNotBeenClosed() - Method in class org.springframework.shell.core.Tokenizer: Return whether the last value was meant to be enclosed in quotes, but the closing quote has not been typed yet.
org.springframework.shell - package org.springframework.shell
org.springframework.shell.commands - package org.springframework.shell.commands
org.springframework.shell.converters - package org.springframework.shell.converters
org.springframework.shell.core - package org.springframework.shell.core
org.springframework.shell.core.annotation - package org.springframework.shell.core.annotation
org.springframework.shell.event - package org.springframework.shell.event
org.springframework.shell.plugin - package org.springframework.shell.plugin
org.springframework.shell.plugin.support - package org.springframework.shell.plugin.support
org.springframework.shell.support.logging - package org.springframework.shell.support.logging
org.springframework.shell.support.table - package org.springframework.shell.support.table
org.springframework.shell.support.util - package org.springframework.shell.support.util
org.springframework.shell.table - package org.springframework.shell.table
OsCommands - Class in org.springframework.shell.commands: Command type to allow execution of native OS commands from the Spring Shell.
OsCommands() - Constructor for class org.springframework.shell.commands.OsCommands
OsOperations - Interface in org.springframework.shell.commands: Operations type to allow execution of native OS commands from the Spring Roo shell.
OsOperationsImpl - Class in org.springframework.shell.commands: Implementation of OsOperations interface.
OsOperationsImpl() - Constructor for class org.springframework.shell.commands.OsOperationsImpl
OsUtils - Class in org.springframework.shell.support.util: Utilities for handling OS-specific behavior.
OsUtils() - Constructor for class org.springframework.shell.support.util.OsUtils
OUTLINE - Static variable in class org.springframework.shell.table.BorderSpecification

P

padLeft(String, int) - Static method in class org.springframework.shell.support.util.StringUtils: Left pad a String with spaces (' ').
padLeft(String, int, char) - Static method in class org.springframework.shell.support.util.StringUtils: Left pad a String with a specified character.
padLeft(String, int, String) - Static method in class org.springframework.shell.support.util.StringUtils: Left pad a String with a specified String.
padRight(String, int, char) - Static method in class org.springframework.shell.support.util.StringUtils: Right-pad a String with a configurable padding character.
padRight(String, int) - Static method in class org.springframework.shell.support.util.StringUtils: Right-pad the provided String with empty spaces.
paintBorder(BorderStyle, int) - Method in class org.springframework.shell.table.TableBuilder
parse(String) - Method in interface org.springframework.shell.core.Parser
parse(String) - Method in class org.springframework.shell.core.SimpleParser
parseCommandLine(String[]) - Static method in class org.springframework.shell.SimpleShellCommandLineOptions
Parser - Interface in org.springframework.shell.core: Interface for SimpleParser.
ParserCompleter - Class in org.springframework.shell.core: An implementation of JLine's Completer interface that delegates to a Parser.
ParserCompleter(Parser) - Constructor for class org.springframework.shell.core.ParserCompleter
ParseResult - Class in org.springframework.shell.event: Immutable representation of the outcome of parsing a given shell line.
ParseResult(Method, Object, Object[]) - Constructor for class org.springframework.shell.event.ParseResult
PluginUtils - Class in org.springframework.shell.plugin: Utilities dealing with shell plugins.
populate(List<Completion>, String, String, String) - Method in class org.springframework.shell.converters.FileConverter
printBannerAndWelcome() - Method in class org.springframework.shell.core.JLineShell
printBannerAndWelcome() - Method in class org.springframework.shell.core.JLineShellComponent
prohibitRedraw() - Static method in class org.springframework.shell.core.JLineLogHandler
promptLoop() - Method in class org.springframework.shell.core.JLineShell: Awaits user input, executes the command and displays the prompt to the user.
promptLoop() - Method in interface org.springframework.shell.core.Shell: Presents a console prompt and allows the user to interact with the shell.
PromptProvider - Interface in org.springframework.shell.plugin: Shell prompt provider.
props() - Method in class org.springframework.shell.commands.SystemPropertyCommands
publish(LogRecord) - Method in class org.springframework.shell.core.JLineLogHandler
publish(LogRecord) - Method in class org.springframework.shell.support.logging.DeferredLogHandler: Stores the log record internally.

Q

quit() - Method in class org.springframework.shell.commands.ExitCommands

R

read(File) - Static method in class org.springframework.shell.support.util.FileUtils: Returns the contents of the given File as a String.
readBanner(Reader) - Static method in class org.springframework.shell.support.util.FileUtils: Reads a banner from the given resource.
readBanner(Class<?>, String) - Static method in class org.springframework.shell.support.util.FileUtils: Reads a banner from the given resource.
reader - Variable in class org.springframework.shell.core.JLineShell
registerTargetHandler(Logger, Handler) - Static method in class org.springframework.shell.support.logging.HandlerUtils: Registers the presented target Handler against any DeferredLogHandler encountered in the presented Logger.
remove(Class<?>) - Method in interface org.springframework.shell.converters.StaticFieldConverter
remove(Class<?>) - Method in class org.springframework.shell.converters.StaticFieldConverterImpl
remove(CommandMarker) - Method in class org.springframework.shell.core.SimpleParser
remove(Converter<?>) - Method in class org.springframework.shell.core.SimpleParser
removeLeadingAndTrailingSeparators(String) - Static method in class org.springframework.shell.support.util.FileUtils: Removes any leading or trailing File.separators from the given path.
removeShellStatusListener(ShellStatusListener) - Method in class org.springframework.shell.event.AbstractShellStatusPublisher
removeShellStatusListener(ShellStatusListener) - Method in interface org.springframework.shell.event.ShellStatusProvider: Removes an existing status listener.
removeTrailingSeparator(String) - Static method in class org.springframework.shell.support.util.FileUtils: Removes any trailing File.separators from the given path
render(int) - Method in class org.springframework.shell.table.Table
render(int) - Method in interface org.springframework.shell.TerminalSizeAware
renderMapDataAsTable(List<Map<String, Object>>, List<String>) - Static method in class org.springframework.shell.support.table.TableRenderer: Deprecated.

Renders a textual representation of the list of provided Map data
renderParameterInfoDataAsTable(Map<String, String>, boolean, int) - Static method in class org.springframework.shell.support.table.TableRenderer: Deprecated.
renderParameterInfoDataAsTable(Map<String, String>) - Static method in class org.springframework.shell.support.table.TableRenderer: Deprecated.

Renders a textual representation of provided parameter map.
renderTextTable(Table) - Static method in class org.springframework.shell.support.table.TableRenderer: Deprecated.
renderTextTable(Table, boolean) - Static method in class org.springframework.shell.support.table.TableRenderer: Deprecated.

Renders a textual representation of the provided Table
resetMessageTracking() - Static method in class org.springframework.shell.core.JLineLogHandler
RIGHT - Static variable in class org.springframework.shell.table.BorderSpecification
ROO_PROMPT - Static variable in class org.springframework.shell.core.AbstractShell
round(double, int) - Static method in class org.springframework.shell.support.util.MathUtils
row(int) - Static method in class org.springframework.shell.table.CellMatchers: Return a matcher that applies to every cell of some row of the table.
run() - Method in class org.springframework.shell.Bootstrap
run() - Method in class org.springframework.shell.core.JLineShell

S

script(File, boolean) - Method in class org.springframework.shell.commands.ScriptCommands
ScriptCommands - Class in org.springframework.shell.commands
ScriptCommands() - Constructor for class org.springframework.shell.commands.ScriptCommands
setApplicationContext(ApplicationContext) - Method in class org.springframework.shell.commands.HelpCommands
setApplicationContext(ApplicationContext) - Method in class org.springframework.shell.commands.VersionCommands
setApplicationContext(ApplicationContext) - Method in class org.springframework.shell.core.JLineShellComponent
setConverters(Set<Converter<?>>) - Method in class org.springframework.shell.converters.ArrayConverter
setData(Map<Integer, String>) - Method in class org.springframework.shell.support.table.TableRow: Deprecated.
setDevelopmentMode(boolean) - Method in class org.springframework.shell.core.JLineShell
setDevelopmentMode(boolean) - Method in interface org.springframework.shell.core.Shell: Indicates the shell should switch into a lower-level development mode.
setHistorySize(int) - Method in class org.springframework.shell.core.JLineShell
setIncludeThreadName(boolean) - Static method in class org.springframework.shell.core.JLineLogHandler
setMaxWidth(int) - Method in class org.springframework.shell.support.table.TableHeader: Deprecated.

Defaults to -1 indicating to ignore the property.
setName(String) - Method in class org.springframework.shell.support.table.TableHeader: Deprecated.
setPrintBanner(boolean) - Method in class org.springframework.shell.core.JLineShellComponent
setPromptPath(String) - Method in class org.springframework.shell.core.AbstractShell: Base implementation of the Shell.setPromptPath(String) method, designed for simple shell implementations.
setPromptPath(String, boolean) - Method in class org.springframework.shell.core.AbstractShell: Default implementation of Shell#setPromptPath(String, boolean)) method to satisfy STS compatibility.
setPromptPath(String) - Method in class org.springframework.shell.core.JLineShell
setPromptPath(String, boolean) - Method in class org.springframework.shell.core.JLineShell
setPromptPath(String) - Method in interface org.springframework.shell.core.Shell: Changes the "path" displayed in the shell prompt.
setPromptPath(String, boolean) - Method in interface org.springframework.shell.core.Shell
setShellStatus(ShellStatus.Status) - Method in class org.springframework.shell.event.AbstractShellStatusPublisher
setShellStatus(ShellStatus.Status, String, ParseResult) - Method in class org.springframework.shell.event.AbstractShellStatusPublisher
setSourceClassName(String) - Method in class org.springframework.shell.support.logging.LoggingOutputStream
setSuppressDuplicateMessages(boolean) - Static method in class org.springframework.shell.core.JLineLogHandler
setTargetHandler(Handler) - Method in class org.springframework.shell.support.logging.DeferredLogHandler
setWidth(int) - Method in class org.springframework.shell.support.table.TableHeader: Deprecated.
Shell - Interface in org.springframework.shell.core: Specifies the contract for an interactive shell.
ShellException - Exception in org.springframework.shell: Shell exception.
ShellException() - Constructor for exception org.springframework.shell.ShellException
ShellException(String) - Constructor for exception org.springframework.shell.ShellException
ShellException(Throwable) - Constructor for exception org.springframework.shell.ShellException
ShellException(String, Throwable) - Constructor for exception org.springframework.shell.ShellException
shellPrompt - Static variable in class org.springframework.shell.core.AbstractShell
ShellPromptAccessor - Interface in org.springframework.shell.core: Obtains the prompt used by a Shell.
shellStatus - Variable in class org.springframework.shell.event.AbstractShellStatusPublisher
ShellStatus - Class in org.springframework.shell.event: Represents the different states that a shell can legally be in.
ShellStatus.Status - Enum in org.springframework.shell.event
ShellStatusListener - Interface in org.springframework.shell.event: Implemented by classes that wish to be notified of shell status changes.
shellStatusListeners - Variable in class org.springframework.shell.event.AbstractShellStatusPublisher
ShellStatusProvider - Interface in org.springframework.shell.event: Implemented by shells that support the publication of shell status changes.
ShortConverter - Class in org.springframework.shell.converters: Converter for Short.
ShortConverter() - Constructor for class org.springframework.shell.converters.ShortConverter
SimpleExecutionStrategy - Class in org.springframework.shell.core: Simple execution strategy for invoking a target method.
SimpleExecutionStrategy() - Constructor for class org.springframework.shell.core.SimpleExecutionStrategy
SimpleFileConverter - Class in org.springframework.shell.converters
SimpleFileConverter() - Constructor for class org.springframework.shell.converters.SimpleFileConverter
SimpleHorizontalAligner - Enum in org.springframework.shell.table: An horizontal alignment strategy that allows alignment to the left, center or right.
SimpleParser - Class in org.springframework.shell.core: Default implementation of Parser.
SimpleParser() - Constructor for class org.springframework.shell.core.SimpleParser
SimpleShellCommandLineOptions - Class in org.springframework.shell: Used to pass in command line options to customize the shell on launch
SimpleShellCommandLineOptions() - Constructor for class org.springframework.shell.SimpleShellCommandLineOptions
SimpleVerticalAligner - Enum in org.springframework.shell.table: Alignment strategy that allows simple vertical alignment to top, middle or bottom.
SizeConstraints - Interface in org.springframework.shell.table: Strategy for computing the dimensions of a table cell.
SizeConstraints.Extent - Class in org.springframework.shell.table: Holds both a minimum and maximum width.
SizeConstraints.Extent(int, int) - Constructor for class org.springframework.shell.table.SizeConstraints.Extent
start() - Method in class org.springframework.shell.core.JLineShellComponent
StaticFieldConverter - Interface in org.springframework.shell.converters: Interface for adding and removing classes that provide static fields which should be made available via a Converter.
StaticFieldConverterImpl - Class in org.springframework.shell.converters: A simple Converter for those classes which provide public static fields to represent possible textual values.
StaticFieldConverterImpl() - Constructor for class org.springframework.shell.converters.StaticFieldConverterImpl
statusListener - Variable in class org.springframework.shell.core.JLineShell
stop(Runnable) - Method in class org.springframework.shell.core.JLineShellComponent
stop() - Method in class org.springframework.shell.core.JLineShellComponent
StringConverter - Class in org.springframework.shell.converters: Converter for String.
StringConverter() - Constructor for class org.springframework.shell.converters.StringConverter
stringify(E) - Method in class org.springframework.shell.support.util.NaturalOrderComparator
StringUtils - Class in org.springframework.shell.support.util: Utility methods for Strings focused on the use in formatting of tables.
StringUtils() - Constructor for class org.springframework.shell.support.util.StringUtils
supports(Class<?>, String) - Method in class org.springframework.shell.converters.ArrayConverter
supports(Class<?>, String) - Method in class org.springframework.shell.converters.AvailableCommandsConverter
supports(Class<?>, String) - Method in class org.springframework.shell.converters.BigDecimalConverter
supports(Class<?>, String) - Method in class org.springframework.shell.converters.BigIntegerConverter
supports(Class<?>, String) - Method in class org.springframework.shell.converters.BooleanConverter
supports(Class<?>, String) - Method in class org.springframework.shell.converters.CharacterConverter
supports(Class<?>, String) - Method in class org.springframework.shell.converters.DateConverter
supports(Class<?>, String) - Method in class org.springframework.shell.converters.DoubleConverter
supports(Class<?>, String) - Method in class org.springframework.shell.converters.EnumConverter
supports(Class<?>, String) - Method in class org.springframework.shell.converters.FileConverter
supports(Class<?>, String) - Method in class org.springframework.shell.converters.FloatConverter
supports(Class<?>, String) - Method in class org.springframework.shell.converters.IntegerConverter
supports(Class<?>, String) - Method in class org.springframework.shell.converters.LocaleConverter
supports(Class<?>, String) - Method in class org.springframework.shell.converters.LongConverter
supports(Class<?>, String) - Method in class org.springframework.shell.converters.ShortConverter
supports(Class<?>, String) - Method in class org.springframework.shell.converters.StaticFieldConverterImpl
supports(Class<?>, String) - Method in class org.springframework.shell.converters.StringConverter
supports(Class<?>, String) - Method in interface org.springframework.shell.core.Converter: Indicates whether this converter supports the given type in the given option context
SystemPropertyCommands - Class in org.springframework.shell.commands: Commands related to system properties
SystemPropertyCommands() - Constructor for class org.springframework.shell.commands.SystemPropertyCommands

T

TAB_COMPLETION_COUNT_PREFIX - Static variable in interface org.springframework.shell.core.Converter: The prefix for the option context property that indicates how many successive tab completion requests have occurred.
Table - Class in org.springframework.shell.support.table: Deprecated.
In favor of TableBuilder
Table() - Constructor for class org.springframework.shell.support.table.Table: Deprecated.
table() - Static method in class org.springframework.shell.table.CellMatchers: Return a matcher that applies to every cell of the table.
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
TableHeader - Class in org.springframework.shell.support.table: Deprecated.
In favor of TableBuilder
TableHeader(String, int) - Constructor for class org.springframework.shell.support.table.TableHeader: Deprecated.

Constructor that initializes the table header with the provided header name and the with of the table header.
TableHeader(String) - Constructor for class org.springframework.shell.support.table.TableHeader: Deprecated.

Constructor that initializes the table header with the provided header name.
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
TableRenderer - Class in org.springframework.shell.support.table: Deprecated.
In favor of TableBuilder
TableRow - Class in org.springframework.shell.support.table: Deprecated.
In favor of TableBuilder
TableRow() - Constructor for class org.springframework.shell.support.table.TableRow: Deprecated.
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
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.
terminate() - Method in interface org.springframework.shell.core.ExecutionStrategy: Indicates the execution runtime should be terminated.
terminate() - Method in class org.springframework.shell.core.SimpleExecutionStrategy
TextWrapper - Interface in org.springframework.shell.table: A strategy for applying text wrapping/cropping given a cell width.
toBottomRight() - Method in class org.springframework.shell.table.TableBuilder.BorderStub.TopLeft
tokenize() - Method in class org.springframework.shell.core.Tokenizer
Tokenizer - Class in org.springframework.shell.core: Converts a particular buffer into a tokenized structure.
Tokenizer(String) - Constructor for class org.springframework.shell.core.Tokenizer
Tokenizer(String, boolean) - Constructor for class org.springframework.shell.core.Tokenizer
TokenizingException - Exception in org.springframework.shell.core
TokenizingException(int, char[], String) - Constructor for exception org.springframework.shell.core.TokenizingException
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.core.CommandResult
toString() - Method in class org.springframework.shell.core.Completion
toString() - Method in class org.springframework.shell.core.MethodTarget
toString() - Method in class org.springframework.shell.core.Tokenizer
toString() - Method in class org.springframework.shell.event.ParseResult
toString() - Method in class org.springframework.shell.support.table.Table: Deprecated.
toString() - Method in class org.springframework.shell.table.BorderSpecification
transpose() - Method in class org.springframework.shell.table.TableModel: Return a transposed view of this model, where rows become columns and vice-versa.

U

updateWidth(int) - Method in class org.springframework.shell.support.table.TableHeader: Deprecated.

Updated the width for this particular column, but only if the value of the passed-in width is higher than the value of the pre-existing width.

V

valueOf(String) - Static method in enum org.springframework.shell.event.ShellStatus.Status: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.springframework.shell.support.util.AnsiEscapeCode: 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.
values() - Static method in enum org.springframework.shell.event.ShellStatus.Status: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.springframework.shell.support.util.AnsiEscapeCode: 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() - Method in class org.springframework.shell.commands.VersionCommands
VersionCommands - Class in org.springframework.shell.commands: Essential built-in shell commands.
VersionCommands() - Constructor for class org.springframework.shell.commands.VersionCommands
versionInfo() - Method in class org.springframework.shell.core.AbstractShell
versionInfo() - Static method in class org.springframework.shell.support.util.VersionUtils: Returns the full version string of the present Spring Shell codebase, or null if it cannot be determined.
VersionUtils - Class in org.springframework.shell.support.util
VersionUtils() - Constructor for class org.springframework.shell.support.util.VersionUtils
verticalGlyph() - Method in enum org.springframework.shell.table.BorderStyle

W

waitForComplete() - Method in class org.springframework.shell.core.JLineShellComponent: wait the shell command to complete by typing "quit" or "exit"
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: Return the minimum and maximum width of the cell, given its raw content.
WINDOW_TITLE_SLOT - Static variable in interface org.springframework.shell.core.Shell: The slot name to use with Shell.flash(Level, String, String) if a caller wishes to modify the window title.
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: Return a list of lines where each line length MUST be equal to columnWidth (padding with spaces if appropriate).
wrapWithDeferredLogHandler(Logger, Level) - Static method in class org.springframework.shell.support.logging.HandlerUtils: Replaces each Handler defined against the presented Logger with DeferredLogHandler.
write(int) - Method in class org.springframework.shell.support.logging.LoggingOutputStream

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