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