[jboss-svn-commits] JBoss Common SVN: r4283 - shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api.

[jboss-svn-commits at lists.jboss.org]

Author: ALRubinger
Date: 2010-04-20 19:23:50 -0400 (Tue, 20 Apr 2010)
New Revision: 4283

Modified:
   shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/Configuration.java
   shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/Domain.java
Log:
[SHRINKWRAP-102] Improve JavaDoc

Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/Configuration.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/Configuration.java	2010-04-20 23:19:09 UTC (rev 4282)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/Configuration.java	2010-04-20 23:23:50 UTC (rev 4283)
@@ -26,6 +26,9 @@
  * is required it must be created under a new domain.  The default
  * configuration is defined by {@link ConfigurationBuilder}, and new
  * configurations are created via {@link ConfigurationBuilder#build()}. 
+ * Note that while the {@link Configuration} is immutable, its properties
+ * may have internal state that may be changed.  For true isolation, use separate
+ * {@link Domain}s when creating {@link Archive}s.
  * 
  * @author <a href="mailto:andrew.rubinger at jboss.org">ALR</a>
  * @version $Revision: $

Modified: shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/Domain.java
===================================================================
--- shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/Domain.java	2010-04-20 23:19:09 UTC (rev 4282)
+++ shrinkwrap/trunk/api/src/main/java/org/jboss/shrinkwrap/api/Domain.java	2010-04-20 23:23:50 UTC (rev 4283)
@@ -19,9 +19,11 @@
 /**
  * Encapsulates a shared {@link Configuration} to be used 
  * by all {@link Archive}s created by this {@link Domain}'s
- * {@link ArchiveFactory}.  New domains are created via 
- * {@link ShrinkWrap#createDomain()} (for a default, shared configuration)
- * or {@link ShrinkWrap#createDomain(ConfigurationBuilder)} (to supply an explicit
+ * {@link ArchiveFactory}.  New domains are created via
+ * {@link ShrinkWrap#createDomain()} (for a default configuration isolated
+ * from the {@link ShrinkWrap#getDefaultDomain()}), or 
+ * {@link ShrinkWrap#createDomain(Configuration)}
+ * and {@link ShrinkWrap#createDomain(ConfigurationBuilder)} (to supply an explicit
  * configuration property set). 
  *
  * @author <a href="mailto:andrew.rubinger at jboss.org">ALR</a>