View Javadoc
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 java.util.List;
23  
24  import org.apache.maven.shared.transfer.graph.DependencyNode;
25  
26  /**
27   * The result of a dependency collection request.
28   *
29   * @see DependencyCollector#collectDependencies(org.apache.maven.project.ProjectBuildingRequest, org.apache.maven.model.Dependency)
30   * @see DependencyCollector#collectDependencies(org.apache.maven.project.ProjectBuildingRequest, org.apache.maven.shared.transfer.dependencies.DependableCoordinate)
31   * @see DependencyCollector#collectDependencies(org.apache.maven.project.ProjectBuildingRequest, org.apache.maven.model.Model)
32   */
33  public interface CollectResult
34  {
35    /**
36     * Gets the exceptions that occurred while building the dependency graph.
37     *
38     * @return The exceptions that occurred, never {@code null}.
39     */
40    List<Exception> getExceptions();
41  
42    /**
43     * Gets the root node of the dependency graph.
44     *
45     * @return The root node of the dependency graph or {@code null} if none.
46     */
47    DependencyNode getRoot();
48  
49  }