svn commit: r377191 - /incubator/tuscany/java/sca/core/src/main/java/org/apache/tuscany/core/runtime/RuntimeContext.java

[jb...@apache.org]

Author: jboynes
Date: Sun Feb 12 07:30:40 2006
New Revision: 377191

URL: http://svn.apache.org/viewcvs?rev=377191&view=rev
Log:
add javadoc

Modified:
    incubator/tuscany/java/sca/core/src/main/java/org/apache/tuscany/core/runtime/RuntimeContext.java

Modified: incubator/tuscany/java/sca/core/src/main/java/org/apache/tuscany/core/runtime/RuntimeContext.java
URL: http://svn.apache.org/viewcvs/incubator/tuscany/java/sca/core/src/main/java/org/apache/tuscany/core/runtime/RuntimeContext.java?rev=377191&r1=377190&r2=377191&view=diff
==============================================================================
--- incubator/tuscany/java/sca/core/src/main/java/org/apache/tuscany/core/runtime/RuntimeContext.java (original)
+++ incubator/tuscany/java/sca/core/src/main/java/org/apache/tuscany/core/runtime/RuntimeContext.java Sun Feb 12 07:30:40 2006
@@ -21,8 +21,11 @@
 import org.apache.tuscany.core.context.SystemAggregateContext;
 
 /**
- * Represents a top-level component context in the runtime, that is the bootstrap context
- * 
+ * Represents a top-level component context in the runtime, that is the bootstrap context.
+ * This context serves as the ultimate root of the context hierarchy. Under it are two
+ * separate trees: the rootContext for user components and the systemContext for
+ * system components (those that comprise the runtime itself).
+ *
  * @version $Rev$ $Date$
  */
 public interface RuntimeContext extends AutowireContext, ConfigurationContext {
@@ -30,26 +33,31 @@
     /* the symbolic name of the runtime bootstrap context */
     public static final String RUNTIME = "tuscany.runtime";
 
-    /* the symbolic name of the root aggregate context containing all system components in the runtime */
+    /* the symbolic name of the aggregate context containing all system components in the runtime */
     public static final String SYSTEM = "tuscany.system";
 
-    /* the symbolic name of the root aggregate context containing all components in the runtime */
+    /* the symbolic name of the aggregate context containing all user components in the runtime */
     public static final String ROOT = "tuscany.root";
 
     /**
-     * Adds a configuration builder to the runtime
+     * Returns the context that forms the root of the user component tree.
+     * All user components will managed by contexts that are children of this root.
+     * @return the root of the user component tree
      */
-    public void addBuilder(RuntimeConfigurationBuilder builder);
+    public AggregateContext getRootContext();
 
     /**
-     * Returns the root component context. The root context contains all user components in the runtime
+     * Returns the context that forms the root of the system component tree.
+     * All system components, components that provide system services needed by the
+     * Tuscany runtime itself, will be managed by contexts that are children of this root.
+     * @return the root of the system component tree
      */
-    public AggregateContext getRootContext();
+    public SystemAggregateContext getSystemContext();
 
     /**
-     * Returns the system component context.
+     * Adds a configuration builder to the runtime
      */
-    public SystemAggregateContext getSystemContext();
+    public void addBuilder(RuntimeConfigurationBuilder builder);
 
     /**
      * Returns the monitor factory in use by the runtime