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.shared.dependency.graph.traversal;
20
21 import java.util.ArrayList;
22 import java.util.Collections;
23 import java.util.List;
24
25 import org.apache.maven.shared.dependency.graph.DependencyNode;
26
27 /**
28 * A dependency node visitor that collects visited nodes for further processing.
29 *
30 * @author <a href="mailto:markhobson@gmail.com">Mark Hobson</a>
31 * @version $Id$
32 * @since 1.1
33 */
34 public class CollectingDependencyNodeVisitor implements DependencyNodeVisitor {
35 // fields -----------------------------------------------------------------
36
37 /**
38 * The collected list of nodes.
39 */
40 private final List<DependencyNode> nodes;
41
42 // constructors -----------------------------------------------------------
43
44 /**
45 * Creates a dependency node visitor that collects visited nodes for further processing.
46 */
47 public CollectingDependencyNodeVisitor() {
48 nodes = new ArrayList<>();
49 }
50
51 // DependencyNodeVisitor methods ------------------------------------------
52
53 /**
54 * {@inheritDoc}
55 */
56 @Override
57 public boolean visit(DependencyNode node) {
58 // collect node
59 nodes.add(node);
60
61 return true;
62 }
63
64 /**
65 * {@inheritDoc}
66 */
67 @Override
68 public boolean endVisit(DependencyNode node) {
69 return true;
70 }
71
72 // public methods ---------------------------------------------------------
73
74 /**
75 * Gets the list of collected dependency nodes.
76 *
77 * @return the list of collected dependency nodes
78 */
79 public List<DependencyNode> getNodes() {
80 return Collections.unmodifiableList(nodes);
81 }
82 }