View Javadoc

1   package org.apache.maven.shared.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 java.util.ArrayList;
23  import java.util.Collection;
24  import java.util.Iterator;
25  import java.util.List;
26  
27  import org.apache.maven.artifact.Artifact;
28  
29  /**
30   * Represents a Maven project's dependency tree.
31   * 
32   * @author <a href="mailto:markhobson@gmail.com">Mark Hobson</a>
33   * @version $Id: DependencyTree.java 1100703 2011-05-08 08:27:33Z hboutemy $
34   * @deprecated As of 1.1, replaced by the dependency tree root {@link DependencyNode}
35   */
36  public class DependencyTree
37  {
38      // fields -----------------------------------------------------------------
39  
40      private final DependencyNode rootNode;
41  
42      private final Collection<DependencyNode> nodes;
43  
44      // constructors -----------------------------------------------------------
45  
46      /**
47       * Create a tree initialized to the arguments
48       * 
49       * @param rootNode
50       * @param nodes
51       */
52      public DependencyTree( DependencyNode rootNode, Collection<DependencyNode> nodes )
53      {
54          this.rootNode = rootNode;
55          this.nodes = nodes;
56      }
57  
58      // public methods ---------------------------------------------------------
59  
60      public DependencyNode getRootNode()
61      {
62          return rootNode;
63      }
64  
65      public Collection<DependencyNode> getNodes()
66      {
67          return nodes;
68      }
69  
70      public List<Artifact> getArtifacts()
71      {
72          List<Artifact> artifacts = new ArrayList<Artifact>();
73  
74          for ( DependencyNode node : getNodes() )
75          {
76              artifacts.add( node.getArtifact() );
77          }
78  
79          return artifacts;
80      }
81  
82      public String toString()
83      {
84          return getRootNode().toString();
85      }
86  
87      /**
88       * @see DependencyNode#iterator()
89       */
90      public Iterator<DependencyNode> iterator()
91      {
92          return getRootNode().iterator();
93      }
94  
95      /**
96       * @see DependencyNode#preorderIterator()
97       */
98      public Iterator<DependencyNode> preorderIterator()
99      {
100         return getRootNode().preorderIterator();
101     }
102 
103     /**
104      * @see DependencyNode#inverseIterator()
105      */
106     public Iterator<DependencyNode> inverseIterator()
107     {
108         return getRootNode().inverseIterator();
109     }
110 }