|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.hadoop.conf.Configuration
org.apache.hadoop.hbase.CompoundConfiguration
@InterfaceAudience.Private public class CompoundConfiguration
Do a shallow merge of multiple KV configuration pools. This is a very useful utility class to easily add per-object configurations in addition to wider scope settings. This is different from Configuration.addResource() functionality, which performs a deep merge and mutates the common data structure.
The iterator on CompoundConfiguration is unmodifiable. Obtaining iterator is an expensive operation.
For clarity: the shallow merge allows the user to mutate either of the configuration objects and have changes reflected everywhere. In contrast to a deep merge, that requires you to explicitly know all applicable copies to propagate changes. WARNING: The values set in the CompoundConfiguration are do not handle Property variable substitution. However, if they are set in the underlying configuration substitutions are done.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.apache.hadoop.conf.Configuration |
|---|
org.apache.hadoop.conf.Configuration.IntegerRanges |
| Field Summary | |
|---|---|
protected List<org.apache.hadoop.hbase.CompoundConfiguration.ImmutableConfigMap> |
configs
|
| Constructor Summary | |
|---|---|
CompoundConfiguration()
Default Constructor. |
|
| Method Summary | |
|---|---|
CompoundConfiguration |
add(org.apache.hadoop.conf.Configuration conf)
Add Hadoop Configuration object to config list. |
CompoundConfiguration |
addStringMap(Map<String,String> map)
Add String map to config list. |
CompoundConfiguration |
addWritableMap(Map<ImmutableBytesWritable,ImmutableBytesWritable> map)
Add ImmutableBytesWritable map to config list. |
void |
clear()
These methods are unsupported, and no code using CompoundConfiguration depend upon them. |
String |
get(String key)
|
String |
get(String name,
String defaultValue)
Get the value of the name. |
Class<?> |
getClassByName(String name)
|
String |
getRaw(String key)
|
Iterator<Map.Entry<String,String>> |
iterator()
|
void |
set(String name,
String value)
|
int |
size()
|
String |
toString()
|
void |
write(DataOutput out)
|
void |
writeXml(OutputStream out)
|
| Methods inherited from class org.apache.hadoop.conf.Configuration |
|---|
addDefaultResource, addDeprecation, addDeprecation, addDeprecation, addDeprecation, addResource, addResource, addResource, addResource, addResource, dumpConfiguration, dumpDeprecatedKeys, getBoolean, getClass, getClass, getClassByNameOrNull, getClasses, getClassLoader, getConfResourceAsInputStream, getConfResourceAsReader, getEnum, getFile, getFloat, getInstances, getInt, getInts, getLocalPath, getLong, getLongBytes, getPattern, getPropertySources, getProps, getRange, getResource, getSocketAddr, getStringCollection, getStrings, getStrings, getTrimmed, getTrimmedStringCollection, getTrimmedStrings, getTrimmedStrings, getValByRegex, isDeprecated, main, readFields, reloadConfiguration, set, setBoolean, setBooleanIfUnset, setClass, setClassLoader, setEnum, setFloat, setIfUnset, setInt, setLong, setPattern, setQuietMode, setSocketAddr, setStrings, unset, updateConnectAddr, writeXml |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected List<org.apache.hadoop.hbase.CompoundConfiguration.ImmutableConfigMap> configs
| Constructor Detail |
|---|
public CompoundConfiguration()
| Method Detail |
|---|
public CompoundConfiguration add(org.apache.hadoop.conf.Configuration conf)
conf - configuration object
public CompoundConfiguration addWritableMap(Map<ImmutableBytesWritable,ImmutableBytesWritable> map)
map - ImmutableBytesWritable map
public CompoundConfiguration addStringMap(Map<String,String> map)
public String toString()
toString in class org.apache.hadoop.conf.Configurationpublic String get(String key)
get in class org.apache.hadoop.conf.Configurationpublic String getRaw(String key)
getRaw in class org.apache.hadoop.conf.Configuration
public Class<?> getClassByName(String name)
throws ClassNotFoundException
getClassByName in class org.apache.hadoop.conf.ConfigurationClassNotFoundExceptionpublic int size()
size in class org.apache.hadoop.conf.Configuration
public String get(String name,
String defaultValue)
name. If the key is deprecated,
it returns the value of the first key which replaces the deprecated key
and is not null.
If no such property exists,
then defaultValue is returned.
The CompooundConfiguration does not do property substitution. To do so we need
Configuration.getProps to be protected or package visible. Though in hadoop2 it is
protected, in hadoop1 the method is private and not accessible.
All of the get* methods call this overridden get method.
get in class org.apache.hadoop.conf.Configurationname - property name.defaultValue - default value.
defaultValue if the property
doesn't exist.public Iterator<Map.Entry<String,String>> iterator()
iterator in interface Iterable<Map.Entry<String,String>>iterator in class org.apache.hadoop.conf.Configuration
public void set(String name,
String value)
set in class org.apache.hadoop.conf.Configurationpublic void clear()
clear in class org.apache.hadoop.conf.Configuration
public void write(DataOutput out)
throws IOException
write in interface org.apache.hadoop.io.Writablewrite in class org.apache.hadoop.conf.ConfigurationIOException
public void writeXml(OutputStream out)
throws IOException
writeXml in class org.apache.hadoop.conf.ConfigurationIOException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||