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