(no commit message)
[utils] / system / general / src / main / java / org / wamblee / system / graph / component / CheckRequiredProvidedMultiplicityVisitor.java
index 86c13ca39f738b0cc160c7f01bbcb06b2a785b34..ae14ead872ea65d6f662819a43afa0efbe12f4be 100644 (file)
@@ -1,12 +1,12 @@
 /*
- * Copyright 2008 the original author or authors.
- *
+ * Copyright 2005-2010 the original author or authors.
+ * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- *
+ * 
  *      http://www.apache.org/licenses/LICENSE-2.0
- *
+ * 
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -23,92 +23,72 @@ import org.wamblee.system.graph.Visitor;
 
 import java.util.List;
 
-
 /**
  * Visitor that checks whether required and provided interfaces are matched
  * appropriately:
- *  <ul>
- *      <li>Each required interface is connected to at most one
- *      provided interface</li>
- *      <li>Required interfaces that are not optional must be connected
- *      to precisely one provided interface</li>
- *  </ul>
- *
+ * <ul>
+ * <li>Each required interface is connected to at most one provided interface</li>
+ * <li>Required interfaces that are not optional must be connected to precisely
+ * one provided interface</li>
+ * </ul>
+ * 
  * @author Erik Brakkee
  */
 public class CheckRequiredProvidedMultiplicityVisitor implements Visitor {
-    /**
-     * DOCUMENT ME!
-     */
     private Graph graph;
 
     /**
      * Creates a new CheckRequiredProvidedMultiplicityVisitor object.
-     *
-     * @param aGraph DOCUMENT ME!
+     * 
      */
     public CheckRequiredProvidedMultiplicityVisitor(Graph aGraph) {
         graph = aGraph;
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aEdge DOCUMENT ME!
-     */
     @Override
     public void visitEdge(Edge aEdge) {
         // Empty
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aNode DOCUMENT ME!
-     */
     @Override
     public void visitNode(Node aNode) {
         if (aNode instanceof RequiredInterfaceNode) {
             RequiredInterfaceNode required = (RequiredInterfaceNode) aNode;
-            List<Edge>            edges    = graph.findOutgoing(aNode);
+            List<Edge> edges = graph.findOutgoing(aNode);
 
             if (edges.size() > 1) {
-                createDuplicateException("Multiple providers of required interface found",
-                    aNode, edges);
+                createDuplicateException(
+                    "Multiple providers of required interface found", aNode,
+                    edges);
             }
 
             if ((edges.size() == 0) && !required.getRequired().isOptional()) {
-                throw new SystemAssemblyException(aNode
-                    + ": mandatpory required interface not provided by other components started earlier");
+                throw new SystemAssemblyException(
+                    aNode +
+                        ": mandatpory required interface not provided by other components started earlier");
             }
         } else if (aNode instanceof ExternalProvidedInterfaceNode) {
             List<Edge> edges = graph.findOutgoing(aNode);
 
             if (edges.size() > 1) {
-                createDuplicateException("multiple internal matches for externally provided interface",
+                createDuplicateException(
+                    "multiple internal matches for externally provided interface",
                     aNode, edges);
             }
 
             if (edges.size() == 0) {
-                throw new SystemAssemblyException(aNode
-                    ": external provided interface is not provided internally");
+                throw new SystemAssemblyException(aNode +
+                    ": external provided interface is not provided internally");
             }
         }
     }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param aMsg DOCUMENT ME!
-     * @param aNode DOCUMENT ME!
-     * @param edges DOCUMENT ME!
-     */
     private void createDuplicateException(String aMsg, Node aNode,
-        List<Edge> edges) {
+        List<Edge> aEdges) {
         StringBuffer buf = new StringBuffer();
         buf.append(aNode + ": " + aMsg + ": ");
 
-        for (Edge edge : edges) {
+        for (Edge edge : aEdges) {
             buf.append(edge.getTo() + "/ ");
         }