alluxio.cli

Class AbstractShell

java.lang.Object

alluxio.cli.AbstractShell

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

CollectInfo, ExtensionsShell, FileSystemAdminShell, FileSystemShell, JobShell, TableShell

@NotThreadSafe
public abstract class AbstractShell
extends Object
implements Closeable

Abstract class for handling command line inputs.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.common.io.Closer	mCloser
protected AlluxioConfiguration	mConfiguration

Constructor Summary

Constructors

Constructor and Description
AbstractShell(Map<String,String[]> commandAlias, Set<String> unstableAlias, AlluxioConfiguration conf) Creates a new instance of AbstractShell.

Method Summary

Modifier and Type	Method and Description
void	close()
Collection<Command>	getCommands()
protected abstract String	getShellName()
protected abstract Map<String,Command>	loadCommands() 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.

Methods inherited from class java.lang.Object

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

Field Detail

mConfiguration

protected final AlluxioConfiguration mConfiguration

mCloser

protected final com.google.common.io.Closer mCloser

Constructor Detail

AbstractShell

public AbstractShell(Map<String,String[]> commandAlias,
                     Set<String> unstableAlias,
                     AlluxioConfiguration conf)

Creates a new instance of AbstractShell.

Parameters:

commandAlias - replacements for commands

unstableAlias - set of unstable aliases which may be removed in the future

conf - Alluxio configuration

Method Detail

run

public int run(String... argv)

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

Parameters:

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

Returns:

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

getCommands

public Collection<Command> getCommands()

Returns:

all commands provided by this shell

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getShellName

protected abstract String getShellName()

Returns:

name of the shell

loadCommands

protected abstract Map<String,Command> loadCommands()

Map structure: Command name => Command instance.

Returns:

a set of commands which can be executed under this shell

printUsage

protected void printUsage()

Prints usage for all commands.