View Javadoc
1   package org.eclipse.aether.graph;
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  /**
23   * A visitor for nodes of the dependency graph.
24   * 
25   * @see DependencyNode#accept(DependencyVisitor)
26   */
27  public interface DependencyVisitor
28  {
29  
30      /**
31       * Notifies the visitor of a node visit before its children have been processed.
32       * 
33       * @param node The dependency node being visited, must not be {@code null}.
34       * @return {@code true} to visit child nodes of the specified node as well, {@code false} to skip children.
35       */
36      boolean visitEnter( DependencyNode node );
37  
38      /**
39       * Notifies the visitor of a node visit after its children have been processed. Note that this method is always
40       * invoked regardless whether any children have actually been visited.
41       * 
42       * @param node The dependency node being visited, must not be {@code null}.
43       * @return {@code true} to visit siblings nodes of the specified node as well, {@code false} to skip siblings.
44       */
45      boolean visitLeave( DependencyNode node );
46  
47  }