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 org.apache.maven.shared.dependency.graph.DependencyNode;
22
23 /**
24 * Defines a hierarchical visitor for processing dependency node trees.
25 *
26 * @author <a href="mailto:markhobson@gmail.com">Mark Hobson</a>
27 * @version $Id$
28 * @since 1.1
29 */
30 public interface DependencyNodeVisitor {
31 /**
32 * Starts the visit to the specified dependency node.
33 *
34 * @param node the dependency node to visit
35 * @return <code>true</code> to visit the specified dependency node's children, <code>false</code> to skip the
36 * specified dependency node's children and proceed to its next sibling
37 */
38 boolean visit(DependencyNode node);
39
40 /**
41 * Ends the visit to to the specified dependency node.
42 *
43 * @param node the dependency node to visit
44 * @return <code>true</code> to visit the specified dependency node's next sibling, <code>false</code> to skip the
45 * specified dependency node's next siblings and proceed to its parent
46 */
47 boolean endVisit(DependencyNode node);
48 }