org.apache.bookkeeper.common.conf

Class ComponentConfiguration

java.lang.Object

org.apache.bookkeeper.common.conf.ComponentConfiguration

All Implemented Interfaces:

org.apache.commons.configuration.Configuration

public abstract class ComponentConfiguration
extends java.lang.Object
implements org.apache.commons.configuration.Configuration

Component Configuration.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DELIMITER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ComponentConfiguration(org.apache.commons.configuration.CompositeConfiguration underlyingConf, java.lang.String componentPrefix)

Method Summary

Modifier and Type	Method and Description
void	addProperty(java.lang.String key, java.lang.Object value)
java.lang.String	asJson() returns the string representation of json format of this config.
void	clear()
void	clearProperty(java.lang.String key)
boolean	containsKey(java.lang.String key)
java.math.BigDecimal	getBigDecimal(java.lang.String key)
java.math.BigDecimal	getBigDecimal(java.lang.String key, java.math.BigDecimal defaultValue)
java.math.BigInteger	getBigInteger(java.lang.String key)
java.math.BigInteger	getBigInteger(java.lang.String key, java.math.BigInteger defaultValue)
boolean	getBoolean(java.lang.String key)
boolean	getBoolean(java.lang.String key, boolean defaultValue)
java.lang.Boolean	getBoolean(java.lang.String key, java.lang.Boolean defaultValue)
byte	getByte(java.lang.String key)
byte	getByte(java.lang.String key, byte defaultValue)
java.lang.Byte	getByte(java.lang.String key, java.lang.Byte defaultValue)
double	getDouble(java.lang.String key)
double	getDouble(java.lang.String key, double defaultValue)
java.lang.Double	getDouble(java.lang.String key, java.lang.Double defaultValue)
float	getFloat(java.lang.String key)
float	getFloat(java.lang.String key, float defaultValue)
java.lang.Float	getFloat(java.lang.String key, java.lang.Float defaultValue)
int	getInt(java.lang.String key)
int	getInt(java.lang.String key, int defaultValue)
java.lang.Integer	getInteger(java.lang.String key, java.lang.Integer defaultValue)
protected java.lang.String	getKeyName(java.lang.String name)
java.util.Iterator<java.lang.String>	getKeys()
java.util.Iterator<java.lang.String>	getKeys(java.lang.String prefix)
java.util.List<java.lang.Object>	getList(java.lang.String key)
java.util.List<java.lang.Object>	getList(java.lang.String key, java.util.List<?> defaultValue)
long	getLong(java.lang.String key)
long	getLong(java.lang.String key, long defaultValue)
java.lang.Long	getLong(java.lang.String key, java.lang.Long defaultValue)
java.util.Properties	getProperties(java.lang.String key)
java.lang.Object	getProperty(java.lang.String key)
short	getShort(java.lang.String key)
short	getShort(java.lang.String key, short defaultValue)
java.lang.Short	getShort(java.lang.String key, java.lang.Short defaultValue)
java.lang.String	getString(java.lang.String key)
java.lang.String	getString(java.lang.String key, java.lang.String defaultValue)
java.lang.String[]	getStringArray(java.lang.String key)
org.apache.commons.configuration.CompositeConfiguration	getUnderlyingConf()
boolean	isEmpty()
protected void	loadConf(org.apache.commons.configuration.Configuration loadedConf)
void	loadConf(java.net.URL confURL) Load configuration from a given confURL.
void	setProperty(java.lang.String key, java.lang.Object value)
org.apache.commons.configuration.Configuration	subset(java.lang.String prefix)
void	validate()

Methods inherited from class java.lang.Object

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

Field Detail

DELIMITER

protected static final java.lang.String DELIMITER

See Also:

Constant Field Values

Constructor Detail

ComponentConfiguration

protected ComponentConfiguration(org.apache.commons.configuration.CompositeConfiguration underlyingConf,
                                 java.lang.String componentPrefix)

Method Detail

getKeyName

protected java.lang.String getKeyName(java.lang.String name)

getUnderlyingConf

public org.apache.commons.configuration.CompositeConfiguration getUnderlyingConf()

loadConf

public void loadConf(java.net.URL confURL)
              throws org.apache.commons.configuration.ConfigurationException

Load configuration from a given confURL.

Parameters:

confURL - the url points to the configuration.

Throws:

org.apache.commons.configuration.ConfigurationException - when failed to load configuration.

loadConf

protected void loadConf(org.apache.commons.configuration.Configuration loadedConf)

validate

public void validate()
              throws org.apache.commons.configuration.ConfigurationException

Throws:

org.apache.commons.configuration.ConfigurationException

subset

public org.apache.commons.configuration.Configuration subset(java.lang.String prefix)

Specified by:

subset in interface org.apache.commons.configuration.Configuration

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.apache.commons.configuration.Configuration

containsKey

public boolean containsKey(java.lang.String key)

Specified by:

containsKey in interface org.apache.commons.configuration.Configuration

addProperty

public void addProperty(java.lang.String key,
                        java.lang.Object value)

Specified by:

addProperty in interface org.apache.commons.configuration.Configuration

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)

Specified by:

setProperty in interface org.apache.commons.configuration.Configuration

clearProperty

public void clearProperty(java.lang.String key)

Specified by:

clearProperty in interface org.apache.commons.configuration.Configuration

clear

public void clear()

Specified by:

clear in interface org.apache.commons.configuration.Configuration

getProperty

