##### Configuration

- Home
- Download
- Release History
- User's Guide
- Howtos (1.2 release)
- Runtime Dependencies
- Javadoc (current release)
- Javadoc (old releases)

##### Development

- Building
- Roadmap
- Issue Tracking
- SVN

##### Project Documentation

- About Commons Configuration
- Downloads
- Project Info
- Project Reports
  - Metrics
  - Checkstyle
  - Changes
  - Change Log
  - File Activity
  - Developer Activity
  - JavaDocs
  - JavaDoc Report
  - JavaDoc Warnings Report
  - Source Xref
  - Test Xref
  - Unit Tests
  - Task List
  - PMD Report
  - Cobertura
  - Tasks
  - FindBugs Report
  - JDiff
- Development Process

##### Commons

- Home
- Components
- Sandbox
- Dormant
- Volunteering
- Contributing Patches
- Building Components
- Releasing Components
- Wiki

## Release History

Version | Date | Description
--- | --- | ---
1.5 | in SVN |
1.4 | 2007-04-08 | Improved interpolation, configuration for INI files, reloading strategy triggered with JMX, bug fixes.
1.3 | 2006-09-24 |
1.3-rc2 | 2006-09-03 |
1.3-rc1 | 2006-07-30 |
1.2 | 2005-12-17 |
1.2-rc3 | 2005-12-07 |
1.2-rc2 | 2005-11-23 |
1.2-rc1 | 2005-11-11 |
1.1 | 2005-04-02 |
1.1-rc2 | 2005-03-06 |
1.1-rc1 | 2005-02-13 |
1.0 | 2004-10-11 | First official release
1.0-rc2 | 2004-09-24 |
1.0-rc1 | 2004-08-14 |

Get the RSS feed of the last changes

## Release 1.5 - in SVN

Type | Changes | By
--- | --- | ---
| Some of the dependencies in the m2 pom have been updated to be more consistent. Thanks to Jörg Schaible. | oheger
| The dependency to commons-logging was updated to the current version 1.1. Older versions of commons-logging will still work. Thanks to Jörg Schaible. | oheger
| A new method interpolatedConfiguration() was added to AbstractConfiguration. This method returns a configuration with the same type and content as the original configuration, however all variables have been resolved. Fixes CONFIGURATION-273. | oheger
| Resolving of variables with the prefix const (constant fields) caused a ClassCastException under certain circumstances if non-String fields were involved. This has been fixed. Fixes CONFIGURATION-299. | oheger
| The dependencies to commons-codec and commons-jxpath have been marked as optional. They are not required by the core classes. Thanks to Nicolas De Loof. | oheger
| There is a new configuration implementation EnvironmentConfiguration, which provides access to (OS) environment variables. On Java > = 1.5 this class can be directly used; on earlier versions a dependency to ant is required. Fixes CONFIGURATION-284. Thanks to Nicolas De Loof. | oheger
| A bug in XMLConfiguration caused that attributes of the root element could not be changed. This has been fixed. Fixes CONFIGURATION-296. | oheger
| A new method registerEntityId() was added to XMLConfiguration, which allows to register URLs for entities. A new default implementation of the EntityResolver interface handles these entities automatically. Fixes CONFIGURATION-290. | oheger
| The subset() method of HierarchicalConfiguration now takes the value of the subset's root node into account if it is not ambigous. Fixes CONFIGURATION-295. | oheger
| Nodes added to a XMLConfiguration using the addNodes() method could lose their value when the configuration was saved. This is now fixed. Fixes CONFIGURATION-294. | oheger
| New copy() and append() methods have been added to AbstractConfiguration. They replace the methods with the same names in ConfigurationUtils, which do not handle all features of AbstractConfiguration properly (e.g. list delimiters in property values are incorrectly treated). To avoid such problems, the new methods should be us ed. Fixes CONFIGURATION-272. | oheger
| The addNodes() method of hierarchical file-based configurations now correctly triggers an auto save. Fixes CONFIGURATION-291. | oheger
| HierarchicalConfiguration.addNodes() now resets the reference property of all nodes to be added. This fixes a problem with XMLConfiguration, which now detects the added nodes as new and treats them correctly when the configuration is saved. Fixes CONFIGURATION-287. | oheger
| DefaultConfigurationBuilder will now notify registered error listeners about optional configuration sources that could not be created. Before exceptions thrown by optional configurations were swallowed Fixes CONFIGURATION-285. | oheger
| ConfigurationUtils.convertToHierarchical() now correctly deals with property values containing escaped list delimiters. This also affects CombinedConfiguration when sub configurations with such property values are contained. Fixes CONFIGURATION-283. | oheger
| AbstractConfiguration.addProperty() now correctly deals with list and array properties if delimiter parsing is disabled. Fixes CONFIGURATION-275. | oheger
| The default expression engine used by HierarchicalConfiguration instances is now lazily initialized. This avoids NullPointerExceptions in certain server environments after a redeploy. Fixes CONFIGURATION-282. | oheger
| Cycles in the JNDI tree no longer cause a stack overflow in JNDIConfiguration. Fixes CONFIGURATION-281. | oheger
| The base implementation of clear() in AbstractConfiguration now checks for a potential UnsupportedOperationException when iterating over the existing properties. Fixes CONFIGURATION-277. | oheger
| Using file-based configurations in auto-save mode together with a reloading strategy could cause data loss. This has been fixed. Fixes CONFIGURATION-280. Thanks to Roman Kurmanowytsch. | oheger
| A PropertiesConfiguration that was created from a non existing file lost its content when it was saved. This problem has been solved. Fixes CONFIGURATION-279. | oheger
| A new getSource() method was added to CompositeConfiguration and CombinedConfiguration, which returns the child configuration, in which a given property is defined. Fixes CONFIGURATION-215. | oheger
| PropertiesConfiguration now supports escaping the escape character for list delimiters. Fixes CONFIGURATION-274. | oheger
| PropertiesConfiguration no longer escapes the list delimiter on saving if the list delimiter has been disabled. Fixes CONFIGURATION-269. | ebourg
| List properties and properties containing interpolated variables are now properly saved by INIConfiguration. Fixes CONFIGURATION-270. | ebourg
| When delimiter parsing was disabled for XMLConfiguration, saving and loading the configuration accidently added escape characters to properties containing the list delimiter character. This has been fixed. It is now also possible to escape the escape character itself. Fixes CONFIGURATION-268. | oheger
| The return value of FileConfig uration.getFile() is now always consistent with the result of getURL(). Fixes CONFIGURATION-253. | oheger
| INIConfiguration uses the platform's specific line separator instead of the Windows line separator. | ebourg
| INIConfiguration flushes the output at the end of a save operation. Fixes CONFIGURATION-267. | ebourg
| For hierarchical file-based configurations the auto-save mechanism is now also triggered if a subnode configuration is changed. In such a case the new event type EVENT_SUBNODE_CHANGED will be sent to registered listeners. Fixes CONFIGURATION-265. | oheger
| ConfigurationInterpolator now also invokes the default lookup object for variables with a prefix that could not be resolved by their associated lookup object. Fixes CONFIGURATION-266. Thanks to Tobias Noebel. | oheger
| A SubnodeConfiguration per default does not see certain changes of its parent configuration (e.g. reloads). With a new boolean parameter of HierarchicalConfiguration's configurationAt() method a mode can be enabled, in which the subnode configuration checks for such changes and reconstructs itself if necessary. Fixes CONFIGURATION-264. | oheger
| byte[ ] properties are properly saved as data fields in the plist configurations (PropertyListConfiguration and XMLPropertyListConfiguration). | ebourg
| DataConfiguration now supports java.net.InetAddress, javax.mail.internet.InternetAddress, and Java 5 enumeration types. Properties are converted to these types using the new generic getters. | ebourg
| The object getters in DataConfiguration with no default value (i.e getURL(key)) now throw a NoSuchElementException if the flag throwExceptionOnMissing is set. | ebourg
| Generic get methods have been added to DataConfiguration (get(), getArray() and getList()) | ebourg
| XMLConfiguration used to drop attributes when an element's value was a list. This has been fixed. Fixes CONFIGURATION-263. | oheger
| File configurations can now be saved to FTP URLs, or any other URL protocol supporting data output. Fixes CONFIGURATION-249. | ebourg
| Fixed a potential issue in DatabaseConfiguration where an error on closing a statement would prevent the connection from being closed. Fixes CONFIGURATION-180. | ebourg
| Date objects are now supported in ASCII plist files. Fixes CONFIGURATION-261. | ebourg
| XMLPropertyListConfiguration no longer requires commons-digester and commons-beanutils to work. | ebourg
| Fixed INIConfiguration to handle the quoted values and the lines containing a value and a comment. | ebourg

