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 import java.util.List;
23
24 /**
25 * A filter to include/exclude dependency nodes during other operations.
26 */
27 public interface DependencyFilter
28 {
29
30 /**
31 * Indicates whether the specified dependency node shall be included or excluded.
32 *
33 * @param node The dependency node to filter, must not be {@code null}.
34 * @param parents The (read-only) chain of parent nodes that leads to the node to be filtered, must not be
35 * {@code null}. Iterating this (possibly empty) list walks up the dependency graph towards the root
36 * node, i.e. the immediate parent node (if any) is the first node in the list. The size of the list also
37 * denotes the zero-based depth of the filtered node.
38 * @return {@code true} to include the dependency node, {@code false} to exclude it.
39 */
40 boolean accept( DependencyNode node, List<DependencyNode> parents );
41
42 }