You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openwebbeans.apache.org by ge...@apache.org on 2009/07/26 09:24:38 UTC

svn commit: r797869 - in /incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans: deployment/StereoTypeManager.java deployment/StereoTypeModel.java deployment/stereotype/IStereoTypeModel.java util/WebBeansUtil.java

Author: gerdogdu
Date: Sun Jul 26 07:24:38 2009
New Revision: 797869

URL: http://svn.apache.org/viewvc?rev=797869&view=rev
Log:
Add comments.

Modified:
    incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/deployment/StereoTypeManager.java   (contents, props changed)
    incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/deployment/StereoTypeModel.java
    incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/deployment/stereotype/IStereoTypeModel.java   (contents, props changed)
    incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/util/WebBeansUtil.java

Modified: incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/deployment/StereoTypeManager.java
URL: http://svn.apache.org/viewvc/incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/deployment/StereoTypeManager.java?rev=797869&r1=797868&r2=797869&view=diff
==============================================================================
--- incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/deployment/StereoTypeManager.java (original)
+++ incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/deployment/StereoTypeManager.java Sun Jul 26 07:24:38 2009
@@ -20,21 +20,42 @@
 import org.apache.webbeans.deployment.stereotype.IStereoTypeModel;
 import org.apache.webbeans.util.Asserts;
 
+/**
+ * Manager for the {@link StereoTypeModel} instances.
+ * <p>
+ * It keeps map with name to model.
+ * </p>
+ * @version $Rev$ $Date$
+ *
+ */
 public class StereoTypeManager
 {
+    /**Stereotype model instances, stereotype mode name to model instance*/
     private Map<String, IStereoTypeModel> stereoTypeMap = new ConcurrentHashMap<String, IStereoTypeModel>();
 
+    /**
+     * Default constructor
+     */
     public StereoTypeManager()
     {
 
     }
 
+    /**
+     * Returns manager for this application.
+     * @return singleton instance.
+     */
     public static StereoTypeManager getInstance()
     {
         StereoTypeManager instance = (StereoTypeManager) WebBeansFinder.getSingletonInstance(WebBeansFinder.SINGLETON_STEREOTYPE_MANAGER);
+        
         return instance;
     }
 
+    /**
+     * Adds new steretype model instance.
+     * @param model new model
+     */
     public void addStereoTypeModel(IStereoTypeModel model)
     {
         Asserts.assertNotNull(model, "model parameter can not be null");
@@ -42,6 +63,11 @@
         stereoTypeMap.put(model.getName(), model);
     }
 
+    /**
+     * Returns model with given name.
+     * @param modelName stereotype model name
+     * @return model with given name
+     */
     public IStereoTypeModel getStereoTypeModel(String modelName)
     {
         Asserts.assertNotNull(modelName, "modelName parameter can not be null");

Propchange: incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/deployment/StereoTypeManager.java
------------------------------------------------------------------------------
    svn:keywords = Rev Date

Modified: incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/deployment/StereoTypeModel.java
URL: http://svn.apache.org/viewvc/incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/deployment/StereoTypeModel.java?rev=797869&r1=797868&r2=797869&view=diff
==============================================================================
--- incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/deployment/StereoTypeModel.java (original)
+++ incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/deployment/StereoTypeModel.java Sun Jul 26 07:24:38 2009
@@ -16,34 +16,44 @@
 import java.lang.annotation.Annotation;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Target;
-import java.util.Arrays;
-import java.util.Collections;
 import java.util.HashSet;
 import java.util.Set;
 
 import javax.enterprise.context.ScopeType;
 import javax.enterprise.inject.deployment.DeploymentType;
-import javax.enterprise.inject.stereotype.Stereotype;
 
 import org.apache.webbeans.deployment.stereotype.IStereoTypeModel;
 import org.apache.webbeans.exception.WebBeansConfigurationException;
 import org.apache.webbeans.util.AnnotationUtil;
-import org.apache.webbeans.util.Asserts;
 
+/**
+ * Default implementation of the {@link IStereoTypeModel} contract.
+ * 
+ * @version $Rev$ $Date$
+ *
+ */
 public class StereoTypeModel implements IStereoTypeModel
 {
+    /**Name of the stereotype model. It is usd for registering model with StereoTypeManager*/
     private String name;
 
+    /**Default deployment type*/
     private Annotation defaultDeploymentType;
 
+    /**Default scope type*/
     private Annotation defaultScopeType;
 
-    private String defaultName = null;
-
+    /**Interceptor Bindings*/
     private Set<Annotation> interceptorBindingTypes = new HashSet<Annotation>();
 
+    /**Inherit StereoType annotations*/
     private Set<Annotation> inherits = new HashSet<Annotation>();
 
+    /**
+     * Creates a new instance of the stereotype model for
+     * given class.
+     * @param clazz stereotype type
+     */
     public StereoTypeModel(Class<?> clazz)
     {
         this.name = clazz.getName();
@@ -110,9 +120,9 @@
         }
 
     }
-
+    
     /**
-     * @return the name
+     * {@inheritDoc}
      */
     public String getName()
     {
@@ -120,7 +130,7 @@
     }
 
     /**
-     * @param name the name to set
+     * {@inheritDoc}
      */
     public void setName(String name)
     {
@@ -128,39 +138,39 @@
     }
 
     /**
-     * @return the defaultDeploymentType
+     * {@inheritDoc}
      */
     public Annotation getDefaultDeploymentType()
     {
         return defaultDeploymentType;
     }
 
-    public String getDefaultName()
-    {
-        return this.defaultName;
-    }
-
     /**
-     * @return the defaultScopeType
+     * {@inheritDoc}
      */
     public Annotation getDefaultScopeType()
     {
         return defaultScopeType;
     }
 
+    /**
+     * {@inheritDoc}
+     */    
     public Set<Annotation> getInterceptorBindingTypes()
     {
         return this.interceptorBindingTypes;
     }
 
+    /**
+     * {@inheritDoc}
+     */    
     public Set<Annotation> getInheritedStereoTypes()
     {
         return this.inherits;
     }
 
-    /*
-     * (non-Javadoc)
-     * @see java.lang.Object#equals(java.lang.Object)
+    /**
+     * {@inheritDoc}
      */
     @Override
     public boolean equals(Object obj)
@@ -171,16 +181,22 @@
         }
 
         if (!(obj instanceof StereoTypeModel))
-            return false;
+        {
+            return false;   
+        }
 
+        if(obj == null)
+        {
+            return false;
+        }
+        
         StereoTypeModel model = (StereoTypeModel) obj;
 
         return model.name.equals(this.name);
     }