## Release 1.4 - 2007-04-08

Type | Changes | By
--- | --- | ---
| MapConfiguration and the web-based configurations now treat strings that contain an escaped list delimiter correctly: The escape character will be removed, so that for instance "foo\,bar" becomes "foo,bar". Fixes CONFIGURATION-256. | oheger
| DatabaseConfiguration now handles list delimiters in property values correctly. Fixes CONFIGURATION-255. | oheger
| After cloning a XMLConfiguration there was still a connection to the original configuration. So when the clone was modified and then saved the content of the original configuration was written. This has now been fixed. Fixes CONFIGURATION-254. Thanks to Carsten Kaiser. | oheger
| Class loading in BeanHelper is now done using ClassUtils of Commons Lang. | oheger
| With ManagedReloadingStrategy a new reloading strategy for file-based configurations was added that can be triggered through JMX. Fixes CONFIGURATION-237. Thanks to Nicolas de Loof. | oheger
| The dependencies to Commons Lang, Commons Collections, and Commons Digester are updated to use the recent available version. However older versions will still work. | oheger
| A pom for maven 2 was added. | oheger
| ConfigurationUtils.getFile() now always checks first whether the passed in file name is absolute. If it is, this file will be returned. This prevents that on Unix under certain circumstances absolute file names are interpreted as relative ones. Fixes CONFIGURATION-252. | oheger
| The dependency to xml-apis was changed to the version 1.0.b2. The so far used version 2.0.2 is reported to be bogus. Fixes CONFIGURATION-251. | oheger
| In addition to configuration event listeners now so-called configuration error listeners are supported. These list eners are notified about internal errors that had been logged and swallowed by privious versions. The new enableRuntimeExceptions() method of ConfigurationUtils registers a special error listener at the passed in configuration that generates a runtime exception when an error event is received. Fixes CONFIGURATION-245. | oheger
| AbstractConfiguration now allows to set an instance specific logger using the setLogger() method. This gives clients more control over a configuration's logging behavior. | oheger
| SubsetConfiguration and CompositeConfiguration were updated to fully support an instance specific list delimiter. Concerning splitting of string properties that contain a list delimiter character, these classes now behave like a "normal" configuration. Fixes CONFIGURATION-155. | oheger
| Variable interpolation features have been improved. A variable can now have the form `${prefix:variableName}` where the prefix defines the type of the variable. The standard types sys for system properties and const for constants are supported. Variables without a prefix are treated as references to other configuration properties (which is compatible to earlier versions). Fixes CONFIGURATION-192. | oheger
| Commons Configuration now depends on Commons Lang 2.2. Some features of Lang's new text package are used. | oheger
| The number of dependencies needed for DefaultConfigurationBuilder was reduced by letting some of the default configuration providers resolve their classes per reflection. Fixes CONFIGURATION-244. | oheger
| File-based configurations with a reloading strategy did not work well together with CombinedConfiguration because the reloading strategy is only checked when its associated configuration is accessed (which does not happen when only the combined configuration is queried). As a workaround CombinedConfiguration now provides the boolean forceReloadCheck property. If this is set to true, all contained configurations will be triggered when a property is queried. This will cause a reload if necessary. Fixes CONFIGURATION-240. | oheger
| Configuration declarations in the configuration definition file for DefaultConfigurationBuilder that are marked as optional now support a new attribute `config-forceCreate` . If this attribute is set to true and the initialization of the configuration fails, DefaultConfigurationBuilder tries to add an empty configuration of the correct type to the resulting combined configuration. Before this change optional configurations that caused errors were never added to the combined configuration. Fixes CONFIGURATION-243. | oheger
| CompositeConfiguration.clearProperty() now generates the correct update events. Fixes CONFIGURATION-241. | oheger
| The configuration returned by HierarchicalConfiguration.subset() performed variable interpolation only in the keys that belong to the subset. Now the parent configuration is searched, too, to resolve the value of the referenced property. This is consistent with the way SubnodeConfiguration works. Fixes CONFIGURATION-242. | oheger
| DefaultConfigurationBuilder now internally uses the standard expression engine for hierarchical configurations. So the dependency to Commons JXPath is no more needed when this class is used. Note that this change has some impact on existing code that manually sets properties before the combined configuration is created; this code must now be adapted to the changed syntax of property keys. Fixes CONFIGURATION-234. | oheger
| HierarchicalConfiguration and some of its sub classes now define a copy constructor. Fixes CONFIGURATION-236. | oheger
| A new configuration class for windows ini files was added. Fixes CONFIGURATION-197. Thanks to Trevor Charles Miller. | oheger
| For file-based configurations loaded by ConfigurationFactory the load() method was called before all of the properties specified by attributes of the XML element have been initialized. Now load() is called after property initialization. Fixes CONFIGURATION-229. | oheger
| Interpolation of non string values did not work when SubsetConfiguration was involved. This has now been fixed. Fixes CONFIGURATION-235. | oheger
| The compatibility of ConfigurationDynaBean with other configuration types than those that inherit from BaseConfiguration was improved. Fixes CONFIGURATION-227. | oheger
| The getList() method of CompositeConfiguration does now fully support variable interpolation. So it is possible to refer to a variable in one (sub) configuration that is defined in another configuration. Fixes CONFIGURATION-233. Thanks to Rainer Jung. | oheger
| XPathExpressionEngine used to create wrong keys for attribute nodes. This caused some opera tions on XMLConfiguration to fail when such an expression engine was set (e.g. reloading). Now correct keys for attributes are constructed. Fixes CONFIGURATION-230. | oheger
| Some of the methods of file-based hierarchical configurations (e.g. subset() or configurationAt()) did not take an eventually set reloading strategy into account. This is now fixed by overriding the internal fetchNodeList() method in AbstractHierarchicalFileConfiguration and letting it always check for a reload. Fixes CONFIGURATION-228. | oheger

