[infinispan-commits] Infinispan SVN: r2306 - in branches/4.1.x/core/src/main/java/org/infinispan: manager and 1 other directory.

[infinispan-commits at lists.jboss.org]

Author: manik.surtani at jboss.com
Date: 2010-09-02 06:36:56 -0400 (Thu, 02 Sep 2010)
New Revision: 2306

Modified:
   branches/4.1.x/core/src/main/java/org/infinispan/config/Configuration.java
   branches/4.1.x/core/src/main/java/org/infinispan/config/GlobalConfiguration.java
   branches/4.1.x/core/src/main/java/org/infinispan/manager/DefaultCacheManager.java
Log:
[ISPN-599] (document CacheManager's default constructor)

Modified: branches/4.1.x/core/src/main/java/org/infinispan/config/Configuration.java
===================================================================
--- branches/4.1.x/core/src/main/java/org/infinispan/config/Configuration.java	2010-09-02 10:24:53 UTC (rev 2305)
+++ branches/4.1.x/core/src/main/java/org/infinispan/config/Configuration.java	2010-09-02 10:36:56 UTC (rev 2306)
@@ -50,13 +50,11 @@
 
 /**
  * Encapsulates the configuration of a Cache.
- * 
  * <p>
- * Note that class Configuration contains JAXB annotations. These annotations determine how XML
- * configuration files are read into instances of configuration class hierarchy as well as they
- * provide meta data for configuration file XML schema generation. Please modify these annotations
- * and Java element types they annotate with utmost understanding and care.
- * 
+ * A default instance of this bean takes default values for each attribute.  Please see the individual setters for
+ * details of what these defaults are.
+ * </p>
+ *
  * @configRef name="default",desc="Configures the default cache which can be retrieved via CacheManager.getCache().
  *                                 These default settings are also used as a starting point when configuring namedCaches,
  *                                 since the default settings are inherited by any named cache."
@@ -72,6 +70,13 @@
  * 
  * @see <a href="../../../config.html#ce_infinispan_default">Configuration reference</a>
  */
+
+//Note that class Configuration contains JAXB annotations. These annotations determine how XML
+//configuration files are read into instances of configuration class hierarchy as well as they
+//provide meta data for configuration file XML schema generation. Please modify these annotations
+//and Java element types they annotate with utmost understanding and care.
+
+
 @SurvivesRestarts
 @XmlAccessorType(XmlAccessType.FIELD)
 @XmlType(propOrder={})

Modified: branches/4.1.x/core/src/main/java/org/infinispan/config/GlobalConfiguration.java
===================================================================
--- branches/4.1.x/core/src/main/java/org/infinispan/config/GlobalConfiguration.java	2010-09-02 10:24:53 UTC (rev 2305)
+++ branches/4.1.x/core/src/main/java/org/infinispan/config/GlobalConfiguration.java	2010-09-02 10:36:56 UTC (rev 2306)
@@ -26,11 +26,9 @@
 /**
  * Configuration component that encapsulates the global configuration.
  * <p/>
+ * A default instance of this bean takes default values for each attribute.  Please see the individual setters for
+ * details of what these defaults are.
  * <p/>
- * Note that class GlobalConfiguration contains JAXB annotations. These annotations determine how XML configuration
- * files are read into instances of configuration class hierarchy as well as they provide meta data for configuration
- * file XML schema generation. Please modify these annotations and Java element types they annotate with utmost
- * understanding and care.
  *
  * @author Manik Surtani
  * @author Vladimir Blagojevic
@@ -41,6 +39,12 @@
  * @see <a href="../../../config.html#ce_infinispan_global">Configuration reference</a>
  * 
  */
+
+// Note that class GlobalConfiguration contains JAXB annotations. These annotations determine how XML configuration
+// files are read into instances of configuration class hierarchy as well as they provide meta data for configuration
+// file XML schema generation. Please modify these annotations and Java element types they annotate with utmost
+// understanding and care.
+
 @SurvivesRestarts
 @Scope(Scopes.GLOBAL)
 @XmlAccessorType(XmlAccessType.FIELD)

Modified: branches/4.1.x/core/src/main/java/org/infinispan/manager/DefaultCacheManager.java
===================================================================
--- branches/4.1.x/core/src/main/java/org/infinispan/manager/DefaultCacheManager.java	2010-09-02 10:24:53 UTC (rev 2305)
+++ branches/4.1.x/core/src/main/java/org/infinispan/manager/DefaultCacheManager.java	2010-09-02 10:36:56 UTC (rev 2306)
@@ -115,14 +115,16 @@
    private final GlobalComponentRegistry globalComponentRegistry;
 
    /**
-    * Constructs and starts a default instance of the CacheManager, using configuration defaults.
+    * Constructs and starts a default instance of the CacheManager, using configuration defaults.  See {@link Configuration}
+    * and {@link GlobalConfiguration} for details of these defaults.
     */
    public DefaultCacheManager() {
       this(null, null, true);
    }
 
    /**
-    * Constructs a default instance of the CacheManager, using configuration defaults.
+    * Constructs a default instance of the CacheManager, using configuration defaults.  See {@link Configuration}
+    * and {@link GlobalConfiguration} for details of these defaults.
     *
     * @param start if true, the cache manager is started
     */
@@ -132,7 +134,7 @@
 
    /**
     * Constructs and starts a new instance of the CacheManager, using the default configuration passed in. Uses defaults
-    * for a {@link org.infinispan.config.GlobalConfiguration}.
+    * for a {@link GlobalConfiguration}.  See {@link GlobalConfiguration} for details of these defaults. 
     *
     * @param defaultConfiguration configuration to use as a template for all caches created
     */
@@ -142,7 +144,7 @@
 
    /**
     * Constructs a new instance of the CacheManager, using the default configuration passed in. Uses defaults for a {@link
-    * org.infinispan.config.GlobalConfiguration}.
+    * org.infinispan.config.GlobalConfiguration}.  See {@link GlobalConfiguration} for details of these defaults.
     *
     * @param defaultConfiguration configuration file to use as a template for all caches created
     * @param start                if true, the cache manager is started
@@ -153,7 +155,7 @@
 
    /**
     * Constructs and starts a new instance of the CacheManager, using the global configuration passed in, and system
-    * defaults for the default named cache configuration.
+    * defaults for the default named cache configuration.  See {@link Configuration} for details of these defaults.
     *
     * @param globalConfiguration GlobalConfiguration to use for all caches created
     */
@@ -163,7 +165,7 @@
 
    /**
     * Constructs a new instance of the CacheManager, using the global configuration passed in, and system defaults for the
-    * default named cache configuration.
+    * default named cache configuration.  See {@link Configuration} for details of these defaults.
     *
     * @param globalConfiguration GlobalConfiguration to use for all caches created
     * @param start               if true, the cache manager is started.