1 package org.apache.maven.plugin.dependency.treeSerializers;
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.tree.traversal.DependencyNodeVisitor;
23 import org.apache.maven.shared.dependency.tree.DependencyNode;
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
30 * http://en.wikipedia.org/wiki/DOT_language
31 *
32 * @author <a href="mailto:pi.songs@gmail.com">Pi Song</a>
33 * @since 2.1
34 */
35 public class DOTDependencyNodeVisitor extends AbstractSerializingVisitor
36 implements DependencyNodeVisitor {
37
38 /**
39 * Constructor.
40 *
41 * @param writer the writer to write to.
42 */
43 public DOTDependencyNodeVisitor( Writer writer)
44 {
45 super( writer );
46 }
47
48
49 /**
50 * {@inheritDoc}
51 */
52 public boolean visit( DependencyNode node )
53 {
54 if ( node.getParent() == null || node.getParent() == node )
55 {
56 writer.write( "digraph \"" + node.toNodeString() + "\" { \n" );
57 }
58
59 // Generate "currentNode -> Child" lines
60
61 List<DependencyNode> children = node.getChildren();
62
63 for ( DependencyNode child : children )
64 {
65 StringBuffer sb = new StringBuffer();
66 sb.append( "\t\"" );
67 sb.append( node.toNodeString() );
68 sb.append( "\" -> \"" );
69 sb.append( child.toNodeString() );
70 sb.append( "\" ; " );
71 writer.println( sb.toString() );
72 }
73
74 return true;
75 }
76
77 /**
78 * {@inheritDoc}
79 */
80 public boolean endVisit( DependencyNode node )
81 {
82 if ( node.getParent() == null || node.getParent() == node )
83 {
84 writer.write( " } " );
85 }
86 return true;
87 }
88
89 }