## Release 1.3 - 2006-09-24

Type | Changes | By
--- | --- | ---

## Release 1.3-rc2 - 2006-09-03

Type | Changes | By
--- | --- | ---
| AbstractFileConfiguration now overrides addProperty() and setProperty() instead of addPropertyDirect() to implement the auto save feature. This was necessary to properly integrate PropertiesConfigurationLayout. It has also the advantage that an auto save is triggered only once if multi-valued properties are involved (before a save operation was performed for each property value). Fixes CONFIGURATION-223. Thanks to Gabriele Garuglieri. | oheger
| The new PropertiesConfigurationLayout class broke the save() operation of PropertiesConfiguration when an instance was newly created and populated in memory. This is fixed now by ensuring that a layout object is immediately created and registered as event listener at the configuration. Fixes CONFIGURATION-222. Thanks to Gabriele Garuglieri. | oheger
| ConfigurationFactory now supports variables in its configuration definition files. These variables are resolved using system properties and have the typical ${} syntax. Fixes CONFIGURATION-221. Thanks to Rainer Jung. | oheger
| There were still some problems with resolving relative paths when configuration files are loaded from classpath. This fix addresses these issues. Fixes CONFIGURATION-216. Thanks to Gabriele Garuglieri. | oheger
| DataConfiguration.getDateArray() used to ignore the format argument. This was fixed. Fixes CONFIGURATION-220. | oheger
| PropertiesConfiguration now defines its own clone() method to handle the associated PropertiesConfigurationLayout object correctly. Fixes CONFIGURATION-219. | oheger

## Release 1.3-rc1 - 2006-07-30

