Config (Asynchronous HBase Client 1.8.0 API)

java.lang.Object
- org.hbase.async.Config

```
public class Config
extends Object
```
A configuration class that stores key/value pairs as strings similar to the System properties object. The class includes helper methods to parse the strings into numbers or booleans and it allows for loading a standard Java properties file from disk. The loadSystemAndDefaults will be called to set defaults and optionally load values from the System properties list.
Note that multiple threads can read from this config object but modifying values is not thread safe.

Since:

1.7.0

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`config_location` Tracks the location of the file that was actually loaded
`protected HashMap<String,String>`	`default_map` Holds default values for the config
`protected HashMap<String,String>`	`properties` The list of properties configured to their defaults or modified by users.
`static boolean`	`RUNNING_WINDOWS` Flag to determine if we're running under Windows or not

Constructor Summary

Constructors
Constructor and Description
`Config()` Constructor that initializes default configuration values from the System.properties map.
`Config(Config parent)` Constructor for subclasses who want a copy of the parent config but without the ability to modify the original values.
`Config(String file)` Constructor that initializes default values and attempts to load the given properties file

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`dumpConfiguration()` Returns a simple string with the configured properties for debugging.
`boolean`	`getBoolean(String property)` Returns the given property as a boolean Property values are case insensitive and the following values will result in a True return value: - 1 - True - Yes Any other values, including an empty string, will result in a False
`String`	`getDirectoryName(String property)` Returns the directory name, making sure the end is an OS dependent slash
`double`	`getDouble(String property)` Returns the given property as a double
`float`	`getFloat(String property)` Returns the given property as a float
`int`	`getInt(String property)` Returns the given property as an integer
`long`	`getLong(String property)` Returns the given property as a long
`Map<String,String>`	`getMap()`
`short`	`getShort(String property)` Returns the given property as a short
`String`	`getString(String property)` Returns the given property as a String
`boolean`	`hasProperty(String property)` Determines if the given property is in the map
`protected void`	`loadConfig(String file)` Attempts to load the configuration from the given location
`void`	`overrideConfig(String property, String value)` Allows for modifying properties after loading WARNING: This should only be used on initialization of the config object and it is not thread safe.

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

- Field Detail
  - RUNNING_WINDOWS
```
public static final boolean RUNNING_WINDOWS
```
    Flag to determine if we're running under Windows or not
  - properties
```
protected final HashMap<String,String> properties
```
    The list of properties configured to their defaults or modified by users. We use a non-synchronized hash map for fast access as opposed to the HashTable backed properties objects.
  - default_map
```
protected final HashMap<String,String> default_map
```
    Holds default values for the config
  - config_location
```
protected String config_location
```
    Tracks the location of the file that was actually loaded
- Constructor Detail
  - Config
```
public Config()
```
    Constructor that initializes default configuration values from the System.properties map.
  - Config
```
public Config(String file)
       throws IOException
```
    Constructor that initializes default values and attempts to load the given properties file
    
    Parameters:
    
    file - Path to the file to load
    
    Throws:
    
    IOException - Thrown if unable to read or parse the file
  - Config
```
public Config(Config parent)
```
    Constructor for subclasses who want a copy of the parent config but without the ability to modify the original values. This constructor will not re-read the file, but it will copy the location so if a child wants to reload the properties periodically, they may do so
    
    Parameters:
    
    parent - Parent configuration object to load from
- Method Detail
  - overrideConfig
```
public void overrideConfig(String property,
                           String value)
```
    Allows for modifying properties after loading WARNING: This should only be used on initialization of the config object and it is not thread safe.
    
    Parameters:
    
    property - The name of the property to override
    
    value - The value to store
  - getString
```
public final String getString(String property)
```
    Returns the given property as a String
    
    Parameters:
    
    property - The property to fetch
    
    Returns:
    
    The property value as a string or null if the property did not exist
  - getInt
```
public final int getInt(String property)
```
    Returns the given property as an integer
    
    Parameters:
    
    property - The property to fetch
    
    Returns:
    
    A parsed integer or an exception if the value could not be parsed
    
    Throws:
    
    NumberFormatException - if the property could not be parsed
    
    NullPointerException - if the property did not exist
  - getShort
```
public final short getShort(String property)
```
    Returns the given property as a short
    
    Parameters:
    
    property - The property to fetch
    
    Returns:
    
    A parsed short or an exception if the value could not be parsed
    
    Throws:
    
    NumberFormatException - if the property could not be parsed
    
    NullPointerException - if the property did not exist
  - getLong
```
public final long getLong(String property)
```
    Returns the given property as a long
    
    Parameters:
    
    property - The property to fetch
    
    Returns:
    
    A parsed long or an exception if the value could not be parsed
    
    Throws:
    
    NumberFormatException - if the property could not be parsed
    
    NullPointerException - if the property did not exist
  - getFloat
```
public final float getFloat(String property)
```
    Returns the given property as a float
    
    Parameters:
    
    property - The property to fetch
    
    Returns:
    
    A parsed float or an exception if the value could not be parsed
    
    Throws:
    
    NumberFormatException - if the property could not be parsed
    
    NullPointerException - if the property did not exist
  - getDouble
```
public final double getDouble(String property)
```
    Returns the given property as a double
    
    Parameters:
    
    property - The property to fetch
    
    Returns:
    
    A parsed double or an exception if the value could not be parsed
    
    Throws:
    
    NumberFormatException - if the property could not be parsed
    
    NullPointerException - if the property did not exist
  - getBoolean
```
public final boolean getBoolean(String property)
```
    Returns the given property as a boolean Property values are case insensitive and the following values will result in a True return value: - 1 - True - Yes Any other values, including an empty string, will result in a False
    
    Parameters:
    
    property - The property to fetch
    
    Returns:
    
    A parsed boolean
    
    Throws:
    
    NullPointerException - if the property was not found
  - getDirectoryName
```
public final String getDirectoryName(String property)
```
    Returns the directory name, making sure the end is an OS dependent slash
    
    Parameters:
    
    property - The property to fetch
    
    Returns:
    
    The property value with a forward or back slash appended
    
    Throws:
    
    NullPointerException - if the property was not found
  - hasProperty
```
public final boolean hasProperty(String property)
```
    Determines if the given property is in the map
    
    Parameters:
    
    property - The property to search for
    
    Returns:
    
    True if the property exists and has a value, not an empty string
  - dumpConfiguration
```
public final String dumpConfiguration()
```
    Returns a simple string with the configured properties for debugging. Note that any property with the string "PASS" will be obfuscated to hide passwords.
    
    Returns:
    
    A string with information about the config
  - getMap
```
public final Map<String,String> getMap()
```
    Returns:
    
    An copy of the configuration map
  - loadConfig
```
protected void loadConfig(String file)
                   throws FileNotFoundException,
                          IOException
```
    Attempts to load the configuration from the given location
    
    Parameters:
    
    file - Path to the file to load
    
    Throws:
    
    IOException - Thrown if there was an issue reading the file
    
    FileNotFoundException - Thrown if the config file was not found

Class Config

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RUNNING_WINDOWS

properties

default_map

config_location

Constructor Detail

Config

Config

Config

Method Detail

overrideConfig

getString

getInt

getShort

getLong

getFloat

getDouble

getBoolean

getDirectoryName

hasProperty

dumpConfiguration

getMap

loadConfig