1 package org.apache.maven.shared.transfer.collection;
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.model.Dependency;
23 import org.apache.maven.model.Model;
24 import org.apache.maven.project.ProjectBuildingRequest;
25 import org.apache.maven.shared.transfer.dependencies.DependableCoordinate;
26
27 /**
28 * Will only download the pom files when not available, never the artifact.
29 *
30 * @author Robert Scholte
31 *
32 */
33 public interface DependencyCollector
34 {
35
36 /**
37 * Collects the transitive dependencies of some artifacts and builds a dependency graph. Note that this operation is
38 * only concerned about determining the coordinates of the transitive dependencies and does not actually resolve the
39 * artifact files. The supplied session carries various hooks to customize the dependency graph that must be invoked
40 * throughout the operation.
41 *
42 * @param buildingRequest The Maven project buildingrequest, must not be {@code null}.
43 * @param root The Maven Dependency, must not be {@code null}.
44 * @return The collection result, never {@code null}.
45 * @throws DependencyCollectionException If the dependency tree could not be built.
46 */
47 CollectResult collectDependencies( ProjectBuildingRequest buildingRequest, Dependency root )
48 throws DependencyCollectionException;
49
50 /**
51 * Collects the transitive dependencies of some artifacts and builds a dependency graph. Note that this operation is
52 * only concerned about determining the coordinates of the transitive dependencies and does not actually resolve the
53 * artifact files. The supplied session carries various hooks to customize the dependency graph that must be invoked
54 * throughout the operation.
55 *
56 * @param buildingRequest The Maven project buildingrequest, must not be {@code null}.
57 * @param root The Maven DependableCoordinate, must not be {@code null}.
58 * @return The collection result, never {@code null}.
59 * @throws DependencyCollectionException If the dependency tree could not be built.
60 */
61 CollectResult collectDependencies( ProjectBuildingRequest buildingRequest, DependableCoordinate root )
62 throws DependencyCollectionException;
63
64 /**
65 * Collects the transitive dependencies of some artifacts and builds a dependency graph. Note that this operation is
66 * only concerned about determining the coordinates of the transitive dependencies and does not actually resolve the
67 * artifact files. The supplied session carries various hooks to customize the dependency graph that must be invoked
68 * throughout the operation.
69 *
70 * @param buildingRequest The Maven project buildingrequest, must not be {@code null}.
71 * @param root The Maven model, must not be {@code null}.
72 * @return The collection result, never {@code null}.
73 * @throws DependencyCollectionException If the dependency tree could not be built.
74 */
75 CollectResult collectDependencies( ProjectBuildingRequest buildingRequest, Model root )
76 throws DependencyCollectionException;
77
78 }