Index

A B C D E F G H I L M N O P R S T V
All Classes and Interfaces|All Packages|Serialized Form

A

AbstractCommand - Class in org.springframework.boot.cli.command

Abstract Command implementation.

AbstractCommand(String, String) - Constructor for class org.springframework.boot.cli.command.AbstractCommand

Create a new AbstractCommand instance.

addCommand(Command) - Method in class org.springframework.boot.cli.command.CommandRunner

Add the specified command.

addCommands(Iterable<Command>) - Method in class org.springframework.boot.cli.command.CommandRunner

Add the specified commands.

afterRun(Command) - Method in class org.springframework.boot.cli.command.CommandRunner

Subclass hook called after a command has run.

B

beforeRun(Command) - Method in class org.springframework.boot.cli.command.CommandRunner

Subclass hook called before a command is run.

C

Command - Interface in org.springframework.boot.cli.command

A single command that can be run from the CLI.

CommandCompleter - Class in org.springframework.boot.cli.command.shell

JLine Completer for Spring Boot Commands.

CommandCompleter(ConsoleReader, ArgumentCompleter.ArgumentDelimiter, Iterable<Command>) - Constructor for class org.springframework.boot.cli.command.shell.CommandCompleter

CommandException - Exception in org.springframework.boot.cli.command

Runtime exception wrapper that defines additional CommandException.Options that are understood by the CommandRunner.

CommandException(String, Throwable, CommandException.Option...) - Constructor for exception org.springframework.boot.cli.command.CommandException

Create a new CommandException with the specified options.

CommandException(String, CommandException.Option...) - Constructor for exception org.springframework.boot.cli.command.CommandException

Create a new CommandException with the specified options.

CommandException(Throwable, CommandException.Option...) - Constructor for exception org.springframework.boot.cli.command.CommandException

Create a new CommandException with the specified options.

CommandException(CommandException.Option...) - Constructor for exception org.springframework.boot.cli.command.CommandException

Create a new CommandException with the specified options.

CommandException.Option - Enum Class in org.springframework.boot.cli.command

Specific options understood by the CommandRunner.

CommandFactory - Interface in org.springframework.boot.cli.command

Factory used to create CLI Commands.

CommandRunner - Class in org.springframework.boot.cli.command

Main class used to run Commands.

CommandRunner(String) - Constructor for class org.springframework.boot.cli.command.CommandRunner

Create a new CommandRunner instance.

complete(String, int, List<CharSequence>) - Method in class org.springframework.boot.cli.command.shell.CommandCompleter

D

DefaultCommandFactory - Class in org.springframework.boot.cli

Default implementation of CommandFactory.

DefaultCommandFactory() - Constructor for class org.springframework.boot.cli.DefaultCommandFactory

E

EncodePasswordCommand - Class in org.springframework.boot.cli.command.encodepassword

Command to encode passwords for use with Spring Security.

EncodePasswordCommand() - Constructor for class org.springframework.boot.cli.command.encodepassword.EncodePasswordCommand

error(Exception) - Static method in class org.springframework.boot.cli.util.Log

error(String) - Static method in class org.springframework.boot.cli.util.Log

ERROR - Static variable in class org.springframework.boot.cli.command.status.ExitStatus

Generic "not OK" exit status with non-zero exit code and hangup=true.

errorMessage(String) - Method in class org.springframework.boot.cli.command.CommandRunner

ExitStatus - Class in org.springframework.boot.cli.command.status

Encapsulation of the outcome of a command.

ExitStatus(int, String) - Constructor for class org.springframework.boot.cli.command.status.ExitStatus

Create a new ExitStatus instance.

ExitStatus(int, String, boolean) - Constructor for class org.springframework.boot.cli.command.status.ExitStatus

Create a new ExitStatus instance.

F

findCommand(String) - Method in class org.springframework.boot.cli.command.CommandRunner

Find a command by name.

G

getCode() - Method in class org.springframework.boot.cli.command.status.ExitStatus

An exit code appropriate for use in System.exit().

getCommands() - Method in interface org.springframework.boot.cli.command.CommandFactory

Returns the CLI Commands.

