Index

A C D E F G I M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addShutdownHook() - Method in class org.elasticsearch.cli.Command

Return whether or not to install the shutdown hook to cleanup resources on exit.

C

CANT_CREATE - Static variable in class org.elasticsearch.cli.ExitCodes

close() - Method in class org.elasticsearch.cli.Command

close() - Method in class org.elasticsearch.cli.MultiCommand

CODE_ERROR - Static variable in class org.elasticsearch.cli.ExitCodes

Command - Class in org.elasticsearch.cli

An action to execute within a cli.

Command(String, Runnable) - Constructor for class org.elasticsearch.cli.Command

Construct the command with the specified command description and runnable to execute before main is invoked.

CONFIG - Static variable in class org.elasticsearch.cli.ExitCodes

D

DATA_ERROR - Static variable in class org.elasticsearch.cli.ExitCodes

DEFAULT - Static variable in class org.elasticsearch.cli.Terminal

The default terminal implementation, which will be a console if available, or stdout/stderr if not.

description - Variable in class org.elasticsearch.cli.Command

A description of the command, used in the help output.

E

errorPrint(Terminal.Verbosity, String) - Method in class org.elasticsearch.cli.Terminal

Prints a line to the terminal's standard error at Terminal.Verbosity.NORMAL verbosity level, without a newline.

errorPrintln(String) - Method in class org.elasticsearch.cli.Terminal

Prints a line to the terminal's standard error at Terminal.Verbosity.NORMAL verbosity level.

errorPrintln(Terminal.Verbosity, String) - Method in class org.elasticsearch.cli.Terminal

Prints a line to the terminal's standard error at verbosity level.

execute(Terminal, OptionSet) - Method in class org.elasticsearch.cli.Command

Executes this command.

execute(Terminal, OptionSet) - Method in class org.elasticsearch.cli.MultiCommand

exit(int) - Static method in class org.elasticsearch.cli.Command

exitCode - Variable in exception org.elasticsearch.cli.UserException

The exist status the cli should use when catching this user error.

ExitCodes - Class in org.elasticsearch.cli

POSIX exit codes.

F

flush() - Method in class org.elasticsearch.cli.Terminal

G

getErrorWriter() - Method in class org.elasticsearch.cli.Terminal

Returns a Writer which can be used to write to the terminal directly using standard error.

getOutputStream() - Method in class org.elasticsearch.cli.Terminal

Returns an OutputStream which can be used to write to the terminal directly using standard output.

getWriter() - Method in class org.elasticsearch.cli.Terminal

Returns a Writer which can be used to write to the terminal directly using standard output.

I

IO_ERROR - Static variable in class org.elasticsearch.cli.ExitCodes

isHeadless() - Method in class org.elasticsearch.cli.Terminal

Indicates whether this terminal is for a headless system i.e.

isPrintable(Terminal.Verbosity) - Method in class org.elasticsearch.cli.Terminal

Checks if is enough verbosity level to be printed

M

main(String[], Terminal) - Method in class org.elasticsearch.cli.Command

Parses options for this command from args and executes it.

MultiCommand - Class in org.elasticsearch.cli

A cli tool which is made up of multiple subcommands.

MultiCommand(String, Runnable) - Constructor for class org.elasticsearch.cli.MultiCommand

Construct the multi-command with the specified command description and runnable to execute before main is invoked.

N

NO_HOST - Static variable in class org.elasticsearch.cli.ExitCodes

NO_INPUT - Static variable in class org.elasticsearch.cli.ExitCodes

NO_USER - Static variable in class org.elasticsearch.cli.ExitCodes

NOPERM - Static variable in class org.elasticsearch.cli.ExitCodes

NORMAL - Enum constant in enum class org.elasticsearch.cli.Terminal.Verbosity

O

OK - Static variable in class org.elasticsearch.cli.ExitCodes

org.elasticsearch.cli - package org.elasticsearch.cli

P

parser - Variable in class org.elasticsearch.cli.Command

The option parser for this command.

print(Terminal.Verbosity, String) - Method in class org.elasticsearch.cli.Terminal

Prints message to the terminal's standard output at verbosity level, without a newline.

print(Terminal.Verbosity, String, boolean) - Method in class org.elasticsearch.cli.Terminal

Prints message to the terminal at verbosity level, without a newline.

printAdditionalHelp(Terminal) - Method in class org.elasticsearch.cli.Command

Prints additional help information, specific to the command

printAdditionalHelp(Terminal) - Method in class org.elasticsearch.cli.MultiCommand

println(CharSequence) - Method in class org.elasticsearch.cli.Terminal

Prints a line to the terminal at Terminal.Verbosity.NORMAL verbosity level.

println(Terminal.Verbosity, CharSequence) - Method in class org.elasticsearch.cli.Terminal

Prints a line to the terminal at verbosity level.

printUserException(Terminal, UserException) - Method in class org.elasticsearch.cli.Command

printUserException(Terminal, UserException) - Method in class org.elasticsearch.cli.MultiCommand

promptYesNo(String, boolean) - Method in class org.elasticsearch.cli.Terminal

Prompt for a yes or no answer from the user.

PROTOCOL - Static variable in class org.elasticsearch.cli.ExitCodes

R

readLineToCharArray(Reader, int) - Static method in class org.elasticsearch.cli.Terminal

Read from the reader until we find a newline.

readSecret(String) - Method in class org.elasticsearch.cli.Terminal

Reads password text from the terminal input.

readSecret(String, int) - Method in class org.elasticsearch.cli.Terminal

Read password text form terminal input up to a maximum length.

readText(String) - Method in class org.elasticsearch.cli.Terminal

Reads clear text from the terminal input.

reason() - Element in annotation interface org.elasticsearch.cli.SuppressForbidden

S

setVerbosity(Terminal.Verbosity) - Method in class org.elasticsearch.cli.Terminal

Sets the verbosity of the terminal.

SILENT - Enum constant in enum class org.elasticsearch.cli.Terminal.Verbosity

subcommands - Variable in class org.elasticsearch.cli.MultiCommand

SuppressForbidden - Annotation Interface in org.elasticsearch.cli

Annotation to suppress forbidden-apis errors inside a whole class, a method, or a field.

T

TEMP_FAILURE - Static variable in class org.elasticsearch.cli.ExitCodes

Terminal - Class in org.elasticsearch.cli

A Terminal wraps access to reading input and writing output for a cli.

Terminal(String) - Constructor for class org.elasticsearch.cli.Terminal

Terminal.Verbosity - Enum Class in org.elasticsearch.cli

Defines the available verbosity levels of messages to be printed.

U

UNAVAILABLE - Static variable in class org.elasticsearch.cli.ExitCodes

USAGE - Static variable in class org.elasticsearch.cli.ExitCodes

UserException - Exception in org.elasticsearch.cli

An exception representing a user fixable problem in Command usage.

UserException(int, String) - Constructor for exception org.elasticsearch.cli.UserException

Constructs a UserException with an exit status and message to show the user.

UserException(int, String, Throwable) - Constructor for exception org.elasticsearch.cli.UserException

Constructs a new user exception with specified exit status, message, and underlying cause.

V

valueOf(String) - Static method in enum class org.elasticsearch.cli.Terminal.Verbosity

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

values() - Static method in enum class org.elasticsearch.cli.Terminal.Verbosity

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

VERBOSE - Enum constant in enum class org.elasticsearch.cli.Terminal.Verbosity

A C D E F G I M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form