1 package org.eclipse.aether.impl;
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.eclipse.aether.RepositorySystem;
23 import org.eclipse.aether.RepositorySystemSession;
24 import org.eclipse.aether.collection.CollectRequest;
25 import org.eclipse.aether.collection.CollectResult;
26 import org.eclipse.aether.collection.DependencyCollectionException;
27
28 /**
29 * Given a collection of direct dependencies, recursively gathers their transitive dependencies and calculates the
30 * dependency graph.
31 *
32 * @noimplement This interface is not intended to be implemented by clients.
33 * @noextend This interface is not intended to be extended by clients.
34 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
35 */
36 public interface DependencyCollector
37 {
38
39 /**
40 * Collects the transitive dependencies of some artifacts and builds a dependency graph. Note that this operation is
41 * only concerned about determining the coordinates of the transitive dependencies and does not actually resolve the
42 * artifact files. The supplied session carries various hooks to customize the dependency graph that must be invoked
43 * throughout the operation.
44 *
45 * @param session The repository session, must not be {@code null}.
46 * @param request The collection request, must not be {@code null}.
47 * @return The collection result, never {@code null}.
48 * @throws DependencyCollectionException If the dependency tree could not be built.
49 * @see RepositorySystemSession#getDependencyTraverser()
50 * @see RepositorySystemSession#getDependencyManager()
51 * @see RepositorySystemSession#getDependencySelector()
52 * @see RepositorySystemSession#getVersionFilter()
53 * @see RepositorySystemSession#getDependencyGraphTransformer()
54 * @see RepositorySystem#collectDependencies(RepositorySystemSession, CollectRequest)
55 */
56 CollectResult collectDependencies( RepositorySystemSession session, CollectRequest request )
57 throws DependencyCollectionException;
58
59 }