Removed DOCUMENT ME comments that were generated and applied source code

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

diff --git a/system/general/src/main/java/org/wamblee/system/core/AbstractComponent.java b/system/general/src/main/java/org/wamblee/system/core/AbstractComponent.java
index 1ac464d0ce1033d9552cd8acca72c74453680921..7c4c75da27b1fbc26e28326fd017ab4dc818cb3e 100644 (file)
--- a/system/general/src/main/java/org/wamblee/system/core/AbstractComponent.java
+++ b/system/general/src/main/java/org/wamblee/system/core/AbstractComponent.java
@@ -23,63 +23,43 @@ import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
 
-
 /**
  * Abstract subsystem class making it easy to implement new subsystems.
- *
- * @param <Type> DOCUMENT ME!
+ * 
  */
 public abstract class AbstractComponent<Type> implements Component<Type> {
-    /**
-     * DOCUMENT ME!
-     */
     private static final Log LOG = LogFactory.getLog(AbstractComponent.class);
 
-    /**
-     * DOCUMENT ME!
-     */
     private ThreadLocal<List<ProvidedInterface>> remaining;
 
-    /**
-     * DOCUMENT ME!
-     */
     private String context;
 
-    /**
-     * DOCUMENT ME!
-     */
     private String name;
 
-    /**
-     * DOCUMENT ME!
-     */
     private List<ProvidedInterface> provided;
 
-    /**
-     * DOCUMENT ME!
-     */
     private List<RequiredInterface> required;
 
-/**
-         * Constructs the subsystem.
-         * 
-         * @param aName
-         *            Name of the system.
-         * @param aProvided
-         *            Provided services.
-         * @param aRequired
-         *            Required services.
-         */
+    /**
+     * Constructs the subsystem.
+     * 
+     * @param aName
+     *            Name of the system.
+     * @param aProvided
+     *            Provided services.
+     * @param aRequired
+     *            Required services.
+     */
     protected AbstractComponent(String aName,
         List<ProvidedInterface> aProvided, List<RequiredInterface> aRequired) {
-        remaining     = new ThreadLocal<List<ProvidedInterface>>();
-        context       = null;
-        name          = aName;
-        provided      = new ArrayList<ProvidedInterface>(aProvided);
-        required      = new ArrayList<RequiredInterface>(aRequired);
+        remaining = new ThreadLocal<List<ProvidedInterface>>();
+        context = null;
+        name = aName;
+        provided = new ArrayList<ProvidedInterface>(aProvided);
+        required = new ArrayList<RequiredInterface>(aRequired);
     }
 
-/**
+    /**
      * Constructs the subsystem.
      * 
      * @param aName
@@ -96,20 +76,12 @@ public abstract class AbstractComponent<Type> implements Component<Type> {
 
     /**
      * Creates a new AbstractComponent object.
-     *
-     * @param aName DOCUMENT ME!
+     * 
      */
     protected AbstractComponent(String aName) {
         this(aName, new ProvidedInterface[0], new RequiredInterface[0]);
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aProvided DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     public AbstractComponent<Type> addProvidedInterface(
         ProvidedInterface aProvided) {
         provided.add(aProvided);
@@ -117,13 +89,6 @@ public abstract class AbstractComponent<Type> implements Component<Type> {
         return this;
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aRequired DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     public AbstractComponent<Type> addRequiredInterface(
         RequiredInterface aRequired) {
         required.add(aRequired);
@@ -131,21 +96,11 @@ public abstract class AbstractComponent<Type> implements Component<Type> {
         return this;
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     @Override
     public final String getName() {
         return name;
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aContext DOCUMENT ME!
-     */
     @Override
     public void addContext(String aContext) {
         if (context == null) {
@@ -155,21 +110,11 @@ public abstract class AbstractComponent<Type> implements Component<Type> {
         }
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     @Override
     public String getContext() {
         return context;
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     @Override
     public String getQualifiedName() {
         if (context == null) {
@@ -179,39 +124,23 @@ public abstract class AbstractComponent<Type> implements Component<Type> {
         return context + "." + getName();
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     @Override
     public final List<ProvidedInterface> getProvidedInterfaces() {
         return Collections.unmodifiableList(provided);
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     @Override
     public final List<RequiredInterface> getRequiredInterfaces() {
         return Collections.unmodifiableList(required);
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aScope DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     @Override
     public final Type start(Scope aScope) {
         LOG.info("Initialization starting '" + getQualifiedName() + "'");
 
         List<ProvidedInterface> oldRemaining = remaining.get();
-        remaining.set(new ArrayList<ProvidedInterface>(getProvidedInterfaces()));
+        remaining
+            .set(new ArrayList<ProvidedInterface>(getProvidedInterfaces()));
 
         try {
             Type runtime = doStart(aScope);
@@ -224,16 +153,13 @@ public abstract class AbstractComponent<Type> implements Component<Type> {
         }
     }
 
-    /**
-     * DOCUMENT ME!
-     */
     private void checkNotStartedInterfaces() {
         if (remaining.get().size() > 0) {
             String notProvided = "";
 
             for (ProvidedInterface provided : remaining.get()) {
-                notProvided += ("\nComponent " + getQualifiedName()
-                + " did not start interface " + provided);
+                notProvided += ("\nComponent " + getQualifiedName() +
+                    " did not start interface " + provided);
             }
 
             throw new SystemAssemblyException(notProvided);
@@ -241,46 +167,42 @@ public abstract class AbstractComponent<Type> implements Component<Type> {
     }
 
     /**
-     * Must be implemented for initializing the subsystem. The
-     * implementation must call {@link #addInterface(ProvidedInterface,
-     * Object, Scope)} for each service that is started.
-     *
-     * @param aScope DOCUMENT ME!
-     *
+     * Must be implemented for initializing the subsystem. The implementation
+     * must call {@link #addInterface(ProvidedInterface, Object, Scope)} for
+     * each service that is started.
+     * 
+     * 
      * @return Returns the runtime of the component.
      */
     protected abstract Type doStart(Scope aScope);
 
     /**
-     * Implementations must call this method to indicate that a new
-     * service has been started.
-     *
-     * @param aDescriptor Provided interface.
-     * @param aService Implementation of the interface.
-     * @param aScope scope in which to publish the implementation.
-     *
-     * @throws SystemAssemblyException DOCUMENT ME!
+     * Implementations must call this method to indicate that a new service has
+     * been started.
+     * 
+     * @param aDescriptor
+     *            Provided interface.
+     * @param aService
+     *            Implementation of the interface.
+     * @param aScope
+     *            scope in which to publish the implementation.
+     * 
      */
     protected final void addInterface(ProvidedInterface aDescriptor,
         Object aService, Scope aScope) {
-        LOG.info("Interface '" + getQualifiedName() + "."
-            + aDescriptor.getName() + "' started.");
+        LOG.info("Interface '" + getQualifiedName() + "." +
+            aDescriptor.getName() + "' started.");
 
         if (!remaining.get().remove(aDescriptor)) {
-            throw new SystemAssemblyException("Component '"
-                + getQualifiedName() + "' started an unexpected interface '"
-                + aDescriptor
-                + "' that was not registerd as a provided interface before");
+            throw new SystemAssemblyException("Component '" +
+                getQualifiedName() + "' started an unexpected interface '" +
+                aDescriptor +
+                "' that was not registerd as a provided interface before");
         }
 
         aScope.publishInterface(aDescriptor, aService);
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aRuntime DOCUMENT ME!
-     */
     @Override
     public void stop(Type aRuntime) {
         LOG.info("Stopping initiated '" + getQualifiedName() + "'");
@@ -288,30 +210,13 @@ public abstract class AbstractComponent<Type> implements Component<Type> {
         LOG.info("Stopping completed '" + getQualifiedName() + "'");
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aRuntime DOCUMENT ME!
-     */
     protected abstract void doStop(Type aRuntime);
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     @Override
     public String toString() {
         return getQualifiedName();
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aName DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     public ProvidedInterface findProvidedInterface(String aName) {
         for (ProvidedInterface provided : getProvidedInterfaces()) {
             if (provided.getName().equals(aName)) {
@@ -322,13 +227,6 @@ public abstract class AbstractComponent<Type> implements Component<Type> {
         return null;
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aName DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
     public RequiredInterface findRequiredInterface(String aName) {
         for (RequiredInterface required : getRequiredInterfaces()) {
             if (required.getName().equals(aName)) {