1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.api.services;
20
21 import java.util.List;
22
23 import org.apache.maven.api.Node;
24 import org.apache.maven.api.annotations.Experimental;
25 import org.apache.maven.api.annotations.Nonnull;
26 import org.apache.maven.api.annotations.Nullable;
27
28 /**
29 * The result of a dependency collection request.
30 *
31 * @since 4.0.0
32 * @see DependencyCollector#collect(DependencyCollectorRequest)
33 */
34 @Experimental
35 public interface DependencyCollectorResult {
36 /**
37 * Gets the exceptions that occurred while building the dependency graph.
38 *
39 * @return the exceptions that occurred, never {@code null}
40 */
41 @Nonnull
42 List<Exception> getExceptions();
43
44 /**
45 * Gets the root node of the dependency graph.
46 *
47 * @return the root node of the dependency graph or {@code null} if none
48 */
49 @Nullable
50 Node getRoot();
51 }