1 package org.apache.maven.api; 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 import org.apache.maven.api.annotations.Consumer; 24 import org.apache.maven.api.annotations.Experimental; 25 import org.apache.maven.api.annotations.Nonnull; 26 27 /** 28 * Defines a hierarchical visitor for collecting dependency node trees. 29 * 30 * @since 4.0 31 */ 32 @Experimental 33 @Consumer 34 public interface NodeVisitor 35 { 36 /** 37 * Starts the visit to the specified dependency node. 38 * 39 * @param node the dependency node to visit 40 * @return <code>true</code> to visit the specified dependency node's children, <code>false</code> to skip the 41 * specified dependency node's children and proceed to its next sibling 42 */ 43 boolean enter( @Nonnull Node node ); 44 45 /** 46 * Ends the visit to the specified dependency node. 47 * 48 * @param node the dependency node to visit 49 * @return <code>true</code> to visit the specified dependency node's next sibling, <code>false</code> to skip the 50 * specified dependency node's next siblings and proceed to its parent 51 */ 52 boolean leave( @Nonnull Node node ); 53 }