hivemind-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ahue...@apache.org
Subject svn commit: r505510 - /hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/
Date Fri, 09 Feb 2007 21:34:56 GMT
Author: ahuegen
Date: Fri Feb  9 13:34:55 2007
New Revision: 505510

URL: http://svn.apache.org/viewvc?view=rev&rev=505510
Log:
Javadoc improved

Modified:
    hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/Contribution.java
    hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ExtensionDefinition.java
    hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ExtensionPointDefinition.java
    hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ImplementationConstructionContext.java
    hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ImplementationConstructor.java
    hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ImplementationDefinition.java
    hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/InterceptorConstructor.java
    hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/InterceptorDefinition.java
    hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ServicePointDefinition.java

Modified: hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/Contribution.java
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/Contribution.java?view=diff&rev=505510&r1=505509&r2=505510
==============================================================================
--- hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/Contribution.java
(original)
+++ hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/Contribution.java
Fri Feb  9 13:34:55 2007
@@ -14,7 +14,6 @@
 
 package org.apache.hivemind.definition;
 
-
 /**
  * Contributes data to a {@link org.apache.hivemind.definition.ConfigurationPointDefinition
configuration point}.
  * 

Modified: hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ExtensionDefinition.java
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ExtensionDefinition.java?view=diff&rev=505510&r1=505509&r2=505510
==============================================================================
--- hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ExtensionDefinition.java
(original)
+++ hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ExtensionDefinition.java
Fri Feb  9 13:34:55 2007
@@ -2,6 +2,11 @@
 
 import org.apache.hivemind.Locatable;
 
+/**
+ * Defines an extension to an extension point.
+ * 
+ * @author Huegen
+ */
 public interface ExtensionDefinition extends Locatable
 {
     /**

Modified: hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ExtensionPointDefinition.java
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ExtensionPointDefinition.java?view=diff&rev=505510&r1=505509&r2=505510
==============================================================================
--- hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ExtensionPointDefinition.java
(original)
+++ hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ExtensionPointDefinition.java
Fri Feb  9 13:34:55 2007
@@ -2,6 +2,11 @@
 
 import org.apache.hivemind.Locatable;
 
+/**
+ * Defines an extension point of a module.
+ * 
+ * @author Huegen
+ */
 public interface ExtensionPointDefinition extends Locatable
 {
     /**
@@ -9,10 +14,19 @@
      */
     public String getModuleId();
 
-    public String getQualifiedId();
-
+    /**
+     * @return  the id of the extension point (unqualified, without module id)
+     */
     public String getId();
 
+    /**
+     * @return  the qualifed id of the extension point (includes module id)
+     */
+    public String getQualifiedId();
+
+    /**
+     * @return  the visibility of the extension point
+     */
     public Visibility getVisibility();
 
 }

Modified: hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ImplementationConstructionContext.java
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ImplementationConstructionContext.java?view=diff&rev=505510&r1=505509&r2=505510
==============================================================================
--- hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ImplementationConstructionContext.java
(original)
+++ hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ImplementationConstructionContext.java
Fri Feb  9 13:34:55 2007
@@ -2,6 +2,12 @@
 
 import org.apache.hivemind.internal.ServicePoint;
 
+/**
+ * Provides access to information and services needed
+ * during the construction of an {@link ImplementationConstructor implementation}.
+ * 
+ * @author Huegen
+ */
 public interface ImplementationConstructionContext extends ConstructionContext
 {
     /**

Modified: hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ImplementationConstructor.java
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ImplementationConstructor.java?view=diff&rev=505510&r1=505509&r2=505510
==============================================================================
--- hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ImplementationConstructor.java
(original)
+++ hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ImplementationConstructor.java
Fri Feb  9 13:34:55 2007
@@ -26,6 +26,7 @@
 {
     /**
      * Creates a new core service implementation.
+     * @param context  the context of the construction
      */
     public Object constructCoreServiceImplementation(ImplementationConstructionContext context);
 }

Modified: hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ImplementationDefinition.java
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ImplementationDefinition.java?view=diff&rev=505510&r1=505509&r2=505510
==============================================================================
--- hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ImplementationDefinition.java
(original)
+++ hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ImplementationDefinition.java
Fri Feb  9 13:34:55 2007
@@ -1,12 +1,28 @@
 package org.apache.hivemind.definition;
 
+import org.apache.hivemind.internal.ServiceModel;
 
+/**
+ * Defines an implementation of a {@link ServicePointDefinition service point}. 
+ * The implementation instance is created by a {@link ImplementationConstructor}.
+ * 
+ * @author Huegen
+ */
 public interface ImplementationDefinition extends ExtensionDefinition
 {
+    /**
+     * @return the name of the {@link ServiceModel} to use 
+     */
     public String getServiceModel();
 
-    public boolean isDefault();
-
+    /**
+     * @return  the constructor for the creation of the implementation instance.
+     */
     public ImplementationConstructor getServiceConstructor();
+
+    /**
+     * @return  true, if this is the default implementation of the service
+     */
+    public boolean isDefault();
 
 }

Modified: hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/InterceptorConstructor.java
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/InterceptorConstructor.java?view=diff&rev=505510&r1=505509&r2=505510
==============================================================================
--- hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/InterceptorConstructor.java
(original)
+++ hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/InterceptorConstructor.java
Fri Feb  9 13:34:55 2007
@@ -19,8 +19,8 @@
 import org.apache.hivemind.internal.Module;
 
 /**
- * Creates an service interceptor for a 
- * {@link org.apache.hivemind.definition.ServicePointDefinition service point}
+ * Creates a service interceptor for a 
+ * {@link org.apache.hivemind.definition.ServicePointDefinition service point}.
  * 
  * @author Achim Huegen
  */

Modified: hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/InterceptorDefinition.java
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/InterceptorDefinition.java?view=diff&rev=505510&r1=505509&r2=505510
==============================================================================
--- hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/InterceptorDefinition.java
(original)
+++ hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/InterceptorDefinition.java
Fri Feb  9 13:34:55 2007
@@ -1,11 +1,27 @@
 package org.apache.hivemind.definition;
 
+import org.apache.hivemind.Orderable;
 
+/**
+ * Defines an interceptor for the methods of a {@link ServicePointDefinition service point}.
+ * The interceptor is created by an instance of {@link InterceptorConstructor}.
+ * 
+ * Interceptors are applied in a certain order which bases on the interceptor names. 
+ * If an implementation of this interface wants to effect the order it must
+ * implement the {@link Orderable} interface too.
+ * 
+ * @author Huegen
+ */
 public interface InterceptorDefinition extends ExtensionDefinition
 {
-
+    /**
+     * @return  the constructor for the creation of a interceptor instance.
+     */
     public InterceptorConstructor getInterceptorConstructor();
 
+    /**
+     * @return the name of the interceptor. Used for ordering.
+     */
     public String getName();
 
 }

Modified: hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ServicePointDefinition.java
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ServicePointDefinition.java?view=diff&rev=505510&r1=505509&r2=505510
==============================================================================
--- hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ServicePointDefinition.java
(original)
+++ hivemind/hivemind2/trunk/framework/src/java/org/apache/hivemind/definition/ServicePointDefinition.java
Fri Feb  9 13:34:55 2007
@@ -23,15 +23,25 @@
     public ImplementationDefinition getDefaultImplementation();
 
     /**
-     * Adds a implementation definition to the module.
+     * Adds an implementation definition to the service point.
      * @param implementation  the implementation
      */
     public void addImplementation(ImplementationDefinition implementation);
 
+    /**
+     * @return the impelementations of this service point as instances of {@link ImplementationDefinition}
+     */
     public Collection getImplementations();
 
+    /**
+     * @return the interceptors of this service point as instances of {@link InterceptorDefinition}
+     */
     public Collection getInterceptors();
 
+    /**
+     * Adds an interceptor definition to the service point.
+     * @param interceptor  the interceptor
+     */
     public void addInterceptor(InterceptorDefinition interceptor);
 
 }



Mime
View raw message