View Javadoc

1   package org.apache.maven.project;
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.eclipse.aether.graph.Dependency;
25  import org.eclipse.aether.graph.DependencyNode;
26  
27  /**
28   * The result of a project dependency resolution.
29   * 
30   * @author Benjamin Bentmann
31   */
32  public interface DependencyResolutionResult
33  {
34  
35      /**
36       * Gets the dependency graph of the project.
37       * 
38       * @return The dependency graph or {@code null} if not available.
39       */
40      DependencyNode getDependencyGraph();
41  
42      /**
43       * Gets the transitive dependencies of the project that were not excluded by
44       * {@link DependencyResolutionRequest#getResolutionFilter()}. This list is a union of the results from
45       * {@link #getResolvedDependencies()} and {@link #getUnresolvedDependencies()}.
46       * 
47       * @return The transitive dependencies, never {@code null}.
48       */
49      List<Dependency> getDependencies();
50  
51      /**
52       * Gets the dependencies that were successfully resolved.
53       * 
54       * @return The resolved dependencies, never {@code null}.
55       */
56      List<Dependency> getResolvedDependencies();
57  
58      /**
59       * Gets the dependencies that could not be resolved.
60       * 
61       * @return The unresolved dependencies, never {@code null}.
62       */
63      List<Dependency> getUnresolvedDependencies();
64  
65      /**
66       * Gets the errors that occurred while building the dependency graph.
67       * 
68       * @return The errors that occurred while building the dependency graph, never {@code null}.
69       */
70      List<Exception> getCollectionErrors();
71  
72      /**
73       * Gets the errors that occurred while resolving the specified dependency.
74       * 
75       * @param dependency The dependency for which to retrieve the errors, must not be {@code null}.
76       * @return The resolution errors for the specified dependency, never {@code null}.
77       */
78      List<Exception> getResolutionErrors( Dependency dependency );
79  
80  }