-
-    /*
-     * (non-Javadoc)
-     * @see java.lang.Object#hashCode()
+    
+    /**
+     * {@inheritDoc}
      */
     @Override
     public int hashCode()

Modified: incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/deployment/stereotype/IStereoTypeModel.java
URL: http://svn.apache.org/viewvc/incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/deployment/stereotype/IStereoTypeModel.java?rev=797869&r1=797868&r2=797869&view=diff
==============================================================================
--- incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/deployment/stereotype/IStereoTypeModel.java (original)
+++ incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/deployment/stereotype/IStereoTypeModel.java Sun Jul 26 07:24:38 2009
@@ -16,35 +16,49 @@
 import java.lang.annotation.Annotation;
 import java.util.Set;
 
+/**
+ * Stereotype model contract.
+ * 
+ * @version $Rev$ $Date$
+ *
+ */
 public interface IStereoTypeModel
 {
     /**
+     * Returns name of the stereotype. As default,
+     * its class name.
      * @return the name
      */
     public String getName();
 
     /**
+     * Sets name.
      * @param name the name to set
      */
     public void setName(String name);
 
     /**
+     * Gets default deployment type.
      * @return the defaultDeploymentType
      */
     public Annotation getDefaultDeploymentType();
 
     /**
+     * Sets default deployment type.
      * @return the defaultScopeType
      */
     public Annotation getDefaultScopeType();
 
     /**
-     * @return
+     * Returns set of interceptor binding that are
+     * definen by the stereotype.
+     * @return set of interceptor bindings.
      */
     public Set<Annotation> getInterceptorBindingTypes();
 
     /**
-     * @return
+     * Returns a set of inherited stereotypes.
+     * @return set of inherited stereotypes.
      */
     public Set<Annotation> getInheritedStereoTypes();
 

Propchange: incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/deployment/stereotype/IStereoTypeModel.java
------------------------------------------------------------------------------
    svn:keywords = Rev Date

Modified: incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/util/WebBeansUtil.java
URL: http://svn.apache.org/viewvc/incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/util/WebBeansUtil.java?rev=797869&r1=797868&r2=797869&view=diff
==============================================================================
--- incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/util/WebBeansUtil.java (original)
+++ incubator/openwebbeans/trunk/webbeans-impl/src/main/java/org/apache/webbeans/util/WebBeansUtil.java Sun Jul 26 07:24:38 2009
@@ -104,8 +104,6 @@
 import org.apache.webbeans.decorator.DecoratorsManager;
 import org.apache.webbeans.decorator.WebBeansDecoratorConfig;
 import org.apache.webbeans.deployment.DeploymentTypeManager;
-import org.apache.webbeans.deployment.StereoTypeManager;
-import org.apache.webbeans.deployment.stereotype.IStereoTypeModel;
 import org.apache.webbeans.event.EventImpl;
 import org.apache.webbeans.exception.WebBeansConfigurationException;
 import org.apache.webbeans.exception.WebBeansException;
@@ -131,6 +129,7 @@
 
 /**
  * Contains some utility methods used in the all project.
+ * 
  * @version $Rev$ $Date$ 
  */
 @SuppressWarnings("unchecked")
@@ -1241,6 +1240,11 @@
         }
     }
 
+    /**
+     * Validates that given class obeys stereotype model
+     * defined by the specification.
+     * @param clazz stereotype class
+     */
     public static void checkStereoTypeClass(Class<?> clazz)
     {
         Asserts.nullCheckForClass(clazz);