org.elasticsearch.common.cli

Class CliTool

java.lang.Object

org.elasticsearch.common.cli.CliTool

Direct Known Subclasses:

PluginManagerCliParser

public abstract class CliTool
extends Object

A base class for command-line interface tool. Two modes are supported: - Single command mode. The tool exposes a single command that can potentially accept arguments (eg. CLI options). - Multi command mode. The tool support multiple commands, each for different tasks, each potentially accepts arguments. In a multi-command mode. The first argument must be the command name. For example, the plugin manager can be seen as a multi-command tool with two possible commands: install and uninstall The tool is configured using a CliToolConfig which encapsulates the tool's commands and their potential options. The tool also comes with out of the box simple help support (the -h/--help option is automatically handled) where the help text is configured in a dedicated *.help files located in the same package as the tool.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CliTool.Command
static class	CliTool.ExitStatus

Field Summary

Fields

Modifier and Type	Field and Description
protected Environment	env
protected Settings	settings
protected Terminal	terminal

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CliTool(CliToolConfig config)
protected	CliTool(CliToolConfig config, Terminal terminal)

Method Summary

Modifier and Type	Method and Description
CliTool.ExitStatus	execute(String... args)
protected static CliTool.Command.Exit	exitCmd(CliTool.ExitStatus status)
protected static CliTool.Command.Exit	exitCmd(CliTool.ExitStatus status, Terminal terminal, String msg, Object... args)
protected CliTool.Command.Help	helpCmd(CliToolConfig.Cmd cmd)
CliTool.Command	parse(CliToolConfig.Cmd cmd, String[] args)
protected abstract CliTool.Command	parse(String cmdName, org.apache.commons.cli.CommandLine cli)
CliTool.Command	parse(String cmdName, String[] args)

Methods inherited from class java.lang.Object

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

Field Detail

terminal

protected final Terminal terminal

env

protected final Environment env

settings

protected final Settings settings

Constructor Detail

CliTool

protected CliTool(CliToolConfig config)

CliTool

protected CliTool(CliToolConfig config,
                  Terminal terminal)

Method Detail

execute

public final CliTool.ExitStatus execute(String... args)

parse

public CliTool.Command parse(String cmdName,
                             String[] args)
                      throws Exception

Throws:

Exception

parse

public CliTool.Command parse(CliToolConfig.Cmd cmd,
                             String[] args)
                      throws Exception

Throws:

Exception

helpCmd

protected CliTool.Command.Help helpCmd(CliToolConfig.Cmd cmd)

exitCmd

protected static CliTool.Command.Exit exitCmd(CliTool.ExitStatus status)

exitCmd

protected static CliTool.Command.Exit exitCmd(CliTool.ExitStatus status,
                                              Terminal terminal,
                                              String msg,
                                              Object... args)

parse

protected abstract CliTool.Command parse(String cmdName,
                                         org.apache.commons.cli.CommandLine cli)
                                  throws Exception

Throws:

Exception