| <?xml version="1.0"?> |
| <!-- |
| 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. |
| --> |
| |
| <document> |
| |
| <properties> |
| <title>Commons Configuration User's Guide</title> |
| <author email="oheger@apache.org">Oliver Heger</author> |
| </properties> |
| |
| <body> |
| <section name="About this document"> |
| <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> |
| <p> |
| Note that many features described in this guide are only available |
| since the 1.3 release of Commons Configuration. If you are using |
| a 1.2 version, have a look at the older |
| <a href="howtos_index.html">Howtos</a> documents, which specifically |
| deal with this version. |
| </p> |
| </section> |
| |
| <section name="Table of contents"> |
| <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> |
| </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">Special Characters</a></li> |
| <li><a href="howto_properties.html#Layout_Objects">Layout Objects</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_defined_in_XML_documents">Accessing properties defined in XML documents</a></li> |
| <li><a href="howto_xml.html#Structured_XML">Structured XML</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_dot_characters_in_XML_tags">Escaping dot characters in XML tags</a></li> |
| </ul> |
| <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> |
| <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_configurationfactory.html#Using_a_Configuration_Factory">Using a Configuration Factory</a></li> |
| <ul> |
| <li><a href="howto_configurationfactory.html#The_configuration_definition_file">The configuration definition file</a></li> |
| <li><a href="howto_configurationfactory.html#Setting_up_a_ConfigurationFactory">Setting up a ConfigurationFactory</a></li> |
| <li><a href="howto_configurationfactory.html#Accessing_properties">Accessing properties</a></li> |
| </ul> |
| <li><a href="howto_configurationfactory.html#Multiple_configuration_sources">Multiple configuration sources</a></li> |
| <ul> |
| <li><a href="howto_configurationfactory.html#Overriding_properties">Overriding properties</a></li> |
| <li><a href="howto_configurationfactory.html#Optional_configuration_sources">Optional configuration sources</a></li> |
| </ul> |
| <li><a href="howto_configurationfactory.html#Union_configuration">Union configuration</a></li> |
| <li><a href="howto_configurationfactory.html#Configuration_definition_file_reference">Configuration definition file reference</a></li> |
| <ul> |
| <li><a href="howto_configurationfactory.html#Setting_further_options">Setting further options</a></li> |
| <li><a href="howto_configurationfactory.html#Referencing_system_properties">Referencing system properties</a></li> |
| </ul> |
| <li><a href="howto_configurationbuilder.html#Using_DefaultConfigurationBuilder">Using DefaultConfigurationBuilder</a></li> |
| <ul> |
| <li><a href="howto_configurationbuilder.html#Differences_to_ConfigurationFactory">Differences to ConfigurationFactory</a></li> |
| <li><a href="howto_configurationbuilder.html#Enhancements_of_the_configuration_definition_file">Enhancements of the configuration definition file</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_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#Handling_of_runtime_exceptions">Handling of runtime exceptions</a></li> |
| </ul> |
| </ul> |
| </section> |
| </body> |
| |
| </document> |