Type | Changes | By
--- | --- | ---
| The dependency to servletapi was updated from version 2.3 to version 2.4, but version 2.3 will still work. Fixes CONFIGURATION-217. | oheger
| A new class PropertiesConfigurationLayout was introduced whose task is to preserve the structure (e.g. comments, blanc lines) of a file loaded by PropertiesConfiguration. Each PropertiesConfiguration object is now associated with such a layout object. A saved properties file will look very similar to its original. Fixes CONFIGURATION-104. | oheger
| clone() methods have been added to BaseConfiguration, AbstractFileConfiguration, MapConfiguration, CompositeConfiguration, and CombinedConfiguration. So the most important Configuration implementations now support cloning. To ConfigurationUtils an utility method cloneConfiguration() was added that allows to conveniently clone a configuration. Fixes CONFIGURATION-145. | oheger
| If a configuration file was to be loaded from classp ath, the constructor of AbstractFileConfiguration dropped the file's path. The path is now taken into account. Fixes CONFIGURATION-216. | oheger
| The getter methods for numeric data types in AbstractConfiguration now support conversions between different Number types, e.g. you can now call getLong(key) when key points to an Integer value. Fixes CONFIGURATION-214. | oheger
| The new class DefaultConfigurationBuilder was added as an alternative to ConfigurationFactory. It provides some more features and creates a CombinedConfiguration object | oheger
| The new class CombinedConfiguration was added as a hierarchical alternative to CompositeConfiguration. | oheger
| Support for low-level configuration events was added to all classes derived from AbstractConfiguration. The major part of this is handled by the new super class EventSource of AbstractConfiguration. Fixes CONFIGURATION-143. | oheger
| A new method convertToHierarchical() was added to ConfigurationUtils, which is able to convert an arbitrary configuration object into a hierarchical configuration. | oheger
| Loading of file-based configurations no longer throws a NullPointerException in setups where the thread context class loader is not set. Fixes CONFIGURATION-63. | oheger
| The dependency to dom4j was removed; it was only used by two test classes, which have been re-written. | oheger
| XMLConfiguration used to drop the DOCTYPE declaration when saving the configuration. It is now ab le to extract the DTD's public and system ID and write them back (more complex DOCTYPE declarations are still not supported). With the new methods setSystemID() and setPublicID(), the DOCTYPE declaration can be configured. Fixes CONFIGURATION-100. | oheger
| Added two new constructors in CompositeConfiguration accepting a collection of configurations as a parameter. Fixes CONFIGURATION-178. | ebourg
| (Basic) Support for declaring beans in configuration files was added. Some new classes in the beanutils package allow to create instances from these declarations. Fixes CONFIGURATION-186. | oheger
| The implementation of the interpolation features have been extracted out off AbstractConfiguration and moved to PropertyConverter. The interpolateHelper() method of AbstractConfiguration is now deprectated and will not be called any more during interpolation. | oheger
| A new method configurationsAt() was added to HierarchicalConfiguration that provides a convenient way of iterating over complex list-like structures without the need of manually constructing configuration keys with indices. Fixes CONFIGURATION-182. | oheger
| A new class SubnodeConfiguration was introduced that wraps a configuration node of a HierarchicalConfiguration. All operations performed on this configuration use this wrapped node as root. The new configurationAt() method of HierarchicalConfiguration returns such a SubnodeConfiguration for a specified sub node. | oheger
| With XPathExpressionEngine an expression engine for hierarchical configurations is now available t hat can evaluate XPATH expressions in property keys. This expression engine implementation is based on Commons JXPath, which is now declared as a new dependency (but at runtime it is only needed if the XPathExpressionEngine class is used). Fixes CONFIGURATION-173. | oheger
| The code for interpreting property keys was refactored out off HierarchicalConfiguration. Instead this class now supports pluggable expression engines (using the setExpressionEngine() method). So it is possible to plug in different expression languages. A default expression engine is provided that understands the native expression language used by hierarchical configurations in older versions. During the process of this refactoring some methods of HierarchicalConfiguration have been deprecated; they will not be called any more when searching or adding properties. These are the following: createAddPath(), fetchAddNode(), findLastPathNode(), findPropertyNodes(). | oheger
| A larger refactoring was performed on the inner Node class of HierarchicalConfiguration: A ConfigurationNode interface was extracted for which a default implementation (DefaultConfigurationNode) is provided. HierarchicalConfiguration.Node now extends this default implementation. The new ConfigurationNode interface defines some more methods than the Node class did originally for conveniently dealing with sub nodes and attributes. HierarchicalConfiguration now uses the new type ConfigurationNode whereever possible. Some methods dealing with Node objects have been deprecated and replaced by versions operating on ConfigurationNode objects instead. | oheger
| All configuration classes derived from Abstrac tConfiguration now allow to set an instance specific list delimiter. This can be done through the new method setListDelimiter(). As before it is possible to define a default list delimiter, which will be used if no instance specific delimiter is set. This can be done using the new setDefaultListDelimiter() method (the methods get/setDelimiter() have been deprecated). With the new setDelimiterParsingDisabled() method parsing of lists can be disabled at all. Fixes CONFIGURATION-155. Thanks to Jorge Ferrer. | oheger

## Release 1.2 - 2005-12-17

Type | Changes | By
--- | --- | ---

## Release 1.2-rc3 - 2005-12-07

Type | Changes | By
--- | --- | ---
| Commons Configuration now declares a dependency to Xalan. As with Xerces this dependency is only needed for JDK 1.3. It was introduced in a process of making Configuration buildable on a JDK 1.3. Documentation about the build process was also added. | oheger
| The dependency to Commons Beanutils Collections was unnecessary and thus removed. | oheger
| Commons Configuration now depends on Commons Digester 1.6 instead of 1.5. (This was done only to pick up the latest available release of digester.) | oheger

## Release 1.2-rc2 - 2005-11-23

Type | Changes | By
--- | --- | ---
| ConfigurationDynaBean now implements the java.util.Map interface (as was stated in the javadocs). This was done by deriving the class from ConfigurationMap. Fixes CONFIGURATION-2. | oheger

## Release 1.2-rc1 - 2005-11-11

