org.apache.hadoop.hbase.shell
Class HelpCommand

java.lang.Object
  extended by org.apache.hadoop.hbase.shell.BasicCommand
      extended by org.apache.hadoop.hbase.shell.HelpCommand
All Implemented Interfaces:
Command, CommandFactory

public class HelpCommand
extends BasicCommand


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.shell.Command
Command.CommandType
 
Field Summary
static String APP_NAME
          application name
static String APP_VERSION
          version of the code
 Map<String,String[]> help
          help contents map
 
Fields inherited from class org.apache.hadoop.hbase.shell.BasicCommand
LINE_SEPARATOR
 
Fields inherited from interface org.apache.hadoop.hbase.shell.Command
FAMILY_INDICATOR
 
Constructor Summary
HelpCommand(Writer o, TableFormatter f)
           
 
Method Summary
 ReturnMsg execute(Configuration conf)
          Execute a command
static void main(String[] args)
           
 void printHelp(String cmd)
           
 void printVersion()
          Print out the program version.
 void setArgument(String argument)
           
 
Methods inherited from class org.apache.hadoop.hbase.shell.BasicCommand
appendDelimiter, extractErrMsg, extractErrMsg, getBasicCommand, getCommand, getCommandType, getOut, print, println
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

APP_NAME

public static final String APP_NAME
application name

See Also:
Constant Field Values

APP_VERSION

public static final String APP_VERSION
version of the code

See Also:
Constant Field Values

help

public final Map<String,String[]> help
help contents map

Constructor Detail

HelpCommand

public HelpCommand(Writer o,
                   TableFormatter f)
Method Detail

execute

public ReturnMsg execute(Configuration conf)
Description copied from interface: Command
Execute a command

Parameters:
conf - Configuration
Returns:
Result of command execution

setArgument

public void setArgument(String argument)

printVersion

public void printVersion()
                  throws IOException
Print out the program version.

Throws:
IOException

printHelp

public void printHelp(String cmd)
               throws IOException
Throws:
IOException

main

public static void main(String[] args)
                 throws UnsupportedEncodingException
Throws:
UnsupportedEncodingException


Copyright © 2006 The Apache Software Foundation