Package org.elasticsearch.cli
Class MultiCommand
- java.lang.Object
-
- org.elasticsearch.cli.Command
-
- org.elasticsearch.cli.MultiCommand
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
public class MultiCommand extends Command
A cli tool which is made up of multiple subcommands.
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Map<java.lang.String,Command>
subcommands
-
Fields inherited from class org.elasticsearch.cli.Command
description, parser
-
-
Constructor Summary
Constructors Constructor Description MultiCommand(java.lang.String description, java.lang.Runnable beforeMain)
Construct the multi-command with the specified command description and runnable to execute before main is invoked.
-
Method Summary
Modifier and Type Method Description void
close()
protected void
execute(Terminal terminal, joptsimple.OptionSet options)
Executes this command.protected void
printAdditionalHelp(Terminal terminal)
Prints additional help information, specific to the command-
Methods inherited from class org.elasticsearch.cli.Command
addShutdownHook, exit, main
-
-
-
-
Field Detail
-
subcommands
protected final java.util.Map<java.lang.String,Command> subcommands
-
-
Constructor Detail
-
MultiCommand
public MultiCommand(java.lang.String description, java.lang.Runnable beforeMain)
Construct the multi-command with the specified command description and runnable to execute before main is invoked.- Parameters:
description
- the multi-command descriptionbeforeMain
- the before-main runnable
-
-
Method Detail
-
printAdditionalHelp
protected void printAdditionalHelp(Terminal terminal)
Description copied from class:Command
Prints additional help information, specific to the command- Overrides:
printAdditionalHelp
in classCommand
-
execute
protected void execute(Terminal terminal, joptsimple.OptionSet options) throws java.lang.Exception
Description copied from class:Command
Executes this command. Any runtime user errors (like an input file that does not exist), should throw aUserException
.
-
-