1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.plugins.dependency.tree;
20
21 import java.io.Writer;
22 import java.util.List;
23 import org.apache.maven.shared.dependency.graph.DependencyNode;
24 import org.apache.maven.shared.dependency.graph.traversal.DependencyNodeVisitor;
25
26 /**
27 * A dependency node visitor that serializes visited nodes to <a href="https://en.wikipedia.org/wiki/DOT_language">DOT
28 * format</a>
29 *
30 * @author <a href="mailto:pi.songs@gmail.com">Pi Song</a>
31 * @since 2.1
32 */
33 public class DOTDependencyNodeVisitor extends AbstractSerializingVisitor implements DependencyNodeVisitor {
34
35 /**
36 * Constructor.
37 *
38 * @param writer the writer to write to.
39 */
40 public DOTDependencyNodeVisitor(Writer writer) {
41 super(writer);
42 }
43
44 /**
45 * {@inheritDoc}
46 */
47 @Override
48 public boolean visit(DependencyNode node) {
49 if (node.getParent() == null || node.getParent() == node) {
50 writer.write("digraph \"" + node.toNodeString() + "\" { " + System.lineSeparator());
51 }
52
53 // Generate "currentNode -> Child" lines
54
55 List<DependencyNode> children = node.getChildren();
56
57 for (DependencyNode child : children) {
58 writer.println("\t\"" + node.toNodeString() + "\" -> \"" + child.toNodeString() + "\" ; ");
59 }
60
61 return true;
62 }
63
64 /**
65 * {@inheritDoc}
66 */
67 @Override
68 public boolean endVisit(DependencyNode node) {
69 if (node.getParent() == null || node.getParent() == node) {
70 writer.write(" } ");
71 }
72 return true;
73 }
74 }