alluxio.cli.table.command

Class AbstractTableCommand

java.lang.Object

alluxio.cli.table.command.AbstractTableCommand

All Implemented Interfaces:

Command, Closeable, AutoCloseable

Direct Known Subclasses:

AttachDatabaseCommand, DetachDatabaseCommand, ListDatabasesCommand, SyncDatabaseCommand, TransformStatusCommand, TransformTableCommand

public abstract class AbstractTableCommand
extends Object
implements Command

A class which should be extended when implementing commands for the TableShell.

Field Summary

Fields

Modifier and Type	Field and Description
protected TableMasterClient	mClient
protected AlluxioConfiguration	mConf

Constructor Summary

Constructors

Constructor and Description
AbstractTableCommand(AlluxioConfiguration conf, TableMasterClient client) Creates a new instance of AbstractTableCommand.

Method Summary

Modifier and Type	Method and Description
abstract String	getCommandName() Gets the command name as input from the shell.
abstract int	run(org.apache.commons.cli.CommandLine cl) Runs the command.
abstract void	validateArgs(org.apache.commons.cli.CommandLine cl) Checks if the arguments are valid or throw InvalidArgumentException.

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.cli.Command

close, getDescription, getOptions, getSubCommands, getUsage, hasSubCommand, parseAndValidateArgs

Field Detail

mConf

protected final AlluxioConfiguration mConf

mClient

protected final TableMasterClient mClient

Constructor Detail

AbstractTableCommand

public AbstractTableCommand(AlluxioConfiguration conf,
                            TableMasterClient client)

Creates a new instance of AbstractTableCommand.

Parameters:

conf - the alluxio configuration

client - the client interface which can be used to make RPCs against the table master

Method Detail

getCommandName

public abstract String getCommandName()

Description copied from interface: Command

Gets the command name as input from the shell.

Specified by:

getCommandName in interface Command

Returns:

the command name

validateArgs

public abstract void validateArgs(org.apache.commons.cli.CommandLine cl)
                           throws InvalidArgumentException

Description copied from interface: Command

Checks if the arguments are valid or throw InvalidArgumentException.

Specified by:

validateArgs in interface Command

Parameters:

cl - the parsed command line for the arguments

Throws:

InvalidArgumentException - when arguments are not valid

run

public abstract int run(org.apache.commons.cli.CommandLine cl)
                 throws AlluxioException,
                        IOException

Description copied from interface: Command

Runs the command.

Specified by:

run in interface Command

Parameters:

cl - the parsed command line for the arguments

Returns:

the result of running the command

Throws:

AlluxioException

IOException