001package org.eclipse.aether.impl;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 * 
012 *  http://www.apache.org/licenses/LICENSE-2.0
013 * 
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.eclipse.aether.RepositorySystem;
023import org.eclipse.aether.RepositorySystemSession;
024import org.eclipse.aether.collection.CollectRequest;
025import org.eclipse.aether.collection.CollectResult;
026import org.eclipse.aether.collection.DependencyCollectionException;
027
028/**
029 * Given a collection of direct dependencies, recursively gathers their transitive dependencies and calculates the
030 * dependency graph.
031 * 
032 * @noimplement This interface is not intended to be implemented by clients.
033 * @noextend This interface is not intended to be extended by clients.
034 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
035 */
036public interface DependencyCollector
037{
038
039    /**
040     * Collects the transitive dependencies of some artifacts and builds a dependency graph. Note that this operation is
041     * only concerned about determining the coordinates of the transitive dependencies and does not actually resolve the
042     * artifact files. The supplied session carries various hooks to customize the dependency graph that must be invoked
043     * throughout the operation.
044     * 
045     * @param session The repository session, must not be {@code null}.
046     * @param request The collection request, must not be {@code null}.
047     * @return The collection result, never {@code null}.
048     * @throws DependencyCollectionException If the dependency tree could not be built.
049     * @see RepositorySystemSession#getDependencyTraverser()
050     * @see RepositorySystemSession#getDependencyManager()
051     * @see RepositorySystemSession#getDependencySelector()
052     * @see RepositorySystemSession#getVersionFilter()
053     * @see RepositorySystemSession#getDependencyGraphTransformer()
054     * @see RepositorySystem#collectDependencies(RepositorySystemSession, CollectRequest)
055     */
056    CollectResult collectDependencies( RepositorySystemSession session, CollectRequest request )
057        throws DependencyCollectionException;
058
059}