getCommands() - Method in class org.springframework.boot.cli.command.CommandRunner

getCommands() - Method in class org.springframework.boot.cli.DefaultCommandFactory

getDescription() - Method in class org.springframework.boot.cli.command.AbstractCommand

getDescription() - Method in interface org.springframework.boot.cli.command.Command

Returns a description of the command.

getDescription() - Method in class org.springframework.boot.cli.command.HelpExample

getExample() - Method in class org.springframework.boot.cli.command.HelpExample

getExamples() - Method in class org.springframework.boot.cli.command.AbstractCommand

getExamples() - Method in interface org.springframework.boot.cli.command.Command

Return some examples for the command.

getExamples() - Method in class org.springframework.boot.cli.command.encodepassword.EncodePasswordCommand

getExamples() - Method in class org.springframework.boot.cli.command.init.InitCommand

getHandler() - Method in class org.springframework.boot.cli.command.OptionParsingCommand

getHelp() - Method in class org.springframework.boot.cli.command.AbstractCommand

getHelp() - Method in interface org.springframework.boot.cli.command.Command

Gets full help text for the command, e.g.

getHelp() - Method in class org.springframework.boot.cli.command.core.HelpCommand

getHelp() - Method in class org.springframework.boot.cli.command.OptionParsingCommand

getHelp() - Method in class org.springframework.boot.cli.command.options.OptionHandler

getName() - Method in class org.springframework.boot.cli.command.AbstractCommand

getName() - Method in interface org.springframework.boot.cli.command.Command

Returns the name of the command.

getName() - Method in class org.springframework.boot.cli.command.CommandRunner

Return the name of the runner or an empty string.

getName() - Method in class org.springframework.boot.cli.command.status.ExitStatus

A name describing the outcome.

getOptions() - Method in exception org.springframework.boot.cli.command.CommandException

Returns a set of options that are understood by the CommandRunner.

getOptions() - Method in interface org.springframework.boot.cli.command.options.OptionHelp

Returns the set of options that are mutually synonymous.

getOptionsHelp() - Method in class org.springframework.boot.cli.command.AbstractCommand

getOptionsHelp() - Method in interface org.springframework.boot.cli.command.Command

Returns help for each supported option.

getOptionsHelp() - Method in class org.springframework.boot.cli.command.core.HelpCommand

getOptionsHelp() - Method in class org.springframework.boot.cli.command.OptionParsingCommand

getOptionsHelp() - Method in class org.springframework.boot.cli.command.options.OptionHandler

getParser() - Method in class org.springframework.boot.cli.command.options.OptionHandler

getPrompt() - Method in class org.springframework.boot.cli.command.shell.ShellPrompts

Returns the current prompt.

getUsageHelp() - Method in class org.springframework.boot.cli.command.AbstractCommand

getUsageHelp() - Method in interface org.springframework.boot.cli.command.Command

Returns usage help for the command.

getUsageHelp() - Method in class org.springframework.boot.cli.command.core.HelpCommand

getUsageHelp() - Method in class org.springframework.boot.cli.command.encodepassword.EncodePasswordCommand

getUsageHelp() - Method in class org.springframework.boot.cli.command.init.InitCommand

getUsageHelp() - Method in interface org.springframework.boot.cli.command.options.OptionHelp

Returns usage help for the option.

H

handleSigInt() - Method in class org.springframework.boot.cli.command.shell.Shell

Final handle an interrupt signal (CTRL-C).

hangup() - Method in class org.springframework.boot.cli.command.status.ExitStatus

Convert the existing code to a hangup.

HelpCommand - Class in org.springframework.boot.cli.command.core

Internal Command used for 'help' requests.

HelpCommand(CommandRunner) - Constructor for class org.springframework.boot.cli.command.core.HelpCommand

HelpExample - Class in org.springframework.boot.cli.command

An example that can be displayed in the help.

HelpExample(String, String) - Constructor for class org.springframework.boot.cli.command.HelpExample

Create a new HelpExample instance.

HIDE_MESSAGE - Enum constant in enum class org.springframework.boot.cli.command.CommandException.Option

Hide the exception message.

