001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.graph;
020
021import java.util.List;
022
023/**
024 * A filter to include/exclude dependency nodes during other operations.
025 */
026public interface DependencyFilter {
027
028    /**
029     * Indicates whether the specified dependency node shall be included or excluded.
030     *
031     * @param node The dependency node to filter, must not be {@code null}.
032     * @param parents The (read-only) chain of parent nodes that leads to the node to be filtered, must not be
033     *            {@code null}. Iterating this (possibly empty) list walks up the dependency graph towards the root
034     *            node, i.e. the immediate parent node (if any) is the first node in the list. The size of the list also
035     *            denotes the zero-based depth of the filtered node.
036     * @return {@code true} to include the dependency node, {@code false} to exclude it.
037     */
038    boolean accept(DependencyNode node, List<DependencyNode> parents);
039}