Type | Changes | By
--- | --- | ---
| The reload() method in AbstractFileConfiguration was updated to prevent reentrant invocation, which may be caused by some methods when they are called during a reloading operation. Fixes CONFIGURATION-33. | oheger
| AbstractHierarchicalFileConfiguration, a new base class for file based hierarchical configurations, was introduced. XMLConfiguration now extends this class. | ebourg, oheger
| XMLConfiguration now prints the used encoding in the xml declaration of generated files. In earlier versions always the default encoding was written. PropertiesConfiguration now always uses the platform specific line separator when saving files. Fixes CONFIGURATION-41. Thanks to Kay Doebl. | oheger
| PropertiesConfiguration now translates properly the escaped unicode characters (like \u1234) used in the property keys. This complies with the specification of java.util.Properties. Fixes CONFIGURATION-8. | ebourg
| ConfigurationConverter.getProperties() now uses the delimiter of the specified configuration to convert the list properties into strings. Fixes CONFIGURATION-123. | ebourg
| The interpolation of variables (${foo}) is now performed in all property getters of AbstractConfiguration and DataConfiguration. As a side effect the Properties object returned by ConfigurationConverter.getProperties() contains only interpolated values. Fixes CONFIGURATION-123. | ebourg
| PropertiesConfiguration now uses the ISO-8859-1 encoding by default instead of the system encoding to comply with the specification of java.util.Properties. Fixes CONFIGURATION-35. | ebourg
| JNDIConfiguration no longer logs an error when attempting to get a property that d oesn't exist in the configuration. Fixes CONFIGURATION-44. | ebourg
| Attempting to load a configuration from a directory instead of a file will now throw a ConfigurationException. Fixes CONFIGURATION-99. | ebourg
| If a multi-valued property was involved in an interpolation operation, AbstractConfiguration created a string representation of the list of all values. This was changed to only use the first value, which makes more sense in this context and is consistent with other getters for single valued properties. Fixes CONFIGURATION-28. | oheger
| If an include file with a relative path cannot be found in the base path, PropertiesConfiguration now also tries to resolve it based on its own location. Fixes CONFIGURATION-83. | oheger
| Fixed MapConfiguration to store the list of values added under a same key instead of the last value added. Fixes CONFIGURATION-117. Thanks to Steve Bate. | ebourg
| Fixed a bug in the handling of relative file names in ConfigurationFactory: In most cases relative file names were not resolved relative to the location of the configuration definition file as stated in the documentation. This behavior was now changed to always be in sync with the documentation. This may have an impact on existing code which uses workarounds for the erroneous resolving mechanism. Fixes CONFIGURATION-80. | oheger
| Empty elements or elements whose content consists only of comments or whitespace are now taken into account by XMLConfiguration. They are added to the configuration; their value is an empty string. Fixes CONFIGURATION-6. | oheger
| XMLConfiguration now sets a valid system id in the InputSource used for loading files. This enables XML parsers to correctly resolve relative files, e.g. DTDs. | oheger
| getKeys() in HierarchicalConfiguration now returns the keys in the same order the properties were inserted. Fixes CONFIGURATION-74. | ebourg
| Commons Configuration now depends on Commons Collections 3.1 instead of 3.0 | ebourg
| New configurations implementing the "property list" format used in NeXT/OpenStep and its XML variant used in Mac OS X. (PropertyListConfiguration and XMLPropertyListConfiguration) Fixes CONFIGURATION-195. | ebourg
| Resolved some issues with XMLConfiguration and properties containing the delimiter character. These properties are now correctly treated, escaping the delimiter will work, too. Fixes CONFIGURATION-97. | oheger
| Added support for XMLPropertiesConfiguration in ConfigurationFactory. A < properties> element will generate a XMLPropertiesConfiguration if the filename ends with ".xml". | ebourg
| PropertiesConfiguration now supports escaped key/value separators in the keys (i.e foo\:key = bar). Fixes CONFIGURATION-184. | ebourg
| PropertiesConfiguration now supports all key/value separators supported by java.util.Properties ('=', ':' and white space characters). Fixes CONFIGURATION-166. | ebourg
| Commons Configuration now depends on Commons Lang 2.1 instead of 2.0 | ebourg
| Comment lines for PropertiesConfiguration can start with the '!' char (compatibility with java.util.Properties). Fixes CONFIGURATION-207. | ebourg
| Because ConfigurationUtils.copy() does not fully support hierarchical configurations a clone() method was added to HierarchicalConfiguration that can be used instead. Fixes CONFIGURATION-84. | oheger
| XMLConfiguration now provides some support for validating XML documents. With the setValidating() method DTD validation can be enabled. It is also possible to set a custom DocumentBuilder allowing a caller to perform enhanced configuration of the XML loading process. Fixes CONFIGURATION-206. | oheger
| AbstractFileConfiguration now always sets a valid base path if the configuration file could be located. This allows PropertiesConfiguration to resolve include files even when loaded from class path. Fixes CONFIGURATION-121. | oheger
| Updated XMLConfiguration to correctly deal with properties containing dots in their names. Such properties could not be accessed before. Fixes CONFIGURATION-85. | oheger
| PropertiesConfiguration's handling of backslash characters at the end of line was incorrect when there was an even number of trailing backslashes. This is now fixed. Fixes CONFIGURATION-9. | oheger
| Fixed a problem related to file based configurations that are loaded from a URL which is application/x-www-form-urlencoded: the save() method would store such files at a wrong location. Fixes CONFIGURATION-130. | oheger
| Updated FileChangedRe loadingStrategy to use the file based configuration's source URL to find the file to watch. Before that it was possible that the strategy checked the wrong file. For configuration files loaded from a jar FileChangedReloadingStrategy now checks the jar file itself for changes. Finally a bug was fixed which caused the strategy to check the watched file's last change date on every invocation of its reloadingRequired() method ignoring its refresh delay. Thanks to Jorge Ferrer. Fixes CONFIGURATION-50. | oheger
| Fixed a bug in the collaboration between XMLConfiguration and its reloading strategy: The configuration did not check its reloading strategy, so no reload was performed. Fixes CONFIGURATION-62. | oheger
| Disabled auto save mode during PropertiesConfiguration.load(). Prior it was possible that the properties file to be loaded was immideately overwritten. Fixes CONFIGURATION-119. | oheger
| Under certain circumstances it was possible that a reloading strategy set for PropertiesConfiguration interferred with the save() method causing the configuration file to be erased. This has now been fixed. Fixes CONFIGURATION-89. | oheger
| AbstractFileConfiguration now stores the URL of the config file in the load() methods. This URL is reused by the save() method to ensure that the same file is written. Fixes CONFIGURATION-94. Thanks to Jamie M. Guillemette. | oheger
| XMLPropertiesConfiguration no longer depends on Digester to parse the configuration file, it's now implemented with a pure SAX parser. Thanks to Alistair Young. | ebourg
| Fixed a bug which causes XMLConfiguration.save to lose attribute values under some circumstances. The clear() method now also ensures that the associated DOM document is always cleared. Fixes CONFIGURATION-49. Thanks to Mi Zhang. | oheger
| XMLConfiguration now parse the configuration using the encoding declared in the XML header instead of the OS default encoding. Fixes CONFIGURATION-13. Thanks to Kunihara Tetsuya. | ebourg
| XMLConfiguration now uses the delimiter set by setDelimiter(char). Thanks to Zsolt Koppany. | ebourg

