1 package org.apache.maven.shared.transfer.dependencies.collect;
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 * A dependency may have excludes
38 *
39 * @param buildingRequest {@link ProjectBuildingRequest}
40 * @param root {@link Dependency}
41 * @return {@link CollectorResult}
42 * @throws DependencyCollectorException in case of an error.
43 * @throws IllegalArgumentException in case of parameter <code>buildingRequest</code> is <code>null</code> or
44 * parameter <code>root</code> is <code>null</code>.
45 */
46 CollectorResult collectDependencies( ProjectBuildingRequest buildingRequest, Dependency root )
47 throws DependencyCollectorException;
48
49 /**
50 * @param buildingRequest {@link ProjectBuildingRequest}.
51 * @param root {@link DependableCoordinate}
52 * @return {@link CollectorResult}
53 * @throws DependencyCollectorException in case of an error which can be a component lookup error or
54 * an error while trying to look up the dependencies.
55 * @throws IllegalArgumentException in case of parameter <code>buildingRequest</code> is <code>null</code> or
56 * parameter <code>root</code> is <code>null</code>.
57 */
58 CollectorResult collectDependencies( ProjectBuildingRequest buildingRequest, DependableCoordinate root )
59 throws DependencyCollectorException;
60
61 /**
62 * @param buildingRequest {@link ProjectBuildingRequest}.
63 * @param root {@link Model}
64 * @return {@link CollectorResult}
65 * @throws DependencyCollectorException in case of an error which can be a component lookup error or
66 * an error while trying to look up the dependencies.
67 * @throws IllegalArgumentException in case of parameter <code>buildingRequest</code> is <code>null</code> or
68 * parameter <code>root</code> is <code>null</code>.
69 */
70 CollectorResult collectDependencies( ProjectBuildingRequest buildingRequest, Model root )
71 throws DependencyCollectorException;
72
73 }