org.apache.ratis.shell.cli

类 AbstractShell

java.lang.Object

org.apache.ratis.shell.cli.AbstractShell

所有已实现的接口:

Closeable, AutoCloseable

直接已知子类:

RatisShell

public abstract class AbstractShell
extends Object
implements Closeable

Abstract class for handling command line inputs.

构造器概要

构造器

限定符	构造器和说明
protected	AbstractShell(Context context) Creates a new instance of AbstractShell.

方法概要

限定符和类型	方法和说明
void	close()
protected org.apache.ratis.thirdparty.com.google.common.io.Closer	getCloser()
Collection<Command>	getCommands()
protected abstract String	getShellName()
protected abstract Map<String,Command>	loadCommands(Context context) Map structure: Command name => Command instance.
protected void	printUsage() Prints usage for all commands.
int	run(String... argv) Handles the specified shell command request, displaying usage if the command format is invalid.

从类继承的方法 java.lang.Object

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

构造器详细资料

AbstractShell

protected AbstractShell(Context context)

Creates a new instance of AbstractShell.

方法详细资料

run

public int run(String... argv)

Handles the specified shell command request, displaying usage if the command format is invalid.

参数:

argv - [] Array of arguments given by the user's input from the terminal

返回:

0 if command is successful, -1 if an error occurred

getCommands

public Collection<Command> getCommands()

返回:

all commands provided by this shell

close

public void close()
           throws IOException

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

抛出:

IOException

getShellName

protected abstract String getShellName()

返回:

name of the shell

loadCommands

protected abstract Map<String,Command> loadCommands(Context context)

Map structure: Command name => Command instance.

返回:

a set of commands which can be executed under this shell

getCloser

protected org.apache.ratis.thirdparty.com.google.common.io.Closer getCloser()

printUsage

protected void printUsage()

Prints usage for all commands.