HintCommand - Class in org.springframework.boot.cli.command.core

Internal Command to provide hints for shell auto-completion.

HintCommand(CommandRunner) - Constructor for class org.springframework.boot.cli.command.core.HintCommand

I

info(String) - Static method in class org.springframework.boot.cli.util.Log

infoPrint(String) - Static method in class org.springframework.boot.cli.util.Log

InitCommand - Class in org.springframework.boot.cli.command.init

Command that initializes a project using Spring initializr.

InitCommand() - Constructor for class org.springframework.boot.cli.command.init.InitCommand

InitCommand(InitCommand.InitOptionHandler) - Constructor for class org.springframework.boot.cli.command.init.InitCommand

isHangup() - Method in class org.springframework.boot.cli.command.status.ExitStatus

Flag to signal that the caller can (or should) hangup.

isOptionCommand(Command) - Method in class org.springframework.boot.cli.command.CommandRunner

Returns if the specified command is an option command.

iterator() - Method in class org.springframework.boot.cli.command.CommandRunner

L

Log - Class in org.springframework.boot.cli.util

Simple logger used by the CLI.

Log() - Constructor for class org.springframework.boot.cli.util.Log

M

main(String...) - Static method in class org.springframework.boot.cli.SpringCli

N

NoHelpCommandArgumentsException - Exception in org.springframework.boot.cli.command

Exception used to when the help command is called without arguments.

NoHelpCommandArgumentsException() - Constructor for exception org.springframework.boot.cli.command.NoHelpCommandArgumentsException

NoSuchCommandException - Exception in org.springframework.boot.cli.command

Exception used when a command is not found.

NoSuchCommandException(String) - Constructor for exception org.springframework.boot.cli.command.NoSuchCommandException

O

OK - Static variable in class org.springframework.boot.cli.command.status.ExitStatus

Generic "OK" exit status with zero exit code and hangup=false.

option(String, String) - Method in class org.springframework.boot.cli.command.options.OptionHandler

option(List<String>, String) - Method in class org.springframework.boot.cli.command.options.OptionHandler

OptionHandler - Class in org.springframework.boot.cli.command.options

Delegate used by OptionParsingCommand to parse options and run the command.

OptionHandler() - Constructor for class org.springframework.boot.cli.command.options.OptionHandler

Create a new OptionHandler instance.

OptionHandler(Function<String, String>) - Constructor for class org.springframework.boot.cli.command.options.OptionHandler

Create a new OptionHandler instance with an argument processor.

OptionHelp - Interface in org.springframework.boot.cli.command.options

Help for a specific option.

OptionParsingCommand - Class in org.springframework.boot.cli.command

Base class for a Command that parse options using an OptionHandler.

OptionParsingCommand(String, String, OptionHandler) - Constructor for class org.springframework.boot.cli.command.OptionParsingCommand

options() - Method in class org.springframework.boot.cli.command.options.OptionHandler

org.springframework.boot.cli - package org.springframework.boot.cli

Main entry point of the Spring Boot CLI.

org.springframework.boot.cli.command - package org.springframework.boot.cli.command

Command infrastructure for the CLI.

org.springframework.boot.cli.command.core - package org.springframework.boot.cli.command.core

Core CLI commands.

org.springframework.boot.cli.command.encodepassword - package org.springframework.boot.cli.command.encodepassword

CLI command for password encoding.

org.springframework.boot.cli.command.init - package org.springframework.boot.cli.command.init

CLI command for initializing a new application using Spring Initializr.

org.springframework.boot.cli.command.options - package org.springframework.boot.cli.command.options

Support classes for handling command line options.

org.springframework.boot.cli.command.shell - package org.springframework.boot.cli.command.shell

Classes for running a nested shell in the CLI.

org.springframework.boot.cli.command.status - package org.springframework.boot.cli.command.status

CLI command status.

org.springframework.boot.cli.util - package org.springframework.boot.cli.util

Utility classes for the CLI.

P

popPrompt() - Method in class org.springframework.boot.cli.command.shell.ShellPrompts

Pop a previously pushed prompt, returning to the previous value.

