|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.configuration.event.EventSource
org.apache.commons.configuration.AbstractConfiguration
org.apache.commons.configuration.CompositeConfiguration
This Configuration class allows you to add multiple different types of Configuration to this CompositeConfiguration. If you add Configuration1, and then Configuration2, any properties shared will mean that Configuration1 will be returned. You can add multiple different types or the same type of properties file. If Configuration1 doesn't have the property, then Configuration2 will be checked.
Field Summary |
Fields inherited from class org.apache.commons.configuration.AbstractConfiguration |
END_TOKEN, EVENT_ADD_PROPERTY, EVENT_CLEAR, EVENT_CLEAR_PROPERTY, EVENT_SET_PROPERTY, START_TOKEN |
Constructor Summary | |
CompositeConfiguration()
Creates an empty CompositeConfiguration object which can then be added some other Configuration files |
|
CompositeConfiguration(Collection configurations)
Create a CompositeConfiguration with an empty in memory configuration and adds the collection of configurations specified. |
|
CompositeConfiguration(Configuration inMemoryConfiguration)
Creates a CompositeConfiguration object with a specified in memory configuration. |
|
CompositeConfiguration(Configuration inMemoryConfiguration,
Collection configurations)
Creates a CompositeConfiguration with a specified in memory configuration, and then adds the given collection of configurations. |
Method Summary | |
void |
addConfiguration(Configuration config)
Add a configuration. |
protected void |
addPropertyDirect(String key,
Object token)
Add this property to the inmemory Configuration. |
void |
clear()
Remove all configuration reinitialize the in memory configuration. |
void |
clearProperty(String key)
Removes the specified property from this configuration. This implementation performs some preparations and then delegates to clearPropertyDirect() , which will do the real work. |
Object |
clone()
Returns a copy of this object. |
boolean |
containsKey(String key)
Check if the configuration contains the specified key. |
Configuration |
getConfiguration(int index)
Return the configuration at the specified index. |
Configuration |
getInMemoryConfiguration()
Returns the "in memory configuration". |
Iterator |
getKeys()
Get the list of the keys contained in the configuration. The returned iterator can be used to obtain all defined keys. Note that the exact behavior of the iterator's remove() method is specific to
a concrete implementation. It may remove the corresponding
property from the configuration, but this is not guaranteed. In any case
it is no replacement for calling
for this property. So it is
highly recommended to avoid using the iterator's remove()
method. |
Iterator |
getKeys(String key)
Get the list of the keys contained in the configuration that match the specified prefix. |
List |
getList(String key,
List defaultValue)
Get a List of strings associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned. |
int |
getNumberOfConfigurations()
Return the number of configurations. |
Object |
getProperty(String key)
Read property from underlying composite |
String[] |
getStringArray(String key)
Get an array of strings associated with the given configuration key. If the key doesn't map to an existing object an empty array is returned |
boolean |
isEmpty()
Check if the configuration is empty. |
void |
removeConfiguration(Configuration config)
Remove a configuration. |
Methods inherited from class org.apache.commons.configuration.AbstractConfiguration |
addProperty, clearPropertyDirect, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getDefaultListDelimiter, getDelimiter, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getList, getListDelimiter, getLong, getLong, getLong, getProperties, getProperties, getShort, getShort, getShort, getString, getString, interpolate, interpolate, interpolateHelper, isDelimiterParsingDisabled, isThrowExceptionOnMissing, resolveContainerStore, setDefaultListDelimiter, setDelimiter, setDelimiterParsingDisabled, setListDelimiter, setProperty, setThrowExceptionOnMissing, subset |
Methods inherited from class org.apache.commons.configuration.event.EventSource |
addConfigurationListener, clearConfigurationListeners, createEvent, fireEvent, getConfigurationListeners, isDetailEvents, removeConfigurationListener, setDetailEvents |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public CompositeConfiguration()
public CompositeConfiguration(Configuration inMemoryConfiguration)
inMemoryConfiguration
- the in memory configuration to usepublic CompositeConfiguration(Collection configurations)
configurations
- the collection of configurations to addpublic CompositeConfiguration(Configuration inMemoryConfiguration, Collection configurations)
inMemoryConfiguration
- the in memory configuration to useconfigurations
- the collection of configurations to addMethod Detail |
public void addConfiguration(Configuration config)
config
- the configuration to addpublic void removeConfiguration(Configuration config)
config
- The configuration to removepublic int getNumberOfConfigurations()
public void clear()
clear
in interface Configuration
clear
in class AbstractConfiguration
protected void addPropertyDirect(String key, Object token)
addPropertyDirect
in class AbstractConfiguration
key
- The Key to add the property to.token
- The Value to add.public Object getProperty(String key)
getProperty
in interface Configuration
key
- key to use for mapping
public Iterator getKeys()
remove()
method is specific to
a concrete implementation. It may remove the corresponding
property from the configuration, but this is not guaranteed. In any case
it is no replacement for calling
Configuration.clearProperty(String)
for this property. So it is
highly recommended to avoid using the iterator's remove()
method.
getKeys
in interface Configuration
getKeys
in class AbstractConfiguration
public Iterator getKeys(String key)
getKeys
in interface Configuration
getKeys
in class AbstractConfiguration
public boolean isEmpty()
isEmpty
in interface Configuration
isEmpty
in class AbstractConfiguration
public void clearProperty(String key)
clearPropertyDirect()
, which will do the real work.
clearProperty
in interface Configuration
clearProperty
in class AbstractConfiguration
key
- the key to be removedpublic boolean containsKey(String key)
containsKey
in interface Configuration
containsKey
in class AbstractConfiguration
public List getList(String key, List defaultValue)
getList
in interface Configuration
getList
in class AbstractConfiguration
public String[] getStringArray(String key)
getStringArray
in interface Configuration
getStringArray
in class AbstractConfiguration
public Configuration getConfiguration(int index)
index
- The index of the configuration to retrieve
public Configuration getInMemoryConfiguration()
public Object clone()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |