AbstractHBaseTool (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.util.AbstractHBaseTool

All Implemented Interfaces:

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

Direct Known Subclasses:

CreateSnapshot
```
@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.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String[]`	`cmdLineArgs`
`protected org.apache.hadoop.conf.Configuration`	`conf`
`protected static int`	`EXIT_FAILURE`
`protected static int`	`EXIT_SUCCESS`
`private static org.apache.commons.cli.Option`	`HELP_OPTION`
`private static org.apache.commons.logging.Log`	`LOG`
`private org.apache.commons.cli.Options`	`options`

Constructor Summary

Constructors
Constructor and Description

AbstractHBaseTool()

Constructors
Constructor and Description
`AbstractHBaseTool()`

Method Summary

Methods
Modifier and Type	Method and Description
`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)`
`private boolean`	`isHelpCommand(String[] args)`
`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)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXIT_SUCCESS
```
protected static final int EXIT_SUCCESS
```
See Also:
Constant Field Values

EXIT_FAILURE
```
protected static final int EXIT_FAILURE
```
See Also:
Constant Field Values

HELP_OPTION

private static final org.apache.commons.cli.Option HELP_OPTION

LOG

private static final org.apache.commons.logging.Log LOG

options

private final org.apache.commons.cli.Options options

conf

protected org.apache.hadoop.conf.Configuration conf

cmdLineArgs
```
protected String[] cmdLineArgs
```

Constructor Detail
- AbstractHBaseTool
```
public AbstractHBaseTool()
```

Method Detail

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

Throws:: Exception

getConf
```
public org.apache.hadoop.conf.Configuration getConf()
```
Specified by:

getConf in interface org.apache.hadoop.conf.Configurable

setConf
```
public void setConf(org.apache.hadoop.conf.Configuration conf)
```
Specified by:

setConf in interface org.apache.hadoop.conf.Configurable

run
```
public final int run(String[] args)
              throws IOException
```
Specified by:

run in interface org.apache.hadoop.util.Tool

Throws:

IOException

isHelpCommand

private boolean isHelpCommand(String[] args)
                       throws org.apache.commons.cli.ParseException

Throws:: org.apache.commons.cli.ParseException

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.

Class AbstractHBaseTool

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXIT_SUCCESS

EXIT_FAILURE

HELP_OPTION

LOG

options

conf

cmdLineArgs

Constructor Detail

AbstractHBaseTool

Method Detail

addOptions

processOptions

doWork

getConf

setConf

run

isHelpCommand

printUsage

printUsage

addOption

addRequiredOptWithArg

addRequiredOptWithArg

addOptNoArg

addOptNoArg

addOptWithArg

addOptWithArg

getOptionAsInt

getOptionAsDouble

parseLong

parseInt

doStaticMain