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

Direct Known Subclasses:

KeyStoreCli, TranslogToolCli

public class MultiCommand
extends Command

A cli tool which is made up of multiple subcommands.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,Command>	subcommands

Fields inherited from class org.elasticsearch.cli.Command

description, parser

Constructor Summary

Constructors

Constructor and Description
MultiCommand(java.lang.String description)

Method Summary

Modifier and Type	Method and Description
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, close, exit, main, shouldConfigureLoggingWithoutConfig

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

subcommands

protected final java.util.Map<java.lang.String,Command> subcommands

Constructor Detail

MultiCommand

public MultiCommand(java.lang.String description)

Method Detail

printAdditionalHelp

protected void printAdditionalHelp(Terminal terminal)

Description copied from class: Command

Prints additional help information, specific to the command

Overrides:

printAdditionalHelp in class Command

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 a UserException.

Specified by:

execute in class Command

Throws:

java.lang.Exception