hivemind-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ahue...@apache.org
Subject svn commit: r500016 - in /hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition: RegistryDefinition.java package.html
Date Thu, 25 Jan 2007 22:13:00 GMT
Author: ahuegen
Date: Thu Jan 25 14:13:00 2007
New Revision: 500016

URL: http://svn.apache.org/viewvc?view=rev&rev=500016
Log:
Documentation of definition package.

Added:
    hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/package.html
Modified:
    hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/RegistryDefinition.java

Modified: hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/RegistryDefinition.java
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/RegistryDefinition.java?view=diff&rev=500016&r1=500015&r2=500016
==============================================================================
--- hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/RegistryDefinition.java
(original)
+++ hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/RegistryDefinition.java
Thu Jan 25 14:13:00 2007
@@ -5,8 +5,21 @@
 
 import org.apache.hivemind.ApplicationRuntimeException;
 import org.apache.hivemind.events.RegistryInitializationListener;
+import org.apache.hivemind.impl.RegistryBuilder;
 import org.apache.hivemind.impl.RegistryPostProcessor;
 
+/**
+ * Defines all modules and their service and configuration points 
+ * which build a registry. The definition is a blueprint from which
+ * a registry instance is constructed. 
+ * 
+ * After the complete definition of all elements of a registry
+ * the definition is passed to {@link RegistryBuilder} for
+ * the next phase: the registry construction. 
+ * From that moment on the definition shouldn't be changed any longer.
+ * 
+ * @author Achim Huegen
+ */
 public interface RegistryDefinition
 {
 
@@ -17,23 +30,54 @@
      */
     public void addModule(ModuleDefinition module) throws ApplicationRuntimeException;
 
+    /**
+     * @return  a collection of all added {@link ModuleDefinition modules}
+     */
+    public Collection getModules();
+
+    /**
+     * Returns a module that is identified by its module id.
+     * @param id  the module id
+     * @return  the module
+     */
+    public ModuleDefinition getModule(String id);
+
+    /**
+     * Adds a {@link RegistryPostProcessor}. The processor is called after all
+     * module definitions have been processed.
+     * @param postProcessor the processor
+     */
     public void addPostProcessor(RegistryPostProcessor postProcessor);
 
+    /**
+     * @return  a collection of all registered {@link RegistryPostProcessor}s
+     */
     public List getPostProcessors();
 
     /**
-     * @see RegistryInitializationListener
+     * Adds a {@link RegistryInitializationListener} which is called after the 
+     * construction of the registry.
+     * @param listener  the listener
      */
     public void addRegistryInitializationListener(RegistryInitializationListener listener);
 
+    /**
+     * @return  a collection of all registered {@link RegistryInitializationListener}s
+     */
     public List getRegistryInitializationListeners();
 
-    public Collection getModules();
-
-    public ModuleDefinition getModule(String id);
-
+    /**
+     * Returns a service point that is identified by its id.
+     * @param qualifiedServicePointId  the fully qualified service point id
+     * @return the service point definition
+     */
     public ServicePointDefinition getServicePoint(String qualifiedServicePointId);
 
+    /**
+     * Returns a configuration point that is identified by its id.
+     * @param qualifiedServicePointId  the fully qualified configuration point id
+     * @return the configuration point definition
+     */
     public ConfigurationPointDefinition getConfigurationPoint(String qualifiedConfigurationPointId);
 
 }

Added: hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/package.html
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/package.html?view=auto&rev=500016
==============================================================================
--- hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/package.html
(added)
+++ hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/package.html
Thu Jan 25 14:13:00 2007
@@ -0,0 +1,3 @@
+This package contains the interfaces that are needed
+for the definition of a registry. The definition is the blueprint
+from which a registry instance is constructed.
\ No newline at end of file



Mime
View raw message