svn commit: r370691 - /incubator/jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/config/package.html

[ju...@apache.org]

Author: jukka
Date: Thu Jan 19 17:34:30 2006
New Revision: 370691

URL: http://svn.apache.org/viewcvs?rev=370691&view=rev
Log:
JCR-306: Added documentation about the configuration construction.

Modified:
    incubator/jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/config/package.html

Modified: incubator/jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/config/package.html
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/config/package.html?rev=370691&r1=370690&r2=370691&view=diff
==============================================================================
--- incubator/jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/config/package.html (original)
+++ incubator/jackrabbit/trunk/jackrabbit/src/main/java/org/apache/jackrabbit/core/config/package.html Thu Jan 19 17:34:30 2006
@@ -4,12 +4,22 @@
 This package contains functionality for reading and manipulating the
 Jackrabbit configuration. The configuration functionality can be
 divided in two parts: parsing and representing configuration.
+
+<h2>Parsing configuration</h2>
 <p>
 The configuration parsing functionality is located in the
 {@link org.apache.jackrabbit.core.config.ConfigurationParser ConfigurationParser}
 class. The parser class reads repository and workspace configuration
 files and builds corresponding configuration object structures.
 <p>
+<p>
+The static <code>create()</code> factory methods of the
+{@link org.apache.jackrabbit.core.config.RepositoryConfig RepositoryConfig}
+class are the standard ways of invoking the configuration parser.
+</p>
+
+<h2>Representating configuration</h2>
+<p>
 The parsed configuration information is represented using Config object
 structures. The
 {@link org.apache.jackrabbit.core.config.RepositoryConfig RepositoryConfig}
@@ -32,4 +42,14 @@
 class contains also a set of static and instance methods for manipulating
 the repository configuration, especially creating and loading workspace
 configurations.
+
+<h2>Modifying configuration</h2>
+<p>
+The configuration classes in this package are immutable and <code>final</code>
+to enforce the contract that the configuration should not be modified once
+it has been intstantiated. The public constructors allow a limited form of
+dynamic configurability for Jackrabbit, but note that the only officially
+supported Jackrabbit configuration interface are the XML configuration files.
+</p>
+
 </body>