Index
All Classes and Interfaces|All Packages|Serialized Form
A
- AbstractCommand - Class in org.springframework.boot.cli.command
-
Abstract
Commandimplementation. - AbstractCommand(String, String) - Constructor for class org.springframework.boot.cli.command.AbstractCommand
-
Create a new
AbstractCommandinstance. - accumulate(String, Object) - Method in class org.springframework.boot.cli.json.JSONObject
-
Appends
valueto the array already mapped toname. - 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.
- array() - Method in class org.springframework.boot.cli.json.JSONStringer
-
Begins encoding a new array.
B
- back() - Method in class org.springframework.boot.cli.json.JSONTokener
- 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
Completerfor Spring BootCommands. - CommandCompleter(ConsoleReader, ArgumentCompleter.ArgumentDelimiter, Iterable<Command>) - Constructor for class org.springframework.boot.cli.command.shell.CommandCompleter
- CommandException - Exception Class in org.springframework.boot.cli.command
-
Runtime exception wrapper that defines additional
CommandException.Options that are understood by theCommandRunner. - CommandException(String, Throwable, CommandException.Option...) - Constructor for exception class org.springframework.boot.cli.command.CommandException
-
Create a new
CommandExceptionwith the specified options. - CommandException(String, CommandException.Option...) - Constructor for exception class org.springframework.boot.cli.command.CommandException
-
Create a new
CommandExceptionwith the specified options. - CommandException(Throwable, CommandException.Option...) - Constructor for exception class org.springframework.boot.cli.command.CommandException
-
Create a new
CommandExceptionwith the specified options. - CommandException(CommandException.Option...) - Constructor for exception class org.springframework.boot.cli.command.CommandException
-
Create a new
CommandExceptionwith 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
CommandRunnerinstance. - 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
- dehexchar(char) - Static method in class org.springframework.boot.cli.json.JSONTokener
E
- EncodePasswordCommand - Class in org.springframework.boot.cli.command.encodepassword
-
Commandto encode passwords for use with Spring Security. - EncodePasswordCommand() - Constructor for class org.springframework.boot.cli.command.encodepassword.EncodePasswordCommand
- endArray() - Method in class org.springframework.boot.cli.json.JSONStringer
-
Ends encoding the current array.
- endObject() - Method in class org.springframework.boot.cli.json.JSONStringer
-
Ends encoding the current object.
- equals(Object) - Method in class org.springframework.boot.cli.json.JSONArray
- error(String) - Static method in class org.springframework.boot.cli.util.Log
- error(Exception) - 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
ExitStatusinstance. - ExitStatus(int, String, boolean) - Constructor for class org.springframework.boot.cli.command.status.ExitStatus
-
Create a new
ExitStatusinstance.
F
- findCommand(String) - Method in class org.springframework.boot.cli.command.CommandRunner
-
Find a command by name.
G
- get(int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the value at
index. - get(String) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the value mapped by
name. - getBoolean(int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the value at
indexif it exists and is a boolean or can be coerced to a boolean. - getBoolean(String) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the value mapped by
nameif it exists and is a boolean or can be coerced to a boolean. - 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
- getDouble(int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the value at
indexif it exists and is a double or can be coerced to a double. - getDouble(String) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the value mapped by
nameif it exists and is a double or can be coerced to a double. - 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
- getInt(int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the value at
indexif it exists and is an int or can be coerced to an int. - getInt(String) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the value mapped by
nameif it exists and is an int or can be coerced to an int. - getJSONArray(int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the value at
indexif it exists and is aJSONArray. - getJSONArray(String) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the value mapped by
nameif it exists and is aJSONArray. - getJSONObject(int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the value at
indexif it exists and is aJSONObject. - getJSONObject(String) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the value mapped by
nameif it exists and is aJSONObject. - getLong(int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the value at
indexif it exists and is a long or can be coerced to a long. - getLong(String) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the value mapped by
nameif it exists and is a long or can be coerced to a long. - 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 class 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.
- getString(int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the value at
indexif it exists, coercing it if necessary. - getString(String) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the value mapped by
nameif it exists, coercing it if necessary. - 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.
- has(String) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns true if this object has a mapping for
name. - hashCode() - Method in class org.springframework.boot.cli.json.JSONArray
- HelpCommand - Class in org.springframework.boot.cli.command.core
-
Internal
Commandused 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
HelpExampleinstance. - 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
Commandto 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
-
Commandthat 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.
- isNull(int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns true if this array has no value at
index, or if its value is thenullreference orJSONObject.NULL. - isNull(String) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns true if this object has no mapping for
nameor if it has a mapping whose value isJSONObject.NULL. - 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
J
- join(String) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns a new string by alternating this array's values with
separator. - JSONArray - Class in org.springframework.boot.cli.json
-
A dense indexed sequence of values.
- JSONArray() - Constructor for class org.springframework.boot.cli.json.JSONArray
-
Creates a
JSONArraywith no values. - JSONArray(Object) - Constructor for class org.springframework.boot.cli.json.JSONArray
-
Creates a new
JSONArraywith values from the given primitive array. - JSONArray(String) - Constructor for class org.springframework.boot.cli.json.JSONArray
-
Creates a new
JSONArraywith values from the JSON string. - JSONArray(Collection) - Constructor for class org.springframework.boot.cli.json.JSONArray
-
Creates a new
JSONArrayby copying all values from the given collection. - JSONArray(JSONTokener) - Constructor for class org.springframework.boot.cli.json.JSONArray
-
Creates a new
JSONArraywith values from the next array in the tokener. - JSONException - Exception Class in org.springframework.boot.cli.json
-
Thrown to indicate a problem with the JSON API.
- JSONException(String) - Constructor for exception class org.springframework.boot.cli.json.JSONException
- JSONObject - Class in org.springframework.boot.cli.json
-
A modifiable set of name/value mappings.
- JSONObject() - Constructor for class org.springframework.boot.cli.json.JSONObject
-
Creates a
JSONObjectwith no name/value mappings. - JSONObject(String) - Constructor for class org.springframework.boot.cli.json.JSONObject
-
Creates a new
JSONObjectwith name/value mappings from the JSON string. - JSONObject(Map) - Constructor for class org.springframework.boot.cli.json.JSONObject
-
Creates a new
JSONObjectby copying all name/value mappings from the given map. - JSONObject(JSONObject, String[]) - Constructor for class org.springframework.boot.cli.json.JSONObject
-
Creates a new
JSONObjectby copying mappings for the listed names from the given object. - JSONObject(JSONTokener) - Constructor for class org.springframework.boot.cli.json.JSONObject
-
Creates a new
JSONObjectwith name/value mappings from the next object in the tokener. - JSONStringer - Class in org.springframework.boot.cli.json
-
Implements
JSONObject.toString()andJSONArray.toString(). - JSONStringer() - Constructor for class org.springframework.boot.cli.json.JSONStringer
- JSONTokener - Class in org.springframework.boot.cli.json
-
Parses a JSON (RFC 4627) encoded string into the corresponding object.
- JSONTokener(String) - Constructor for class org.springframework.boot.cli.json.JSONTokener
K
- key(String) - Method in class org.springframework.boot.cli.json.JSONStringer
-
Encodes the key (property name) to this stringer.
- keys() - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns an iterator of the
Stringnames in this object.
L
- length() - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the number of values in this array.
- length() - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the number of name/value mappings in this object.
- 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
- more() - Method in class org.springframework.boot.cli.json.JSONTokener
N
- names() - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns an array containing the string names in this object.
- next() - Method in class org.springframework.boot.cli.json.JSONTokener
- next(char) - Method in class org.springframework.boot.cli.json.JSONTokener
- next(int) - Method in class org.springframework.boot.cli.json.JSONTokener
- nextClean() - Method in class org.springframework.boot.cli.json.JSONTokener
- nextString(char) - Method in class org.springframework.boot.cli.json.JSONTokener
-
Returns the string up to but not including
quote, unescaping any character escape sequences encountered along the way. - nextTo(char) - Method in class org.springframework.boot.cli.json.JSONTokener
- nextTo(String) - Method in class org.springframework.boot.cli.json.JSONTokener
- nextValue() - Method in class org.springframework.boot.cli.json.JSONTokener
-
Returns the next value from the input.
- NoHelpCommandArgumentsException - Exception Class in org.springframework.boot.cli.command
-
Exception used to when the help command is called without arguments.
- NoHelpCommandArgumentsException() - Constructor for exception class org.springframework.boot.cli.command.NoHelpCommandArgumentsException
- NoSuchCommandException - Exception Class in org.springframework.boot.cli.command
-
Exception used when a command is not found.
- NoSuchCommandException(String) - Constructor for exception class org.springframework.boot.cli.command.NoSuchCommandException
- NULL - Static variable in class org.springframework.boot.cli.json.JSONObject
-
A sentinel value used to explicitly define a name with no value.
- numberToString(Number) - Static method in class org.springframework.boot.cli.json.JSONObject
-
Encodes the number as a JSON string.
O
- object() - Method in class org.springframework.boot.cli.json.JSONStringer
-
Begins encoding a new object.
- OK - Static variable in class org.springframework.boot.cli.command.status.ExitStatus
-
Generic "OK" exit status with zero exit code and hangup=false.
- opt(int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the value at
index, or null if the array has no value atindex. - opt(String) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the value mapped by
name, or null if no such mapping exists. - optBoolean(int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the value at
indexif it exists and is a boolean or can be coerced to a boolean. - optBoolean(int, boolean) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the value at
indexif it exists and is a boolean or can be coerced to a boolean. - optBoolean(String) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the value mapped by
nameif it exists and is a boolean or can be coerced to a boolean. - optBoolean(String, boolean) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the value mapped by
nameif it exists and is a boolean or can be coerced to a boolean. - optDouble(int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the value at
indexif it exists and is a double or can be coerced to a double. - optDouble(int, double) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the value at
indexif it exists and is a double or can be coerced to a double. - optDouble(String) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the value mapped by
nameif it exists and is a double or can be coerced to a double. - optDouble(String, double) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the value mapped by
nameif it exists and is a double or can be coerced to a double. - optInt(int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the value at
indexif it exists and is an int or can be coerced to an int. - optInt(int, int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the value at
indexif it exists and is an int or can be coerced to an int. - optInt(String) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the value mapped by
nameif it exists and is an int or can be coerced to an int. - optInt(String, int) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the value mapped by
nameif it exists and is an int or can be coerced to an int. - 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
OptionParsingCommandto parse options and run the command. - OptionHandler() - Constructor for class org.springframework.boot.cli.command.options.OptionHandler
-
Create a new
OptionHandlerinstance. - OptionHandler(Function<String, String>) - Constructor for class org.springframework.boot.cli.command.options.OptionHandler
-
Create a new
OptionHandlerinstance 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
Commandthat parse options using anOptionHandler. - OptionParsingCommand(String, String, OptionHandler) - Constructor for class org.springframework.boot.cli.command.OptionParsingCommand
- options() - Method in class org.springframework.boot.cli.command.options.OptionHandler
- optJSONArray(int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the value at
indexif it exists and is aJSONArray. - optJSONArray(String) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the value mapped by
nameif it exists and is aJSONArray. - optJSONObject(int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the value at
indexif it exists and is aJSONObject. - optJSONObject(String) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the value mapped by
nameif it exists and is aJSONObject. - optLong(int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the value at
indexif it exists and is a long or can be coerced to a long. - optLong(int, long) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the value at
indexif it exists and is a long or can be coerced to a long. - optLong(String) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the value mapped by
nameif it exists and is a long or can be coerced to a long. - optLong(String, long) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the value mapped by
nameif it exists and is a long or can be coerced to a long. - optString(int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the value at
indexif it exists, coercing it if necessary. - optString(int, String) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns the value at
indexif it exists, coercing it if necessary. - optString(String) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the value mapped by
nameif it exists, coercing it if necessary. - optString(String, String) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns the value mapped by
nameif it exists, coercing it if necessary. - 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.json - package org.springframework.boot.cli.json
- 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
- 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.
- put(boolean) - Method in class org.springframework.boot.cli.json.JSONArray
-
Appends
valueto the end of this array. - put(double) - Method in class org.springframework.boot.cli.json.JSONArray
-
Appends
valueto the end of this array. - put(int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Appends
valueto the end of this array. - put(int, boolean) - Method in class org.springframework.boot.cli.json.JSONArray
-
Sets the value at
indextovalue, null padding this array to the required length if necessary. - put(int, double) - Method in class org.springframework.boot.cli.json.JSONArray
-
Sets the value at
indextovalue, null padding this array to the required length if necessary. - put(int, int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Sets the value at
indextovalue, null padding this array to the required length if necessary. - put(int, long) - Method in class org.springframework.boot.cli.json.JSONArray
-
Sets the value at
indextovalue, null padding this array to the required length if necessary. - put(int, Object) - Method in class org.springframework.boot.cli.json.JSONArray
-
Sets the value at
indextovalue, null padding this array to the required length if necessary. - put(long) - Method in class org.springframework.boot.cli.json.JSONArray
-
Appends
valueto the end of this array. - put(Object) - Method in class org.springframework.boot.cli.json.JSONArray
-
Appends
valueto the end of this array. - put(String, boolean) - Method in class org.springframework.boot.cli.json.JSONObject
-
Maps
nametovalue, clobbering any existing name/value mapping with the same name. - put(String, double) - Method in class org.springframework.boot.cli.json.JSONObject
-
Maps
nametovalue, clobbering any existing name/value mapping with the same name. - put(String, int) - Method in class org.springframework.boot.cli.json.JSONObject
-
Maps
nametovalue, clobbering any existing name/value mapping with the same name. - put(String, long) - Method in class org.springframework.boot.cli.json.JSONObject
-
Maps
nametovalue, clobbering any existing name/value mapping with the same name. - put(String, Object) - Method in class org.springframework.boot.cli.json.JSONObject
-
Maps
nametovalue, clobbering any existing name/value mapping with the same name. - putOpt(String, Object) - Method in class org.springframework.boot.cli.json.JSONObject
-
Equivalent to
put(name, value)when both parameters are non-null; does nothing otherwise.
Q
- quote(String) - Static method in class org.springframework.boot.cli.json.JSONObject
-
Encodes
dataas a JSON string.
R
- remove(int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Removes and returns the value at
index, or null if the array has no value atindex. - remove(String) - Method in class org.springframework.boot.cli.json.JSONObject
-
Removes the named mapping if it exists; does nothing otherwise.
- ReportableException - Exception Class in org.springframework.boot.cli.command.init
-
Exception with a message that can be reported to the user.
- ReportableException(String) - Constructor for exception class org.springframework.boot.cli.command.init.ReportableException
- ReportableException(String, Throwable) - Constructor for exception class 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
-
Commandto start a nested REPL shell. - ShellCommand() - Constructor for class org.springframework.boot.cli.command.shell.ShellCommand
- ShellExitException - Exception Class in org.springframework.boot.cli.command.shell
-
Exception used to stop the
Shell. - ShellExitException() - Constructor for exception class 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
- skipPast(String) - Method in class org.springframework.boot.cli.json.JSONTokener
- skipTo(char) - Method in class org.springframework.boot.cli.json.JSONTokener
- 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.
- syntaxError(String) - Method in class org.springframework.boot.cli.json.JSONTokener
-
Returns an exception containing the given message plus the current position and the entire input string.
T
- toJSONArray(JSONArray) - Method in class org.springframework.boot.cli.json.JSONObject
-
Returns an array with the values corresponding to
names. - toJSONObject(JSONArray) - Method in class org.springframework.boot.cli.json.JSONArray
-
Returns a new object whose values are the values in this array, and whose names are the values in
names. - toString() - Method in class org.springframework.boot.cli.command.status.ExitStatus
- toString() - Method in class org.springframework.boot.cli.json.JSONArray
-
Encodes this array as a compact JSON string, such as:
- toString() - Method in class org.springframework.boot.cli.json.JSONObject
-
Encodes this object as a compact JSON string, such as:
- toString() - Method in class org.springframework.boot.cli.json.JSONStringer
-
Returns the encoded JSON string.
- toString() - Method in class org.springframework.boot.cli.json.JSONTokener
-
Returns the current position and the entire input string.
- toString(int) - Method in class org.springframework.boot.cli.json.JSONArray
-
Encodes this array as a human-readable JSON string for debugging, such as:
- toString(int) - Method in class org.springframework.boot.cli.json.JSONObject
-
Encodes this object as a human-readable JSON string for debugging, such as:
V
- value(boolean) - Method in class org.springframework.boot.cli.json.JSONStringer
-
Encodes
valueto this stringer. - value(double) - Method in class org.springframework.boot.cli.json.JSONStringer
-
Encodes
valueto this stringer. - value(long) - Method in class org.springframework.boot.cli.json.JSONStringer
-
Encodes
valueto this stringer. - value(Object) - Method in class org.springframework.boot.cli.json.JSONStringer
-
Encodes
value. - 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
-
Commandto display the 'version' number. - VersionCommand() - Constructor for class org.springframework.boot.cli.command.core.VersionCommand
W
- wrap(Object) - Static method in class org.springframework.boot.cli.json.JSONObject
-
Wraps the given object if necessary.
All Classes and Interfaces|All Packages|Serialized Form