wamblee.org Git - utils/blob - system/general/src/main/java/org/wamblee/system/graph/component/CheckExternallyProvidedVisitor.java

   1 /*
   2  * Copyright 2008 the original author or authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.wamblee.system.graph.component;
  17
  18 import java.util.List;
  19
  20 import org.wamblee.system.core.SystemAssemblyException;
  21 import org.wamblee.system.graph.Edge;
  22 import org.wamblee.system.graph.Graph;
  23 import org.wamblee.system.graph.Node;
  24 import org.wamblee.system.graph.Visitor;
  25
  26 /**
  27  * Visitor that checks whether all externally provided interfaces are actually provided
  28  * by any of the internal components.
  29  *
  30  * @author Erik Brakkee
  31  *
  32  */
  33 public class CheckExternallyProvidedVisitor implements Visitor {
  34
  35     private Graph graph;
  36
  37     /**
  38      * Constructs the visitor.
  39      * @param aGraph Component graph.
  40      */
  41     public CheckExternallyProvidedVisitor(Graph aGraph) {
  42         graph = aGraph;
  43     }
  44
  45     @Override
  46     public void visitEdge(Edge aEdge) {
  47         // Empty.
  48     }
  49
  50     @Override
  51     public void visitNode(Node aNode) {
  52         if ( aNode instanceof ExternalProvidedInterfaceNode) {
  53             ExternalProvidedInterfaceNode provided = (ExternalProvidedInterfaceNode) aNode;
  54             List<Edge> edges = graph.findOutgoing(provided);
  55             if ( edges.size() > 2 ) {
  56                 createDuplicateException("External provided interfaces has multiple internal matches", aNode, edges);
  57             }
  58             if ( edges.size() == 0 ) {
  59                 throw new SystemAssemblyException(aNode + ": external provded interface is not provided by any of the internal components");
  60             }
  61         }
  62     }
  63
  64     private void createDuplicateException(String aMsg, Node aNode, List<Edge> edges) {
  65         StringBuffer buf = new StringBuffer();
  66         buf.append(aNode
  67                 + ": " + aMsg + ": ");
  68         for (Edge edge : edges) {
  69             buf.append(edge.getTo() + "/ ");
  70         }
  71         throw new SystemAssemblyException(buf.toString());
  72     }
  73
  74 }