Module org.elasticsearch.cli

Package org.elasticsearch.cli

Class MultiCommand

java.lang.Object

org.elasticsearch.cli.Command

org.elasticsearch.cli.MultiCommand

All Implemented Interfaces:

Closeable, 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 final Map<String,Command>	subcommands

Fields inherited from class org.elasticsearch.cli.Command

description, parser

Constructor Summary

Constructors

Constructor	Description
MultiCommand(String description)	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, ProcessInfo processInfo)	Executes this command.
protected void	printAdditionalHelp(Terminal terminal)	Prints additional help information, specific to the command
protected void	printUserException(Terminal terminal, UserException e)

Methods inherited from class org.elasticsearch.cli.Command

exit, main, mainWithoutErrorHandling, parseOptions

Methods inherited from class java.lang.Object

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

Field Details

subcommands

protected final Map<String,Command> subcommands

Constructor Details

MultiCommand

public MultiCommand(String description)

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

Parameters:

description - the multi-command description

Method Details

printAdditionalHelp

protected void printAdditionalHelp(Terminal terminal)

Description copied from class: Command

Prints additional help information, specific to the command

Overrides:

printAdditionalHelp in class Command

printUserException

protected void printUserException(Terminal terminal,
 UserException e)

Overrides:

printUserException in class Command

execute

protected void execute(Terminal terminal,
 joptsimple.OptionSet options,
 ProcessInfo processInfo)
                throws 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:

Exception

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class Command

Throws:

IOException