You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by oh...@apache.org on 2014/09/24 22:29:02 UTC
svn commit: r923442 [7/7] -
/websites/production/commons/content/proper/commons-configuration/javadocs/v1.10/userguide/
Added: websites/production/commons/content/proper/commons-configuration/javadocs/v1.10/userguide/overview.html
==============================================================================
--- websites/production/commons/content/proper/commons-configuration/javadocs/v1.10/userguide/overview.html (added)
+++ websites/production/commons/content/proper/commons-configuration/javadocs/v1.10/userguide/overview.html Wed Sep 24 20:29:01 2014
@@ -0,0 +1,480 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 24 September 2014
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="iso-8859-1" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="author" content="Eric Pugh" />
+ <meta name="author" content="Emmanuel Bourg" />
+ <meta name="Date-Revision-yyyymmdd" content="20140924" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Commons Configuration -
+ Configuration Overview</title>
+
+ <link rel="stylesheet" href="../css/bootstrap.min.css" type="text/css" />
+ <link rel="stylesheet" href="../css/site.css" type="text/css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+ <script type="text/javascript" src="../js/jquery.min.js"></script>
+ <script type="text/javascript" src="../js/bootstrap.min.js"></script>
+ <script type="text/javascript" src="../js/prettify.min.js"></script>
+ <script type="text/javascript" src="../js/site.js"></script>
+
+
+<link rel="stylesheet" type="text/css" media="all" href="../css/prettify.css"/>
+<script src="../js/prettify.js" type="text/javascript"></script>
+<script type="text/javascript">window.onload=function() {
+ prettyPrint();
+ }</script>
+ </head>
+
+ <body class="composite">
+ <a href="http://commons.apache.org/" id="bannerLeft" title="Apache Commons logo">
+ <img class="logo-left" src="../images/commons-logo.png" alt="Apache Commons logo"/>
+ </a>
+ <a href="../index.html" id="bannerRight">
+ <img class="logo-right" src="../images/logo.png" alt="Commons Configuration"/>
+ </a>
+ <div class="clear"></div>
+
+ <div class="navbar">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a class="brand" href="http://commons.apache.org/proper/commons-configuration/">Apache Commons Configuration ™</a>
+ <ul class="nav">
+
+ <li id="publishDate">Last Published: 24 September 2014</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 1.10</li>
+ </ul>
+ <div class="pull-right"> <ul class="nav">
+ <li>
+ <a href="http://www.apachecon.com/" class="externalLink" title="ApacheCon">
+ ApacheCon</a>
+ </li>
+ <li>
+ <a href="http://www.apache.org" class="externalLink" title="Apache">
+ Apache</a>
+ </li>
+ <li>
+ <a href="../../../" title="Commons">
+ Commons</a>
+ </li>
+ </ul>
+</div>
+ </div>
+ </div>
+ </div>
+
+ <div class="container-fluid">
+ <table class="layout-table">
+ <tr>
+ <td class="sidebar">
+ <div class="well sidebar-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Configuration</li>
+ <li class="none">
+ <a href="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="none">
+ <a href="../../../configuration/download_configuration.cgi" title="Download">
+ Download</a>
+ </li>
+ <li class="none">
+ <a href="../changes-report.html" title="Release History">
+ Release History</a>
+ </li>
+ <li class="none">
+ <a href="../userguide/user_guide.html" title="User's Guide">
+ User's Guide</a>
+ </li>
+ <li class="none">
+ <a href="../dependencies.html" title="Runtime Dependencies">
+ Runtime Dependencies</a>
+ </li>
+ <li class="none">
+ <a href="../apidocs/index.html" title="Javadoc">
+ Javadoc</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header"><i class="icon-cog"></i>Development</li>
+ <li class="none">
+ <a href="../building.html" title="Building">
+ Building</a>
+ </li>
+ <li class="none">
+ <a href="../issue-tracking.html" title="Issue Tracking">
+ Issue Tracking</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header"><i class="icon-info-sign"></i>Project Documentation</li>
+ <li class="collapsed">
+ <a href="../project-info.html" title="Project Information">
+ Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="../project-reports.html" title="Project Reports">
+ Project Reports</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Commons</li>
+ <li class="none">
+ <a href="../../../" title="Home">
+ Home</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/licenses/" class="externalLink" title="License">
+ License</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../../components.html" title="Components">
+ Components</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../../sandbox/index.html" title="Sandbox">
+ Sandbox</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../../dormant/index.html" title="Dormant">
+ Dormant</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">General Information</li>
+ <li class="none">
+ <a href="../../../volunteering.html" title="Volunteering">
+ Volunteering</a>
+ </li>
+ <li class="none">
+ <a href="../../../patches.html" title="Contributing Patches">
+ Contributing Patches</a>
+ </li>
+ <li class="none">
+ <a href="../../../building.html" title="Building Components">
+ Building Components</a>
+ </li>
+ <li class="none">
+ <a href="../../../releases/index.html" title="Releasing Components">
+ Releasing Components</a>
+ </li>
+ <li class="none">
+ <a href="http://wiki.apache.org/commons/FrontPage" class="externalLink" title="Wiki">
+ Wiki</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">ASF</li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How the ASF works">
+ How the ASF works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/getinvolved.html" class="externalLink" title="Get Involved">
+ Get Involved</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/dev/" class="externalLink" title="Developer Resources">
+ Developer Resources</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">
+ Sponsorship</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
+ Thanks</a>
+ </li>
+ </ul>
+ </div>
+ <div id="poweredBy">
+ <a href="http://www.apache.org/events/current-event.html" title="ApacheCon" class="builtBy">
+ <img class="builtBy" alt="ApacheCon" src="http://www.apache.org/events/current-event-125x125.png" />
+ </a>
+ <a href="http://maven.apache.org/" title="Maven" class="builtBy">
+ <img class="builtBy" alt="Maven" src="http://maven.apache.org/images/logos/maven-feather.png" />
+ </a>
+ </div>
+ </td>
+ <td class="content">
+ <!-- Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License. -->
+
+
+ <div class="section">
+<h2>Using Configuration<a name="Using_Configuration"></a></h2>
+
+<p>
+ Commons Configuration allows you to access configuration properties from
+ a variety of different sources. No matter if they are stored in a properties file,
+ a XML document, or a JNDI tree, they can all be accessed in the same way
+ through the generic <tt><a href="../apidocs/org/apache/commons/configuration/Configuration.html">Configuration</a></tt>
+ interface.
+ </p>
+
+<p>
+ Another strength of Commons Configuration is its ability to mix configurations
+ from heterogeneous sources and treat them like a single logic configuration.
+ This section will introduce you to the different configurations
+ available and will show you how to combine them.
+ </p>
+
+
+<div class="section">
+<h3>Configuration Sources<a name="Configuration_Sources"></a></h3>
+
+<p>
+ Currently there are quite a number of different sources of Configuration objects. But,
+ by just using a Configuration object versus a specific type like XMLConfiguration or
+ JNDIConfiguration, you are sheltered from the mechanics of actually retrieving the
+ configuration values. These various sources include:
+ </p>
+<ul>
+
+<li>
+ <b>PropertiesConfiguration</b>
+ Loads configuration values from a properties file.
+ </li>
+
+<li>
+ <b>XMLConfiguration</b>
+ Takes values from an XML document.
+ </li>
+
+<li>
+ <b>INIConfiguration</b>
+ Loads the values from a .ini file as used by Windows.
+ </li>
+
+<li>
+ <b>PropertyListConfiguration</b>
+ Loads values from an OpenStep .plist file. XMLPropertyListConfiguration is also
+ available to read the XML variant used by Mac OS X.
+ </li>
+
+<li>
+ <b>JNDIConfiguration</b>
+ Using a key in the JNDI tree, can retrieve values as configuration properties.
+ </li>
+
+<li>
+ <b>BaseConfiguration</b>
+ An in-memory method of populating a Configuration object.
+ </li>
+
+<li>
+ <b>HierarchicalConfiguration</b>
+ An in-memory Configuration object that is able to deal with complex
+ structured data.
+ </li>
+
+<li>
+ <b>SystemConfiguration</b>
+ A configuration using the system properties
+ </li>
+
+<li>
+ <b>ConfigurationConverter</b>
+ Takes a java.util.Properties or an org.apache.commons.collections.ExtendedProperties
+ and converts it to a Configuration object.
+ </li>
+ </ul>
+
+
+ </div>
+
+
+<div class="section">
+<h3>Mixing Configuration Sources<a name="Mixing_Configuration_Sources"></a></h3>
+
+<p>
+ Often you want to provide a base set of configuration values, but allow the user to easily
+ override them for their specific environment. Well one way is to hard code the default
+ values into your code, and have then provide a property file that overrides this. However,
+ this is a very rigid way of doing things. Instead, with the <tt>CompositeConfiguration</tt>
+ you can provide many different ways of setting up a configuration. You can either do it
+ manually:
+ </p>
+
+
+<div class="source">
+<pre>
+CompositeConfiguration config = new CompositeConfiguration();
+config.addConfiguration(new SystemConfiguration());
+config.addConfiguration(new PropertiesConfiguration("application.properties"));
+</pre></div>
+
+
+<p>or via the <tt>ConfigurationFactory</tt> class:</p>
+
+
+<div class="source">
+<pre>
+ConfigurationFactory factory = new ConfigurationFactory("config.xml");
+Configuration config = factory.getConfiguration();
+</pre></div>
+
+
+<p>
+ The <tt>config.xml</tt> file used in the example above is a configuration descriptor,
+ it specifies the Configuration objects to load. Here is an example of descriptor:
+ </p>
+
+
+<div class="source">
+<pre>
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+
+<configuration>
+ <system/>
+ <properties fileName="application.properties"/>
+</configuration>
+</pre></div>
+
+
+<p>
+ What this says is that we are loading up all system properties, as well as the properties
+ file <tt>application.properties</tt>. The order of precedence is first to last. So in
+ the above example, if a property is not found in the system properties, it'll be searched
+ in the properties file. This allows you to set up default values in a properties file, and
+ override them with the system properties.
+ </p>
+ </div>
+
+
+<div class="section">
+<h3>The Configuration interface<a name="The_Configuration_interface"></a></h3>
+
+<p>
+ All the classes in this package that represent different kinds of configuration
+ sources share a single interface:
+ <tt><a href="../apidocs/org/apache/commons/configuration/Configuration.html">Configuration</a></tt>.
+ This interface allows you to access and manipulate configuration properties
+ in a generic way.
+ </p>
+
+<p>
+ A major part of the methods defined in the <tt>Configuration</tt>
+ interface deals with retrieving properties of different data types. All
+ these methods take a key as an argument that points to the desired
+ property. This is a string value whose exact meaning depends on the
+ concrete <tt>Configuration</tt> implementation used. They try to
+ find the property specified by the passed in key and convert it to their
+ target type; this converted value will be returned. There are also
+ overloaded variants of all methods that allow to specify a default value,
+ which will be returned if the property cannot be found. The following
+ data types are supported:
+ </p>
+<ul>
+
+<li>BigDecimal</li>
+
+<li>BigInteger</li>
+
+<li>boolean</li>
+
+<li>byte</li>
+
+<li>double</li>
+
+<li>float</li>
+
+<li>int</li>
+
+<li>long</li>
+
+<li>short</li>
+
+<li>String</li>
+ </ul>
+ The names of these methods start with <tt>get</tt> followed by their
+ data type. The <tt>getString()</tt> method for instance will return
+ String values, <tt>getInt()</tt> will operate on integers.
+
+
+<p>
+ Properties can have multiple values, so it is also possible to query a
+ list containing all of the available values. This is done using the
+ <tt>getList()</tt> method.
+ </p>
+
+<p>
+ For manipulating properties or their values the following methods can
+ be used:
+ </p>
+<dl>
+
+<dt><tt>addProperty()</tt></dt>
+
+<dd>Adds a new property to the configuration. If this property already
+ exists, another value is added to it (so it becomes a multi-valued
+ property).</dd>
+
+<dt><tt>clearProperty()</tt></dt>
+
+<dd>Removes the specified property from the configuration.</dd>
+
+<dt><tt>setProperty()</tt></dt>
+
+<dd>Overwrites the value of the specified property. This is the same
+ as removing the property and then calling <tt>addProperty()</tt>
+ with the new property value.</dd>
+
+<dt><tt>clear()</tt></dt>
+
+<dd>Wipes out the whole configuration</dd>
+ </dl>
+
+ </div>
+
+
+<div class="section">
+<h3>Threading issues<a name="Threading_issues"></a></h3>
+
+<p>
+ The most concrete implementations of the <tt>Configuration</tt>
+ interface that are shipped with this library are not thread-safe.
+ They can be accessed concurrently in a read-only manner. However if one
+ thread modifies a configuration object, manual synchronization has to be
+ performed to ensure correctness of data. Notes about the thread
+ safety of conrete implementation classes can be found in the Javadocs
+ for these classes.
+ </p>
+ </div>
+ </div>
+
+
+
+ </td>
+ </tr>
+ </table>
+ </div>
+
+ <div class="footer">
+ <p>Copyright © 2001-2014
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.</p>
+
+<div class="center">Apache Commons, Apache Commons Configuration, Apache, the Apache feather logo, and the Apache Commons project logos are trademarks of The Apache Software Foundation.
+ All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
+ </div>
+ </body>
+
+</html>
Added: websites/production/commons/content/proper/commons-configuration/javadocs/v1.10/userguide/user_guide.html
==============================================================================
--- websites/production/commons/content/proper/commons-configuration/javadocs/v1.10/userguide/user_guide.html (added)
+++ websites/production/commons/content/proper/commons-configuration/javadocs/v1.10/userguide/user_guide.html Wed Sep 24 20:29:01 2014
@@ -0,0 +1,449 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 24 September 2014
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="iso-8859-1" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20140924" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Commons Configuration -
+ Commons Configuration User's Guide</title>
+
+ <link rel="stylesheet" href="../css/bootstrap.min.css" type="text/css" />
+ <link rel="stylesheet" href="../css/site.css" type="text/css" />
+ <link rel="stylesheet" href="../css/print.css" media="print" />
+
+ <script type="text/javascript" src="../js/jquery.min.js"></script>
+ <script type="text/javascript" src="../js/bootstrap.min.js"></script>
+ <script type="text/javascript" src="../js/prettify.min.js"></script>
+ <script type="text/javascript" src="../js/site.js"></script>
+
+
+<link rel="stylesheet" type="text/css" media="all" href="../css/prettify.css"/>
+<script src="../js/prettify.js" type="text/javascript"></script>
+<script type="text/javascript">window.onload=function() {
+ prettyPrint();
+ }</script>
+ </head>
+
+ <body class="composite">
+ <a href="http://commons.apache.org/" id="bannerLeft" title="Apache Commons logo">
+ <img class="logo-left" src="../images/commons-logo.png" alt="Apache Commons logo"/>
+ </a>
+ <a href="../index.html" id="bannerRight">
+ <img class="logo-right" src="../images/logo.png" alt="Commons Configuration"/>
+ </a>
+ <div class="clear"></div>
+
+ <div class="navbar">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a class="brand" href="http://commons.apache.org/proper/commons-configuration/">Apache Commons Configuration ™</a>
+ <ul class="nav">
+
+ <li id="publishDate">Last Published: 24 September 2014</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 1.10</li>
+ </ul>
+ <div class="pull-right"> <ul class="nav">
+ <li>
+ <a href="http://www.apachecon.com/" class="externalLink" title="ApacheCon">
+ ApacheCon</a>
+ </li>
+ <li>
+ <a href="http://www.apache.org" class="externalLink" title="Apache">
+ Apache</a>
+ </li>
+ <li>
+ <a href="../../../" title="Commons">
+ Commons</a>
+ </li>
+ </ul>
+</div>
+ </div>
+ </div>
+ </div>
+
+ <div class="container-fluid">
+ <table class="layout-table">
+ <tr>
+ <td class="sidebar">
+ <div class="well sidebar-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Configuration</li>
+ <li class="none">
+ <a href="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="none">
+ <a href="../../../configuration/download_configuration.cgi" title="Download">
+ Download</a>
+ </li>
+ <li class="none">
+ <a href="../changes-report.html" title="Release History">
+ Release History</a>
+ </li>
+ <li class="none active">
+ <a href="../userguide/user_guide.html" title="User's Guide">
+ User's Guide</a>
+ </li>
+ <li class="none">
+ <a href="../dependencies.html" title="Runtime Dependencies">
+ Runtime Dependencies</a>
+ </li>
+ <li class="none">
+ <a href="../apidocs/index.html" title="Javadoc">
+ Javadoc</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header"><i class="icon-cog"></i>Development</li>
+ <li class="none">
+ <a href="../building.html" title="Building">
+ Building</a>
+ </li>
+ <li class="none">
+ <a href="../issue-tracking.html" title="Issue Tracking">
+ Issue Tracking</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header"><i class="icon-info-sign"></i>Project Documentation</li>
+ <li class="collapsed">
+ <a href="../project-info.html" title="Project Information">
+ Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="../project-reports.html" title="Project Reports">
+ Project Reports</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Commons</li>
+ <li class="none">
+ <a href="../../../" title="Home">
+ Home</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/licenses/" class="externalLink" title="License">
+ License</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../../components.html" title="Components">
+ Components</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../../sandbox/index.html" title="Sandbox">
+ Sandbox</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../../dormant/index.html" title="Dormant">
+ Dormant</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">General Information</li>
+ <li class="none">
+ <a href="../../../volunteering.html" title="Volunteering">
+ Volunteering</a>
+ </li>
+ <li class="none">
+ <a href="../../../patches.html" title="Contributing Patches">
+ Contributing Patches</a>
+ </li>
+ <li class="none">
+ <a href="../../../building.html" title="Building Components">
+ Building Components</a>
+ </li>
+ <li class="none">
+ <a href="../../../releases/index.html" title="Releasing Components">
+ Releasing Components</a>
+ </li>
+ <li class="none">
+ <a href="http://wiki.apache.org/commons/FrontPage" class="externalLink" title="Wiki">
+ Wiki</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">ASF</li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How the ASF works">
+ How the ASF works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/getinvolved.html" class="externalLink" title="Get Involved">
+ Get Involved</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/dev/" class="externalLink" title="Developer Resources">
+ Developer Resources</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">
+ Sponsorship</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
+ Thanks</a>
+ </li>
+ </ul>
+ </div>
+ <div id="poweredBy">
+ <a href="http://www.apache.org/events/current-event.html" title="ApacheCon" class="builtBy">
+ <img class="builtBy" alt="ApacheCon" src="http://www.apache.org/events/current-event-125x125.png" />
+ </a>
+ <a href="http://maven.apache.org/" title="Maven" class="builtBy">
+ <img class="builtBy" alt="Maven" src="http://maven.apache.org/images/logos/maven-feather.png" />
+ </a>
+ </div>
+ </td>
+ <td class="content">
+ <!-- Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License. --><!-- $Id: user_guide.xml 1156502 2011-08-11 06:23:25Z oheger $ -->
+
+
+
+ <div class="section">
+<h2>About this document<a name="About_this_document"></a></h2>
+
+<p>
+ This document describes the features of the Commons Configuration
+ component starting with the very basics and up to the more advanced
+ topics. If you read it in a linear way, you should get a sound
+ understanding of the provided classes and the possibilities they
+ offer. But you can also skip sections and jump directly to the topics
+ you are most interested in.
+ </p>
+ </div>
+
+
+<div class="section">
+<h2>Table of contents<a name="Table_of_contents"></a></h2>
+
+<ul>
+
+<li><a href="overview.html#Using_Configuration">Using Configuration</a></li>
+
+<ul>
+
+<li><a href="overview.html#Configuration_Sources">Configuration Sources</a></li>
+
+<li><a href="overview.html#Mixing_Configuration_Sources">Mixing Configuration Sources</a></li>
+
+<li><a href="overview.html#The_Configuration_interface">The Configuration interface</a></li>
+
+<li><a href="overview.html#Threading_issues">Threading issues</a></li>
+ </ul>
+
+<li><a href="howto_basicfeatures.html#Basic_features_and_AbstractConfiguration">Basic features and AbstractConfiguration</a></li>
+
+<ul>
+
+<li><a href="howto_basicfeatures.html#Handling_of_missing_properties">Handling of missing properties</a></li>
+
+<li><a href="howto_basicfeatures.html#List_handling">List handling</a></li>
+
+<li><a href="howto_basicfeatures.html#Variable_Interpolation">Variable Interpolation</a></li>
+
+<li><a href="howto_basicfeatures.html#Customizing_interpolation">Customizing interpolation</a></li>
+ </ul>
+
+<li><a href="howto_properties.html#Properties_files">Properties files</a></li>
+
+<ul>
+
+<li><a href="howto_properties.html#Using_PropertiesConfiguration">Using PropertiesConfiguration</a></li>
+
+<li><a href="howto_properties.html#Includes">Includes</a></li>
+
+<li><a href="howto_properties.html#Lists_and_arrays">Lists and arrays</a></li>
+
+<li><a href="howto_properties.html#Saving">Saving</a></li>
+
+<li><a href="howto_properties.html#Special_Characters_and_Escaping">Special Characters and Escaping</a></li>
+
+<li><a href="howto_properties.html#Layout_Objects">Layout Objects</a></li>
+
+<li><a href="howto_properties.html#Custom_properties_readers_and_writers">Custom properties readers and writers</a></li>
+ </ul>
+
+<li><a href="howto_filebased.html#File-based_Configurations">File-based Configurations</a></li>
+
+<ul>
+
+<li><a href="howto_filebased.html#Specifying_the_file">Specifying the file</a></li>
+
+<li><a href="howto_filebased.html#Loading">Loading</a></li>
+
+<li><a href="howto_filebased.html#Saving">Saving</a></li>
+
+<li><a href="howto_filebased.html#Automatic_Saving">Automatic Saving</a></li>
+
+<li><a href="howto_filebased.html#Automatic_Reloading">Automatic Reloading</a></li>
+ </ul>
+
+<li><a href="howto_xml.html#Hierarchical_properties">Hierarchical properties</a></li>
+
+<ul>
+
+<li><a href="howto_xml.html#Accessing_properties_in_hierarchical_configurations">Accessing properties in hierarchical configurations</a></li>
+
+<li><a href="howto_xml.html#Complex_hierarchical_structures">Complex hierarchical structures</a></li>
+
+<li><a href="howto_xml.html#Accessing_structured_properties">Accessing structured properties</a></li>
+
+<li><a href="howto_xml.html#Adding_new_properties">Adding new properties</a></li>
+
+<li><a href="howto_xml.html#Escaping_special_characters">Escaping dot characters in property names</a></li>
+
+<li><a href="howto_xml.html#Expression_engines">Expression engines</a></li>
+
+<ul>
+
+<li><a href="howto_xml.html#The_default_expression_engine">The default expression engine</a></li>
+
+<li><a href="howto_xml.html#The_XPATH_expression_engine">The XPATH expression engine</a></li>
+ </ul>
+
+<li><a href="howto_xml.html#Validation_of_XML_configuration_files">Validation of XML configuration files</a></li>
+ </ul>
+
+<li><a href="howto_compositeconfiguration.html#Composite_Configuration_Details">Composite Configuration Details</a></li>
+
+<ul>
+
+<li><a href="howto_compositeconfiguration.html#Setting_Up_Defaults">Setting Up Defaults</a></li>
+
+<li><a href="howto_compositeconfiguration.html#Saving_Changes">Saving Changes</a></li>
+ </ul>
+
+<li><a href="howto_combinedconfiguration.html#Combined_Configuration">Combined Configuration</a></li>
+
+<ul>
+
+<li><a href="howto_combinedconfiguration.html#How_it_works">How it works</a></li>
+
+<li><a href="howto_combinedconfiguration.html#Node_combiners">Node combiners</a></li>
+
+<li><a href="howto_combinedconfiguration.html#Constructing_a_CombinedConfiguration">Constructing a CombinedConfiguration</a></li>
+
+<li><a href="howto_combinedconfiguration.html#Dealing_with_changes">Dealing with changes</a></li>
+ </ul>
+
+<li><a href="howto_beans.html#Declaring_and_Creating_Beans">Declaring and Creating Beans</a></li>
+
+<ul>
+
+<li><a href="howto_beans.html#Basic_Concepts">Basic Concepts</a></li>
+
+<li><a href="howto_beans.html#An_Example">An Example</a></li>
+
+<li><a href="howto_beans.html#Extending_the_Basic_Mechanism">Extending the Basic Mechanism</a></li>
+ </ul>
+
+<li><a href="howto_configurationbuilder.html#Using_DefaultConfigurationBuilder">Using DefaultConfigurationBuilder</a></li>
+
+<ul>
+
+<li><a href="howto_configurationbuilder.html#The_configuration_definition_file">The configuration definition file</a></li>
+
+<li><a href="howto_configurationbuilder.html#Setting_up_a_DefaultConfigurationBuilder">Setting up a ConfigurationFactory</a></li>
+
+<li><a href="howto_configurationbuilder.html#Overriding_properties">Overriding properties</a></li>
+
+<li><a href="howto_configurationbuilder.html#Optional_configuration_sources">Optional configuration sources</a></li>
+
+<li><a href="howto_configurationbuilder.html#Union_configuration">Union configuration</a></li>
+
+<li><a href="howto_configurationbuilder.html#Configuration_definition_file_reference">Configuration definition file reference</a></li>
+
+<li><a href="howto_configurationbuilder.html#An_example">An example</a></li>
+
+<li><a href="howto_configurationbuilder.html#Extending_the_configuration_definition_file_format">Extending the configuration definition file format</a></li>
+ </ul>
+
+<li><a href="howto_multitenant.html#Multi-tenant_Configurations">Multi-tenant Configurations</a></li>
+
+<ul>
+
+<li><a href="howto_multitenant.html#MultiFileHierarchicalConfiguration">MultiFileHierarchicalConfiguration</a></li>
+
+<li><a href="howto_multitenant.html#DynamicCombinedConfiguration">DynamicCombinedConfiguration</a></li>
+
+<li><a href="howto_multitenant.html#Sample_Configuration">Sample Configuration</a></li>
+
+<li><a href="howto_multitenant.html#PatternSubtreeConfigurationWrapper">PatternSubtreeConfigurationWrapper</a></li>
+ </ul>
+
+<li><a href="howto_events.html#Configuration_Events">Configuration Events</a></li>
+
+<ul>
+
+<li><a href="howto_events.html#Configuration_listeners">Configuration listeners</a></li>
+
+<li><a href="howto_events.html#An_example">An example</a></li>
+
+<li><a href="howto_events.html#Error_listeners">Error listeners</a></li>
+ </ul>
+
+<li><a href="howto_utilities.html#Utility_classes_and_Tips_and_Tricks">Utility classes and Tips and Tricks</a></li>
+
+<ul>
+
+<li><a href="howto_utilities.html#Copy_a_configuration">Copy a configuration</a></li>
+
+<li><a href="howto_utilities.html#Converting_a_flat_configuration_into_a_hierarchical_one">Converting a flat configuration into a hierarchical one</a></li>
+
+<li><a href="howto_utilities.html#Converting_between_properties_and_configurations">Converting between properties and configurations</a></li>
+
+<li><a href="howto_utilities.html#Interpolation_of_all_variables">Interpolation of all variables</a></li>
+
+<li><a href="howto_utilities.html#Handling_of_runtime_exceptions">Handling of runtime exceptions</a></li>
+ </ul>
+
+<li><a href="howto_filesystems.html#File_Systems">File Systems</a></li>
+
+<ul>
+
+<li><a href="howto_filesystems.html#File_SystemsConfiguration">Configuration</a></li>
+
+<li><a href="howto_filesystems.html#File_SystemsFile_Options_Provider">File Options Provider</a></li>
+
+<li><a href="howto_filesystems.html#File_SystemsFile_Reloading_Strategy">File Reloading Strategy</a></li>
+ </ul>
+ </ul>
+ </div>
+
+
+
+
+ </td>
+ </tr>
+ </table>
+ </div>
+
+ <div class="footer">
+ <p>Copyright © 2001-2014
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.</p>
+
+<div class="center">Apache Commons, Apache Commons Configuration, Apache, the Apache feather logo, and the Apache Commons project logos are trademarks of The Apache Software Foundation.
+ All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
+ </div>
+ </body>
+
+</html>