1 package org.apache.maven.shared.dependency.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 org.apache.maven.artifact.resolver.filter.ArtifactFilter;
23 import org.apache.maven.project.ProjectBuildingRequest;
24
25 /**
26 * Maven project dependency raw dependency collector API, providing an abstraction layer against Maven 3 and Maven 3.1+
27 * particular Aether implementations.
28 *
29 * @author Gabriel Belingueres
30 * @since 3.1.0
31 */
32 public interface DependencyCollectorBuilder
33 {
34
35 /**
36 * collect the project's raw dependency graph, with information to allow the API client to reason on its own about
37 * dependencies.
38 *
39 * @param buildingRequest the request with the project to process its dependencies.
40 * @param filter an artifact filter if not all dependencies are required (can be <code>null</code>)
41 * @return the raw dependency tree
42 * @throws DependencyCollectorBuilderException if some of the dependencies could not be collected.
43 */
44 default DependencyNode collectDependencyGraph( ProjectBuildingRequest buildingRequest, ArtifactFilter filter )
45 throws DependencyCollectorBuilderException
46 {
47 return collectDependencyGraph( new DependencyCollectorRequest( buildingRequest, filter ) );
48 }
49
50 /**
51 * collect the project's raw dependency graph, with information to allow the API client to reason on its own about
52 * dependencies.
53 *
54 * @param dependencyCollectorRequest the request with different paramaters.
55 * @return the raw dependency tree
56 * @throws DependencyCollectorBuilderException if some of the dependencies could not be collected.
57 * @since 3.2.1
58 */
59 DependencyNode collectDependencyGraph( DependencyCollectorRequest dependencyCollectorRequest )
60 throws DependencyCollectorBuilderException;
61
62 }