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