tobrien 2004/01/11 20:01:07
Modified: configuration/xdocs index.xml
Log:
This index.xml was reworded with the usual grammar considerations. The history
section should, ideally, talk more to the actual dates when these things happened, and
there is more room on the index page to tout some of the many reasons someone would
want to use this component.
Revision Changes Path
1.2 +36 -21 jakarta-commons/configuration/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-commons/configuration/xdocs/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 23 Dec 2003 15:09:05 -0000 1.1
+++ index.xml 12 Jan 2004 04:01:07 -0000 1.2
@@ -6,39 +6,54 @@
<author email="[EMAIL PROTECTED]">Martin Poeschl</author>
<author email="[EMAIL PROTECTED]">Jason van Zyl</author>
<author email="[EMAIL PROTECTED]">Eric Pugh</author>
+ <author email="[EMAIL PROTECTED]">Tim O'Brien</author>
<title>Configuration</title>
</properties>
<body>
<section name="Intro">
<p>
- Configuration is a project to provide a generic Configuration
- interface and allow the source of the
- values to vary. It
- provides easy typed access to single, as well as lists of
- configuration values based on a 'key':
-<source><![CDATA[
- Double double = Configuration.getDouble("some_double_value");
-]]></source>
- </p>
- <p>
- Right now you can load properties from a simple properties file,
- a properties file in a jar, an XML file, JNDI settings, as well as use
- a mix different sources using a ConfigurationFactory and
CompositeConfiguration.
+ Commons Configuration provides a generic configuration
+ interface which enables an application to read configuration
+ data from a variety of sources. Commons Configuration
+ provides typed access to single, and multi-valued
+ configuration parameters as demonstrated by the following
+ code:
+
+ <source><![CDATA[ Double double =
Configuration.getDouble("some_double_value"); ]]></source>
+
</p>
<p>
- Custom configuration objects are very easy to create now by just
subclassing
- AbstractConfiguration. This works similar to how AbstractList works.
+ Configuration parameters may be loaded from the following
+ sources:
+
+ <ul>
+ <li>Properties files</li>
+ <li>XML documents</li>
+ <li>JNDI</li>
+ </ul>
+
+ Different configuration sources can be mixed using a
+ <code>ConfigurationFactory</code> and
+ <code>CompositeConfiguration</code>. Additional sources of
+ configuration parameters can be created by using custom
+ configuration objects. This customization can be achieved by
+ extending <code>AbstractConfiguration</code>.
</p>
</section>
<section name="History">
<p>
- This code originated in JServ, was brought into Turbine,
- moved to Velocity and improved, and then moved into the
- Commons as ExtendedProperties. The code in
- ExtendedProperties is a little unwieldly and deals
- specifically with properties files. Eventually it was added to
- the Commons sandbox project.
+ Commons Configuration started as code in Apache JServ. The
+ JServ code was subsequently added to <a
+ href="http://jakarta.apache.org/turbine";>Jakarta Turbine</a>.
+ After Jakarta Turbine, this configuration interface moved to
+ <a href="http://jakarta.apache.org/velocity";>Jakarta
+ Velocity</a> and underwent various improvements. After
+ Velocity, this code was introduced to the <a
+ href="http://jakarta.apache.org/commons";>Jakarta Commons</a>
+ as <code>ExtendedProperties</code>. Configuration began life
+ in the Commons as a Sandbox component, and was promoted to the
+ Commons Proper in late 2003.
</p>
</section>
</body>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
