Removed DOCUMENT ME comments that were generated and applied source code

[utils] / system / general / src / main / java / org / wamblee / system / core / DefaultRequiredInterface.java

diff --git a/system/general/src/main/java/org/wamblee/system/core/DefaultRequiredInterface.java b/system/general/src/main/java/org/wamblee/system/core/DefaultRequiredInterface.java
index d47b6f49825b12b1767bbb6835f12891869371ba..14df9d49c8098f23ed5affcafe2c741db0f58a59 100644 (file)
--- a/system/general/src/main/java/org/wamblee/system/core/DefaultRequiredInterface.java
+++ b/system/general/src/main/java/org/wamblee/system/core/DefaultRequiredInterface.java
@@ -19,107 +19,66 @@ import org.wamblee.reflection.ReflectionUtils;
 
 import java.util.Arrays;
 
-
 /**
- * DOCUMENT ME!
- *
+ * 
  * @author $author$
  * @version $Revision$
  */
 public class DefaultRequiredInterface implements RequiredInterface {
-    /**
-     * DOCUMENT ME!
-     */
     private String name;
 
-    /**
-     * DOCUMENT ME!
-     */
     private boolean optional;
 
-    /**
-     * DOCUMENT ME!
-     */
     private Class[] required;
 
-    /**
-     * DOCUMENT ME!
-     */
     private ProvidedInterface provider;
 
-/**
+    /**
      * Creates a new DefaultRequiredInterface object.
-     *
-     * @param aName DOCUMENT ME!
-     * @param aInterface DOCUMENT ME!
+     * 
      */
     public DefaultRequiredInterface(String aName, Class aInterface) {
         this(aName, new Class[] { aInterface });
     }
 
-/**
+    /**
      * Creates a new DefaultRequiredInterface object.
-     *
-     * @param aName DOCUMENT ME!
-     * @param aInterfaces DOCUMENT ME!
+     * 
      */
     public DefaultRequiredInterface(String aName, Class[] aInterfaces) {
         this(aName, aInterfaces, false);
     }
 
-/**
+    /**
      * Creates a new DefaultRequiredInterface object.
-     *
-     * @param aName DOCUMENT ME!
-     * @param aInterface DOCUMENT ME!
-     * @param aIsOptional DOCUMENT ME!
+     * 
      */
     public DefaultRequiredInterface(String aName, Class aInterface,
         boolean aIsOptional) {
         this(aName, new Class[] { aInterface }, aIsOptional);
     }
 
-/**
+    /**
      * Creates a new DefaultRequiredInterface object.
-     *
-     * @param aName DOCUMENT ME!
-     * @param aInterfaces DOCUMENT ME!
-     * @param aIsOptional DOCUMENT ME!
+     * 
      */
     public DefaultRequiredInterface(String aName, Class[] aInterfaces,
         boolean aIsOptional) {
-        name         = aName;
-        optional     = aIsOptional;
-        required     = aInterfaces;
+        name = aName;
+        optional = aIsOptional;
+        required = aInterfaces;
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     @Override
     public String getName() {
         return name;
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     @Override
     public boolean isOptional() {
         return optional;
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aDescriptor DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     @Override
     public boolean implementedBy(ProvidedInterface aDescriptor) {
         Class[] provided = aDescriptor.getInterfaceTypes();
@@ -135,19 +94,21 @@ public class DefaultRequiredInterface implements RequiredInterface {
     }
 
     /**
-     * Check if the required interface is implemented by one of the
-     * provided interfaces.
-     *
-     * @param aRequired required interface
-     * @param aProvided Provided interfaces.
-     *
+     * Check if the required interface is implemented by one of the provided
+     * interfaces.
+     * 
+     * @param aRequired
+     *            required interface
+     * @param aProvided
+     *            Provided interfaces.
+     * 
      * @return
      */
     private boolean serviceProvided(Class aRequired, Class[] aProvided) {
         for (Class provided : aProvided) {
             try {
-                provided      = ReflectionUtils.wrapIfNeeded(provided);
-                aRequired     = ReflectionUtils.wrapIfNeeded(aRequired);
+                provided = ReflectionUtils.wrapIfNeeded(provided);
+                aRequired = ReflectionUtils.wrapIfNeeded(aRequired);
                 provided.asSubclass(aRequired);
 
                 return true;
@@ -159,21 +120,11 @@ public class DefaultRequiredInterface implements RequiredInterface {
         return false;
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     @Override
     public ProvidedInterface getProvider() {
         return provider;
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aProvider DOCUMENT ME!
-     */
     @Override
     public void setProvider(ProvidedInterface aProvider) {
         assert aProvider != null;
@@ -181,28 +132,14 @@ public class DefaultRequiredInterface implements RequiredInterface {
         provider = aProvider;
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param obj DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     @Override
     public boolean equals(Object obj) {
         return this == obj;
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param obj DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     @Override
     public boolean covers(RequiredInterface obj) {
-        // TODO do more than equals. 
+        // TODO do more than equals.
         if (!(obj instanceof DefaultRequiredInterface)) {
             return false;
         }
@@ -217,8 +154,8 @@ public class DefaultRequiredInterface implements RequiredInterface {
         String[] interfaces2 = new String[required.length];
 
         for (int i = 0; i < required.length; i++) {
-            interfaces1[i]     = required[i].getName();
-            interfaces2[i]     = descr.required[i].getName();
+            interfaces1[i] = required[i].getName();
+            interfaces2[i] = descr.required[i].getName();
         }
 
         Arrays.sort(interfaces1);
@@ -227,21 +164,11 @@ public class DefaultRequiredInterface implements RequiredInterface {
         return Arrays.equals(interfaces1, interfaces2);
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     @Override
     public int hashCode() {
         return required.hashCode();
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     @Override
     public String toString() {
         StringBuffer buf = new StringBuffer();