public java.lang.Object getProperty(java.lang.String key)

Specified by:

getProperty in interface org.apache.commons.configuration.Configuration

getKeys

public java.util.Iterator<java.lang.String> getKeys(java.lang.String prefix)

Specified by:

getKeys in interface org.apache.commons.configuration.Configuration

getKeys

public java.util.Iterator<java.lang.String> getKeys()

Specified by:

getKeys in interface org.apache.commons.configuration.Configuration

getProperties

public java.util.Properties getProperties(java.lang.String key)

Specified by:

getProperties in interface org.apache.commons.configuration.Configuration

getBoolean

public boolean getBoolean(java.lang.String key)

Specified by:

getBoolean in interface org.apache.commons.configuration.Configuration

getBoolean

public boolean getBoolean(java.lang.String key,
                          boolean defaultValue)

Specified by:

getBoolean in interface org.apache.commons.configuration.Configuration

getBoolean

public java.lang.Boolean getBoolean(java.lang.String key,
                                    java.lang.Boolean defaultValue)

Specified by:

getBoolean in interface org.apache.commons.configuration.Configuration

getByte

public byte getByte(java.lang.String key)

Specified by:

getByte in interface org.apache.commons.configuration.Configuration

getByte

public byte getByte(java.lang.String key,
                    byte defaultValue)

Specified by:

getByte in interface org.apache.commons.configuration.Configuration

getByte

public java.lang.Byte getByte(java.lang.String key,
                              java.lang.Byte defaultValue)

Specified by:

getByte in interface org.apache.commons.configuration.Configuration

getDouble

public double getDouble(java.lang.String key)

Specified by:

getDouble in interface org.apache.commons.configuration.Configuration

getDouble

public double getDouble(java.lang.String key,
                        double defaultValue)

Specified by:

getDouble in interface org.apache.commons.configuration.Configuration

getDouble

public java.lang.Double getDouble(java.lang.String key,
                                  java.lang.Double defaultValue)

Specified by:

getDouble in interface org.apache.commons.configuration.Configuration

getFloat

public float getFloat(java.lang.String key)

Specified by:

getFloat in interface org.apache.commons.configuration.Configuration

getFloat

public float getFloat(java.lang.String key,
                      float defaultValue)

Specified by:

getFloat in interface org.apache.commons.configuration.Configuration

getFloat

public java.lang.Float getFloat(java.lang.String key,
                                java.lang.Float defaultValue)

Specified by:

getFloat in interface org.apache.commons.configuration.Configuration

getInt

public int getInt(java.lang.String key)

Specified by:

getInt in interface org.apache.commons.configuration.Configuration

getInt

public int getInt(java.lang.String key,
                  int defaultValue)

Specified by:

getInt in interface org.apache.commons.configuration.Configuration

getInteger

public java.lang.Integer getInteger(java.lang.String key,
                                    java.lang.Integer defaultValue)

Specified by:

getInteger in interface org.apache.commons.configuration.Configuration

getLong

public long getLong(java.lang.String key)

Specified by:

getLong in interface org.apache.commons.configuration.Configuration

getLong

public long getLong(java.lang.String key,
                    long defaultValue)

Specified by:

getLong in interface org.apache.commons.configuration.Configuration

getLong

public java.lang.Long getLong(java.lang.String key,
                              java.lang.Long defaultValue)

Specified by:

getLong in interface org.apache.commons.configuration.Configuration

getShort

public short getShort(java.lang.String key)

Specified by:

getShort in interface org.apache.commons.configuration.Configuration

getShort

public short getShort(java.lang.String key,
                      short defaultValue)

Specified by:

getShort in interface org.apache.commons.configuration.Configuration

getShort

public java.lang.Short getShort(java.lang.String key,
                                java.lang.Short defaultValue)

Specified by:

getShort in interface org.apache.commons.configuration.Configuration

getBigDecimal

public java.math.BigDecimal getBigDecimal(java.lang.String key)

Specified by:

getBigDecimal in interface org.apache.commons.configuration.Configuration

getBigDecimal

public java.math.BigDecimal getBigDecimal(java.lang.String key,
                                          java.math.BigDecimal defaultValue)

Specified by:

getBigDecimal in interface org.apache.commons.configuration.Configuration

getBigInteger

public java.math.BigInteger getBigInteger(java.lang.String key)

Specified by:

getBigInteger in interface org.apache.commons.configuration.Configuration

getBigInteger

public java.math.BigInteger getBigInteger(java.lang.String key,
                                          java.math.BigInteger defaultValue)

Specified by:

getBigInteger in interface org.apache.commons.configuration.Configuration

getString

public java.lang.String getString(java.lang.String key)

Specified by:

getString in interface org.apache.commons.configuration.Configuration

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String defaultValue)

Specified by:

getString in interface org.apache.commons.configuration.Configuration

getStringArray

public java.lang.String[] getStringArray(java.lang.String key)

Specified by:

getStringArray in interface org.apache.commons.configuration.Configuration

getList

public java.util.List<java.lang.Object> getList(java.lang.String key)

Specified by:

getList in interface org.apache.commons.configuration.Configuration

getList

public java.util.List<java.lang.Object> getList(java.lang.String key,
                                                java.util.List<?> defaultValue)

Specified by:

getList in interface org.apache.commons.configuration.Configuration

asJson

public java.lang.String asJson()

returns the string representation of json format of this config.

Returns:

Throws:

JsonUtil.ParseJsonException