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.apache.maven.shared.dependency.graph;
20
21 import java.util.Collection;
22
23 import org.apache.maven.artifact.resolver.filter.ArtifactFilter;
24 import org.apache.maven.project.MavenProject;
25 import org.apache.maven.project.ProjectBuildingRequest;
26
27 /**
28 * Maven project dependency graph builder API, neutral against Maven 2 or Maven 3.
29 *
30 * @author Hervé Boutemy
31 * @since 2.0
32 */
33 public interface DependencyGraphBuilder {
34 /**
35 * Build the dependency graph.
36 *
37 * @param buildingRequest the buildingRequest
38 * @param filter artifact filter (can be <code>null</code>)
39 * @return the dependency graph
40 * @throws DependencyGraphBuilderException if some of the dependencies could not be resolved.
41 */
42 DependencyNode buildDependencyGraph(ProjectBuildingRequest buildingRequest, ArtifactFilter filter)
43 throws DependencyGraphBuilderException;
44
45 /**
46 *
47 * @param buildingRequest the buildingRequest
48 * @param filter artifact filter (can be <code>null</code>)
49 * @param reactorProjects ignored
50 * @return the dependency graph
51 * @throws DependencyGraphBuilderException if some of the dependencies could not be resolved.
52 * @deprecated Use {@link #buildDependencyGraph(ProjectBuildingRequest, ArtifactFilter)} instead
53 */
54 @Deprecated
55 default DependencyNode buildDependencyGraph(
56 ProjectBuildingRequest buildingRequest, ArtifactFilter filter, Collection<MavenProject> reactorProjects)
57 throws DependencyGraphBuilderException {
58 return buildDependencyGraph(buildingRequest, filter);
59 }
60 }