View Javadoc

1   package org.apache.maven.plugin.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
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
36      extends AbstractSerializingVisitor
37      implements DependencyNodeVisitor
38  {
39  
40      /**
41       * Constructor.
42       *
43       * @param writer the writer to write to.
44       */
45      public DOTDependencyNodeVisitor( Writer writer )
46      {
47          super( writer );
48      }
49  
50  
51      /**
52       * {@inheritDoc}
53       */
54      public boolean visit( DependencyNode node )
55      {
56          if ( node.getParent() == null || node.getParent() == node )
57          {
58              writer.write( "digraph \"" + node.toNodeString() + "\" { \n" );
59          }
60  
61          // Generate "currentNode -> Child" lines
62  
63          List<DependencyNode> children = node.getChildren();
64  
65          for ( DependencyNode child : children )
66          {
67              StringBuilder sb = new StringBuilder();
68              sb.append( "\t\"" );
69              sb.append( node.toNodeString() );
70              sb.append( "\" -> \"" );
71              sb.append( child.toNodeString() );
72              sb.append( "\" ; " );
73              writer.println( sb.toString() );
74          }
75  
76          return true;
77      }
78  
79      /**
80       * {@inheritDoc}
81       */
82      public boolean endVisit( DependencyNode node )
83      {
84          if ( node.getParent() == null || node.getParent() == node )
85          {
86              writer.write( " } " );
87          }
88          return true;
89      }
90  
91  }