## Release 1.1 - 2005-04-02

Type | Changes | By
--- | --- | ---
| Fixed a ConcurrentModificationException thrown when calling clear() on a SubsetConfiguration applied to a BaseConfiguration. Fixes CONFIGURATION-134. | ebourg
| The resolveContainerStore() method in AbstractConfiguration now works properly with arrays of objects and arrays of primitives. This means it is possible to store an array of value in the configuration and retrieve the first element with the getString(), getInt()... methods. Fixes CONFIGURATION-81. | ebourg

## Release 1.1-rc2 - 2005-03-06

Type | Changes | By
--- | --- | ---
| Updated documentation for FileConfiguration's load() methods. Fixed a problem in XMLConfiguration with the output of the save() method when multiple files were loaded. Fixes CONFIGURATION-118. | oheger
| Fixed a bug in FileChangedReloadingStrategy preventing the detection of a file change in some cases. | ebourg
| Changed getXXXArray() and getXXXList() in DataConfiguration to return an empty array/list for empty values. | ebourg
| Fixed getLongArray(), getFloatArray() and getDoubleArray() in DataConfiguration, the values were cast into integers. Fixes CONFIGURATION-58. | ebourg

## Release 1.1-rc1 - 2005-02-13

Type | Changes | By
--- | --- | ---
| ConfigurationFactory now always configures digester to use the context classloader. This avoids problems in application server environments, which use their own version of digester. Thanks to Mike Colbert for the patch! Fixes CONFIGURATION-88. | oheger
| Added a new configuration, XMLPropertiesConfiguration, supporting the new XML format for java.util.Properties introduced in Java 1.5. A 1.5 runtime is not required to use this class. Fixes CONFIGURATION-148. | ebourg
| Added a comment header to PropertiesConfiguration. The header is not parsed when the file is loaded yet. Fixes CONFIGURATION-190. | ebourg
| Added the setEncoding(String) and the getEncoding() methods to the FileConfiguration interface to control the encoding of the configuration file. | ebourg
| Access to the top level element of the XML document is now provided. For newly created configurations this element can be changed before the document is written. Fixes CONFIGURATION-210. | oheger
| Merged the two XML related configuration classes into one new class XMLConfiguration. This new class should provide the best of its ancestors. Fixes CONFIGURATION-168. | oheger
| Replaced the PropertyTokenizer inner class in AbstractConfiguration with the split method in PropertyConverter. Also moved the method building an iterator on the elements of a composite value in PropertyConverter as toIterator(). | ebourg
| Some cleanup of the handling of the base path in file based configurations. The base path is now always taken into account. Fixes CONFIGURATION-15. | oheger
| Calling getProperties on a JNDIConfiguration no longer throws an UnsupportedOperationException. | ebourg
| Removed the getPropertyDirect method from AbstractConfiguration, concrete configurations now implement directly the getProperty method from the Configuration interface. | ebourg
| Added implementation of a save() method for HierarchicalXMLConfiguration. Fixes CONFIGURATION-187. | oheger
| Constructing a file based configuration with a File no longer throws an exception when the file doesn't exist. | ebourg
| Saving a configuration now creates the path to the file if it doesn't exist. | ebourg
| AbstractFileConfiguration.save(File) no longer fails silently when an error occurs, a ConfigurationException is thrown instead. Fixes CONFIGURATION-45. | ebourg
| ConfigurationUtils.locate() now checks if the URL based resources exist. This fixes a bug preventing configuration files from being found if the configuration descriptor is in a JAR file (reported by Grant Ingersoll). | ebourg
| Fixed NPE that were caused in the constructors of file based configurations if an invalid file name was specified. Fixes CONFIGURATION-96. | oheger
| Added support for optional configuration sources in definition files for ConfigurationFactory. A new optional attribute allows to specify whether a configuration source is mandatory or optional. Fixes CONFIGURATION-162. | oheger
| JNDIConfiguration.getKeys() now returns an empty iterator instead of throwing a ConfigurationRuntimeException when a NamingException occurs. The NamingExceptions are now logged. | ebourg
| DatabaseConfiguration.isEmpty() now returns true if an SQLException occurs. | ebourg
| Added two methods copy(Configuration, Configuration) and append(Configuration, Configuration) in ConfigurationUtils to copy properties between configurations. | ebourg
| Moved the constructors implementations from PropertiesConfiguration and XMLConfiguration to AbstractFileConfiguration. | ebourg
| Remove deprecated getVector() implementations. | epugh
| File based configurations can now be automatically reloaded when the underlying file is modified. Fixes CONFIGURATION-147. | ebourg
| Added a clear() method to the Configuration interface to remove all properties. Fixes CONFIGURATION-156. | ebourg
| Added a SystemConfiguration wrapping the system properties. ConfigurationFactory recognizes the corresponding < system/ > element. Fixes CONFIGURATION-208. | ebourg
| Added a MapConfiguration to turn any Map into a Configuration. The getConfiguration() methods in ConfigurationConverter now use MapConfiguration, as a result the Configuration returned is always synchronized with the underlying Properties or ExtendedProperties, changes made to the Configuration are available in the Properties, and reciprocally. | ebourg
| The "autoSave" feature of XMLConfiguration has been generalized to all file based configurations. Fixes CONFIGURATION-146. | ebourg
| Numeric properties can now be specified in hexadecimal format, for example "number = 0xC5F0". Fixes CONFIGURATION-191. | ebourg
| Fixed HierarchicalConfiguration.getKeys(String), it returned an empty iterator if the prefix string contained indices. Fixes CONFIGURATION-36. | oheger
| Added a DataConfiguration decorator providing getters for all useful types found in a configuration (URL, Locale, Date, Calendar, Color, lists and arrays) | ebourg
| Added 5 new configurations to be used in a web environment: AppletConfiguration, ServletConfiguration, ServletContextConfiguration, ServletRequestConfiguration, ServletFilterConfiguration. | ebourg

