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