org.apache.samza.sql.client.impl

Enum CliCommandType

java.lang.Object

java.lang.Enum<CliCommandType>

org.apache.samza.sql.client.impl.CliCommandType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CliCommandType>, CommandType

public enum CliCommandType
extends java.lang.Enum<CliCommandType>
implements CommandType

Enum all the commands we now support along with descriptions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLEAR
DESCRIBE
EXECUTE
EXIT
HELP
INSERT_INTO
INVALID_COMMAND
LS
QUIT
RM
SELECT
SET
SHOW_FUNCTIONS
SHOW_TABLES
STOP
VERSION

Method Summary

Modifier and Type	Method and Description
boolean	argsAreOptional() gets the argsAreOptional flag
static java.util.List<java.lang.String>	getAllCommands() static API to return all commands in this enumeration
java.lang.String	getCommandName() Gets the command name
java.lang.String	getDescription() gets the command description
java.lang.String	getUsage() gets the command usage
static CliCommandType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CliCommandType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SHOW_TABLES

public static final CliCommandType SHOW_TABLES

SHOW_FUNCTIONS

public static final CliCommandType SHOW_FUNCTIONS

DESCRIBE

public static final CliCommandType DESCRIBE

SELECT

public static final CliCommandType SELECT

EXECUTE

public static final CliCommandType EXECUTE

INSERT_INTO

public static final CliCommandType INSERT_INTO

LS

public static final CliCommandType LS

STOP

public static final CliCommandType STOP

RM

public static final CliCommandType RM

HELP

public static final CliCommandType HELP

SET

public static final CliCommandType SET

CLEAR

public static final CliCommandType CLEAR

EXIT

public static final CliCommandType EXIT

QUIT

public static final CliCommandType QUIT

VERSION

public static final CliCommandType VERSION

INVALID_COMMAND

public static final CliCommandType INVALID_COMMAND

Method Detail

values

public static CliCommandType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CliCommandType c : CliCommandType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CliCommandType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getAllCommands

public static java.util.List<java.lang.String> getAllCommands()

static API to return all commands in this enumeration

Specified by:

getAllCommands in interface CommandType

Returns:

list of all commands' names

getCommandName

public java.lang.String getCommandName()

Gets the command name

Specified by:

getCommandName in interface CommandType

Returns:

string

getDescription

public java.lang.String getDescription()

gets the command description

Specified by:

getDescription in interface CommandType

Returns:

string

getUsage

public java.lang.String getUsage()

gets the command usage

Specified by:

getUsage in interface CommandType

Returns:

string

argsAreOptional

public boolean argsAreOptional()

gets the argsAreOptional flag

Specified by:

argsAreOptional in interface CommandType

Returns:

true if args are optional, false o.w.