Package org.apache.commons.configuration
Class BaseConfiguration
- java.lang.Object
-
- org.apache.commons.configuration.event.EventSource
-
- org.apache.commons.configuration.AbstractConfiguration
-
- org.apache.commons.configuration.BaseConfiguration
-
- All Implemented Interfaces:
java.lang.Cloneable
,Configuration
- Direct Known Subclasses:
AbstractFileConfiguration
public class BaseConfiguration extends AbstractConfiguration implements java.lang.Cloneable
Basic configuration class. Stores the configuration data but does not provide any load or save functions. If you want to load your Configuration from a file use PropertiesConfiguration or XmlConfiguration. This class extends normal Java properties by adding the possibility to use the same key many times concatenating the value strings instead of overwriting them.- Version:
- $Id: BaseConfiguration.java 1231721 2012-01-15 18:32:07Z oheger $
- Author:
- Stefano Mazzocchi, Jon S. Stevens, Dave Bryson, Geir Magnusson Jr., Leon Messerschmidt, Kent Johnson, Daniel Rall, Ilkka Priha, Jason van Zyl, Martin Poeschl, Henning P. Schmiedehausen, Konstantin Shaposhnikov
-
-
Field Summary
-
Fields inherited from class org.apache.commons.configuration.AbstractConfiguration
END_TOKEN, EVENT_ADD_PROPERTY, EVENT_CLEAR, EVENT_CLEAR_PROPERTY, EVENT_READ_PROPERTY, EVENT_SET_PROPERTY, START_TOKEN
-
-
Constructor Summary
Constructors Constructor Description BaseConfiguration()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addPropertyDirect(java.lang.String key, java.lang.Object value)
Adds a key/value pair to the map.void
clear()
Remove all properties from the configuration.protected void
clearPropertyDirect(java.lang.String key)
Clear a property in the configuration.java.lang.Object
clone()
Creates a copy of this object.boolean
containsKey(java.lang.String key)
check if the configuration contains the keyjava.util.Iterator<java.lang.String>
getKeys()
Get the list of the keys contained in the configuration repository.java.lang.Object
getProperty(java.lang.String key)
Read property from underlying map.boolean
isEmpty()
Check if the configuration is empty-
Methods inherited from class org.apache.commons.configuration.AbstractConfiguration
addErrorLogListener, addProperty, append, clearProperty, copy, createInterpolator, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getDefaultListDelimiter, getDelimiter, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getInterpolator, getKeys, getList, getList, getListDelimiter, getLogger, getLong, getLong, getLong, getProperties, getProperties, getShort, getShort, getShort, getString, getString, getStringArray, getSubstitutor, interpolate, interpolate, interpolatedConfiguration, interpolateHelper, isDelimiterParsingDisabled, isScalarValue, isThrowExceptionOnMissing, resolveContainerStore, setDefaultListDelimiter, setDelimiter, setDelimiterParsingDisabled, setListDelimiter, setLogger, setProperty, setThrowExceptionOnMissing, subset
-
Methods inherited from class org.apache.commons.configuration.event.EventSource
addConfigurationListener, addErrorListener, clearConfigurationListeners, clearErrorListeners, createErrorEvent, createEvent, fireError, fireEvent, getConfigurationListeners, getErrorListeners, isDetailEvents, removeConfigurationListener, removeErrorListener, setDetailEvents
-
-
-
-
Constructor Detail
-
BaseConfiguration
public BaseConfiguration()
-
-
Method Detail
-
addPropertyDirect
protected void addPropertyDirect(java.lang.String key, java.lang.Object value)
Adds a key/value pair to the map. This routine does no magic morphing. It ensures the keylist is maintained- Specified by:
addPropertyDirect
in classAbstractConfiguration
- Parameters:
key
- key to use for mappingvalue
- object to store
-
getProperty
public java.lang.Object getProperty(java.lang.String key)
Read property from underlying map.- Specified by:
getProperty
in interfaceConfiguration
- Parameters:
key
- key to use for mapping- Returns:
- object associated with the given configuration key.
-
isEmpty
public boolean isEmpty()
Check if the configuration is empty- Specified by:
isEmpty
in interfaceConfiguration
- Returns:
true
if Configuration is empty,false
otherwise.
-
containsKey
public boolean containsKey(java.lang.String key)
check if the configuration contains the key- Specified by:
containsKey
in interfaceConfiguration
- Parameters:
key
- the configuration key- Returns:
true
if Configuration contain given key,false
otherwise.
-
clearPropertyDirect
protected void clearPropertyDirect(java.lang.String key)
Clear a property in the configuration.- Overrides:
clearPropertyDirect
in classAbstractConfiguration
- Parameters:
key
- the key to remove along with corresponding value.
-
clear
public void clear()
Description copied from interface:Configuration
Remove all properties from the configuration.- Specified by:
clear
in interfaceConfiguration
- Overrides:
clear
in classAbstractConfiguration
-
getKeys
public java.util.Iterator<java.lang.String> getKeys()
Get the list of the keys contained in the configuration repository.- Specified by:
getKeys
in interfaceConfiguration
- Returns:
- An Iterator.
-
clone
public java.lang.Object clone()
Creates a copy of this object. This implementation will create a deep clone, i.e. the map that stores the properties is cloned, too. So changes performed at the copy won't affect the original and vice versa.- Overrides:
clone
in classEventSource
- Returns:
- the copy
- Since:
- 1.3
-
-