## Release 1.0 - 2004-10-11

Type | Changes | By
--- | --- | ---
| The getStringArray() method in CompositeConfiguration now interpolates the strings. Fixes CONFIGURATION-66. | ebourg
| SubsetConfiguration now shares the "throwExceptionOnMissing" property with its parent. Fixes CONFIGURATION-23. | ebourg
| Removed "file:" at the beginning of the base path when calli ng setFile() on a FileConfiguration. This prevented auto saving an XMLConfiguration loaded from a File (issue reported by Mark Roth). | ebourg
| All NamingEnumerations in JNDIConfiguraiton are now properly closed (Suggested by Eric Jung). | ebourg
| Properties added to an XMLConfiguration are no longer duplicated in the resulting XML file. Fixes CONFIGURATION-90. | ebourg

## Release 1.0-rc2 - 2004-09-24

Type | Changes | By
--- | --- | ---
| Unified the mechanisms for loading and saving file based configurations. PropertiesConfiguration, XMLConfiguration and HierarchicalXMLConfiguration now implement the same FileConfiguration interface. BasePathLoader, BasePathConfiguration, ClassPropertiesConfiguration and BasePropertiesConfiguration have been removed. | ebourg
| Replaced the calls to Boolean.booleanValue(boolean) in AbstractConfiguration and ConfigurationDynaBean to be Java 1.3 compatible. Fixes CONFIGURATION-22. | ebourg
| Changing the prefix of a JNDIConfiguration will now reset the base context used. Fixes CONFIGURATION-112. | ebourg
| The context used by JNDIConfiguration can be specified in its constructor or through the setContext() method. The context can be accessed with the getContext() method which is now public. Thanks to Eric Jung. | ebourg
| Make the behaviour on missing properties for the get methods that return objects configurable. A property `throwExceptionOnMissing` can be set and then the getters throw an `NoSuchElementException` . The old default behav iour of returning a `null` value has been restored. | henning
| Allow configurations extending AbstractConfiguration to change the delimiter used from "," to something else. Fixes CONFIGURATION-151. | epugh
| PropertiesConfiguration.save() method has issues with preserving the filename | epugh
| Test cases for HierarchicalConfigurationXMLReader stores comments as text nodes. Fixes CONFIGURATION-132. Thanks to Mark Woodman. | epugh
| Clarify for ConfigurationDynaBean that the get method should throw an illegalArgumentException if there is no property specified. Fixes CONFIGURATION-183. Thanks to Ricardo Gladwell. | epugh
| Fixed a ClassCastException when adding a non String property to an XMLConfiguration. Fixes CONFIGURATION-25. | ebourg
| Fixed the handling of attribute properties by HierarchicalConfigurationConverter. Fixes CONFIGURATION-138. Thanks to Oliver Heger. | ebourg
| Fixed a ClassCastException thrown on adding a non string property in a DatabaseConfiguration. Fixes CONFIGURATION-125. | ebourg
| Bring back the getVector() methods in the Configuration interface. These methods are needed for " drop-on " replacement of the various pre-1.0 commons-configuration snapshots and are already deprecated. These methods will be removed for 1.1. | henning

## Release 1.0-rc1 - 2004-08-14