printStackTrace(Exception) - Method in class org.springframework.boot.cli.command.CommandRunner

PromptCommand - Class in org.springframework.boot.cli.command.shell

Command to change the Shell prompt.

PromptCommand(ShellPrompts) - Constructor for class org.springframework.boot.cli.command.shell.PromptCommand

pushPrompt(String) - Method in class org.springframework.boot.cli.command.shell.ShellPrompts

Push a new prompt to be used by the shell.

R

ReportableException - Exception in org.springframework.boot.cli.command.init

Exception with a message that can be reported to the user.

ReportableException(String) - Constructor for exception org.springframework.boot.cli.command.init.ReportableException

ReportableException(String, Throwable) - Constructor for exception org.springframework.boot.cli.command.init.ReportableException

RETHROW - Enum constant in enum class org.springframework.boot.cli.command.CommandException.Option

Re-throw the exception rather than dealing with it.

run() - Method in class org.springframework.boot.cli.command.shell.Shell

Run the shell until the user exists.

run(String...) - Method in interface org.springframework.boot.cli.command.Command

Run the command.

run(String...) - Method in class org.springframework.boot.cli.command.CommandRunner

Parse the arguments and run a suitable command.

run(String...) - Method in class org.springframework.boot.cli.command.core.HelpCommand

run(String...) - Method in class org.springframework.boot.cli.command.core.HintCommand

run(String...) - Method in class org.springframework.boot.cli.command.core.VersionCommand

run(String...) - Method in class org.springframework.boot.cli.command.OptionParsingCommand

run(String...) - Method in class org.springframework.boot.cli.command.options.OptionHandler

run(String...) - Method in class org.springframework.boot.cli.command.shell.PromptCommand

run(String...) - Method in class org.springframework.boot.cli.command.shell.ShellCommand

run(OptionSet) - Method in class org.springframework.boot.cli.command.options.OptionHandler

Run the command using the specified parsed OptionSet.

runAndHandleErrors(String...) - Method in class org.springframework.boot.cli.command.CommandRunner

Run the appropriate and handle and errors.

S

setHiddenCommands(Class<?>...) - Method in class org.springframework.boot.cli.command.CommandRunner

Set the command classes which should be hidden (i.e.

setOptionCommands(Class<?>...) - Method in class org.springframework.boot.cli.command.CommandRunner

Set the command classes which should be considered option commands.

Shell - Class in org.springframework.boot.cli.command.shell

A shell for Spring Boot.

ShellCommand - Class in org.springframework.boot.cli.command.shell

Command to start a nested REPL shell.

ShellCommand() - Constructor for class org.springframework.boot.cli.command.shell.ShellCommand

ShellExitException - Exception in org.springframework.boot.cli.command.shell

Exception used to stop the Shell.

ShellExitException() - Constructor for exception org.springframework.boot.cli.command.shell.ShellExitException

ShellPrompts - Class in org.springframework.boot.cli.command.shell

Abstraction to manage a stack of prompts.

ShellPrompts() - Constructor for class org.springframework.boot.cli.command.shell.ShellPrompts

SHOW_USAGE - Enum constant in enum class org.springframework.boot.cli.command.CommandException.Option

Print basic CLI usage information.

showUsage() - Method in class org.springframework.boot.cli.command.CommandRunner

SpringCli - Class in org.springframework.boot.cli

Spring Command Line Interface.

STACK_TRACE - Enum constant in enum class org.springframework.boot.cli.command.CommandException.Option

Print the stack-trace of the exception.

T

toString() - Method in class org.springframework.boot.cli.command.status.ExitStatus

V

valueOf(String) - Static method in enum class org.springframework.boot.cli.command.CommandException.Option

Returns the enum constant of this class with the specified name.

values() - Static method in enum class org.springframework.boot.cli.command.CommandException.Option

Returns an array containing the constants of this enum class, in the order they are declared.

VersionCommand - Class in org.springframework.boot.cli.command.core

Command to display the 'version' number.

VersionCommand() - Constructor for class org.springframework.boot.cli.command.core.VersionCommand

A B C D E F G H I L M N O P R S T V
All Classes and Interfaces|All Packages|Serialized Form