source code formatting.
[utils] / system / general / src / main / java / org / wamblee / system / graph / component / CheckStartupDependenciesVisitor.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 org.wamblee.system.core.SystemAssemblyException;
19 import org.wamblee.system.graph.Edge;
20 import org.wamblee.system.graph.Graph;
21 import org.wamblee.system.graph.Node;
22 import org.wamblee.system.graph.Visitor;
23
24 import java.util.ArrayList;
25 import java.util.List;
26
27
28 /**
29  * Checks whether the given component graph can be started in component
30  * order without any missing dependencies.
31  *
32  * @author Erik Brakkee
33  */
34 public class CheckStartupDependenciesVisitor implements Visitor {
35     /**
36      * DOCUMENT ME!
37      */
38     private Graph graph;
39
40     /**
41      * DOCUMENT ME!
42      */
43     private List<Node> available;
44
45 /**
46      * Constructs the visitor. 
47      * @param aGraph Graph. 
48      */
49     public CheckStartupDependenciesVisitor(Graph aGraph) {
50         graph         = aGraph;
51         available     = new ArrayList<Node>();
52     }
53
54     /**
55      * DOCUMENT ME!
56      *
57      * @param aEdge DOCUMENT ME!
58      */
59     @Override
60     public void visitEdge(Edge aEdge) {
61         // Empty
62     }
63
64     /**
65      * DOCUMENT ME!
66      *
67      * @param aNode DOCUMENT ME!
68      */
69     @Override
70     public void visitNode(Node aNode) {
71         List<Edge> edges = graph.findOutgoing(aNode);
72
73         // check dependencies.
74         for (Edge edge : edges) {
75             Node dep = edge.getTo();
76
77             if (!available.contains(dep)) {
78                 throw new SystemAssemblyException(aNode
79                     + ": required dependency '" + dep + "' was not started");
80             }
81         }
82
83         available.add(aNode);
84     }
85 }