org.apache.hadoop.hbase.util

类 AbstractHBaseTool

java.lang.Object

org.apache.hadoop.hbase.util.AbstractHBaseTool

所有已实现的接口:

org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool

@InterfaceAudience.Private
public abstract class AbstractHBaseTool
extends Object
implements org.apache.hadoop.util.Tool

Common base class used for HBase command-line tools. Simplifies workflow and command-line argument parsing.

字段概要

字段

限定符和类型	字段和说明
protected String[]	cmdLineArgs
protected org.apache.hadoop.conf.Configuration	conf
protected static int	EXIT_FAILURE
protected static int	EXIT_SUCCESS

构造器概要

构造器

构造器和说明
AbstractHBaseTool()

方法概要

方法

限定符和类型	方法和说明
protected void	addOption(org.apache.commons.cli.Option option)
protected abstract void	addOptions() Override this to add command-line options using addOptWithArg(java.lang.String, java.lang.String) and similar methods.
protected void	addOptNoArg(String opt, String description)
protected void	addOptNoArg(String shortOpt, String longOpt, String description)
protected void	addOptWithArg(String opt, String description)
protected void	addOptWithArg(String shortOpt, String longOpt, String description)
protected void	addRequiredOptWithArg(String opt, String description)
protected void	addRequiredOptWithArg(String shortOpt, String longOpt, String description)
protected void	doStaticMain(String[] args) Call this from the concrete tool class's main function.
protected abstract int	doWork() The "main function" of the tool
org.apache.hadoop.conf.Configuration	getConf()
double	getOptionAsDouble(org.apache.commons.cli.CommandLine cmd, String opt, double defaultValue)
int	getOptionAsInt(org.apache.commons.cli.CommandLine cmd, String opt, int defaultValue)
static int	parseInt(String s, int minValue, int maxValue)
static long	parseLong(String s, long minValue, long maxValue) Parse a number and enforce a range.
protected void	printUsage()
protected void	printUsage(String usageStr, String usageHeader, String usageFooter)
protected abstract void	processOptions(org.apache.commons.cli.CommandLine cmd) This method is called to process the options after they have been parsed.
int	run(String[] args)
void	setConf(org.apache.hadoop.conf.Configuration conf)

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

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

字段详细资料

EXIT_SUCCESS

protected static final int EXIT_SUCCESS

另请参阅:

常量字段值

EXIT_FAILURE

protected static final int EXIT_FAILURE

另请参阅:

常量字段值

conf

protected org.apache.hadoop.conf.Configuration conf

cmdLineArgs

protected String[] cmdLineArgs

构造器详细资料

AbstractHBaseTool

public AbstractHBaseTool()

方法详细资料

addOptions

protected abstract void addOptions()

Override this to add command-line options using addOptWithArg(java.lang.String, java.lang.String) and similar methods.

processOptions

protected abstract void processOptions(org.apache.commons.cli.CommandLine cmd)

This method is called to process the options after they have been parsed.

doWork

protected abstract int doWork()
                       throws Exception

The "main function" of the tool

抛出:

Exception

getConf

public org.apache.hadoop.conf.Configuration getConf()

指定者:

getConf 在接口中 org.apache.hadoop.conf.Configurable

setConf

public void setConf(org.apache.hadoop.conf.Configuration conf)

指定者:

setConf 在接口中 org.apache.hadoop.conf.Configurable

run

public final int run(String[] args)
              throws IOException

指定者:

run 在接口中 org.apache.hadoop.util.Tool

抛出:

IOException

printUsage

protected void printUsage()

printUsage

protected void printUsage(String usageStr,
              String usageHeader,
              String usageFooter)

addOption

protected void addOption(org.apache.commons.cli.Option option)

addRequiredOptWithArg

protected void addRequiredOptWithArg(String opt,
                         String description)

addRequiredOptWithArg

protected void addRequiredOptWithArg(String shortOpt,
                         String longOpt,
                         String description)

addOptNoArg

protected void addOptNoArg(String opt,
               String description)

addOptNoArg

protected void addOptNoArg(String shortOpt,
               String longOpt,
               String description)

addOptWithArg

protected void addOptWithArg(String opt,
                 String description)

addOptWithArg

protected void addOptWithArg(String shortOpt,
                 String longOpt,
                 String description)

getOptionAsInt

public int getOptionAsInt(org.apache.commons.cli.CommandLine cmd,
                 String opt,
                 int defaultValue)

getOptionAsDouble

public double getOptionAsDouble(org.apache.commons.cli.CommandLine cmd,
                       String opt,
                       double defaultValue)

parseLong

public static long parseLong(String s,
             long minValue,
             long maxValue)

Parse a number and enforce a range.

parseInt

public static int parseInt(String s,
           int minValue,
           int maxValue)

doStaticMain

protected void doStaticMain(String[] args)

Call this from the concrete tool class's main function.