Type | Changes | By
--- | --- | ---
| HierarchicalConfigurationXMLReader stores comments as text nodes. Fixes CONFIGURATION-132. Thanks to Oliver Heger. | epugh
| project.xml contains bad dependencies. Fixes CONFIGURATION-122. Thanks to Ricardo Gladwell. | epugh
| clearXmlProperty doesn't remove list properties completely. Fixes CONFIGURATION-64. Thanks to Brent Worden. | epugh
| new ConfigurationDynaBean. Fixes CONFIGURATION-183. Thanks to Ricardo Gladwell. | epugh
| new ConfigurationMap and ConfigurationSet. Fixes CONFIGURATION-185. Thanks to Ricardo Gladwell. | epugh
| Problem adding property XMLConfiguration. Fixes CONFIGURATION-91. Thanks to Ricardo Gladwell. | epugh
| ConfigurationXMLDocument removed until post 1.0. | epugh
| DatabaseConfiguration doesn't support List properties. Fixes CONFIGURATION-18. | epugh
| Fixed several bugs related to XMLConfiguration: Can't add a new property as an attribute in XMLConfiguration XMLConfiguration doesn't support attribute names with a dot XMLConfiguration doesn't ignore comments XMLConfiguration.save() doesn't escape reserved characters Fixes CONFIGURATION-137 , CONFIGURATION-116 , CONFIGURATION-4 and CONFIGURATION-32 . | ebourg
| Added save methods in XMLConfiguration similar to PropertiesConfiguration to save the configuration to another file. Fixes CONFIGURATION-114. | ebourg
| Removed the DOM4J implementations in favor of the DOM ones. DOMConfiguration has been rename d to XMLConfiguration, and HierarchicalDOMConfiguration to HierarchicalXMLConfiguration. The elements parsed by the ConfigurationFactory have been changed accordingly. | ebourg
| Added a save() method to PropertiesConfiguration and save(Writer out), save(OutputStream out), save(OutputStream out, String encoding) to BasePropertiesConfiguration. | ebourg
| List values are now properly stored as comma separated values in the Properties object returned by ConfigurationConverter.getProperties() Fixes CONFIGURATION-98. | ebourg
| Introduced a ConversionException thrown when the value of a property is not compatible the type requested. It replaces the ClassCastException and the NumberFormatException thrown previously. | ebourg
| Tokens like ${ref} in a PropertyConfiguration are now properly saved. Fixes CONFIGURATION-174. | ebourg
| The getList() method of a CompositeConfiguration now returns the list composed of the elements in the first matching configuration and the additional elements found in the in memory configuration. Fixes CONFIGURATION-127. | ebourg
| SubsetConfiguration returns a List on getList(). AbstractConfiguration wouldn't properly deal with a List, only with a Container for getList()! Thanks to jschaible for the unit test. | epugh
| Direct support of XML via DOM. New classes DOMConfiguration and HierarchicalDOMConfiguration. | jschaible
| Update build to not include test configuration files in resulting jar. | jschaible
| Refactored JNDIConfiguration to use AbstractConfiguration. | ebourg
| Fixed invalid subsets by refactoring out the subset logic into a SubsetConfiguration. Fixes CONFIGURATION-76. | ebourg
| Reapply the ConfigurationXMLDocument that went missing during migration out of sandbox. | oheger
| Apply ASL 2.0 license. Thanks to Jeff Painter for scripting the conversion! | epugh
| Changed CompositeConfiguration to extend from AbstractConfiuration. This means that the behavior of CompositeConfiguration is much similar to others like PropertiesConfiguration in handling of missing keys, interpolation, etc.. Previously CompositeConfiguration had quite a few differences. | epugh
| Removed "defaults" from BaseConfiguration. Defaults are now done via using a CompositeConfiguration, either directly or via a ConfigurationFactory. if you want to save changes made to a Configuration, then you use a CompositeConfiguration and get back the inMemoryConfiguration that has the delta of changes. Added a bit of documentation on this. | epugh
| Enhancement: Configuration Comparator. Fixes CONFIGURATION-154. | epugh
| BaseConfiguration: containsKey ignores default properties. I have changed it so that now the defaults are paid attention to. Fixes CONFIGURATION-54. | epugh
| The Configuration interface now supports BigDecimal and BigInteger numbers. | ebourg
| ConfigurationException is now thrown by public methods instead of Exception or IOException or whatnot. | epugh
| For configuration based on properties files, allow characters like \n etc to be escaped and unescaped. | ebourg
| New DatabaseConfiguration that uses a database to store the properties. It supports 2 table structures : one table per configuration (2 colums key/value) one table for multiple configurations (2 columns key/value + 1 column for the name of the configuration) | ebourg
| ConfigurationFactory now supports the hierarchicalDom4j element in configuration definition file | oheger
| Change all Vector objects to List objects. | ebourg
| ConfigurationFactory now supports two types of properties files, additional and override. Additional properties add each other together. Override override each other. This allows you to have a single property that is either aggregated from a number of sources, or have a property that is overridden according to a specific order of sources. | oheger
| AbstractConfiguration addProperty now delegates to an abstract addPropertyDirect implemented by BaseConfiguration. | oheger
| Changed getString() method to throw a NoSuchElementException instead of "" if the configuration property doesn't exist. | kshaposhnikov
| Added AbstractConfiguration to make it easier to create subclasses by only having to implement the methods required. | kshaposhnikov
| ClassPropertiesConfiguration Additions Use the classloader of class that is provided by the constructor. Add a constructor that indicates whether to use relative or absolute. Change getPropertyStream to utilize the relative or absolute flag. Add a test case that checks that absolute paths work. | bdunbar
| JNDIConfiguration.getKeys() Addition The JNDIConfiguration.getKeys() method was returning an unsupported operation error. However, this is an important method to have supported. | epugh
| CompositeConfiguration.getKeys() Fix The CompositeConfiguration.getKeys() method was returning an unordered list of configuration values. However, many apps expect the order that keys are returned to be the order they are added into the properties file. | epugh